Class CreateMeetingRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.chimesdkmeetings.model.ChimeSdkMeetingsRequest
software.amazon.awssdk.services.chimesdkmeetings.model.CreateMeetingRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateMeetingRequest.Builder,CreateMeetingRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateMeetingRequest extends ChimeSdkMeetingsRequest implements ToCopyableBuilder<CreateMeetingRequest.Builder,CreateMeetingRequest>

  • Method Details

    • clientRequestToken

      public final String clientRequestToken()

      The unique identifier for the client request. Use a different token for different meetings.

      Returns:
      The unique identifier for the client request. Use a different token for different meetings.

    • mediaRegion

      public final String mediaRegion()

      The Region in which to create the meeting.

      Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

      Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

      Returns:
      The Region in which to create the meeting.

      Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

      Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

    • meetingHostId

      public final String meetingHostId()

      Reserved.

      Returns:
      Reserved.

    • externalMeetingId

      public final String externalMeetingId()

      The external meeting ID.

      Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

      Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

      Returns:
      The external meeting ID.

      Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

      Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

    • notificationsConfiguration

      public final NotificationsConfiguration notificationsConfiguration()

      The configuration for resource targets to receive notifications when meeting and attendee events occur.

      Returns:
      The configuration for resource targets to receive notifications when meeting and attendee events occur.

    • meetingFeatures

      public final MeetingFeaturesConfiguration meetingFeatures()

      Lists the audio and video features enabled for a meeting, such as echo reduction.

      Returns:
      Lists the audio and video features enabled for a meeting, such as echo reduction.

    • primaryMeetingId

      public final String primaryMeetingId()

      When specified, replicates the media from the primary meeting to the new meeting.

      Returns:
      When specified, replicates the media from the primary meeting to the new meeting.

    • hasTenantIds

      public final boolean hasTenantIds()
      For responses, this returns true if the service returned a value for the TenantIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tenantIds

      public final List<String> tenantIds()

      A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTenantIds() method.

      Returns:
      A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Applies one or more tags to an Amazon Chime SDK meeting. Note the following:

      • Not all resources have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.

      • Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.

      • You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.

      • To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.

      Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

      Minimum permissions

      In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag a ChimeSDKMeetings instance using the TagResources operation, you must have both of the following permissions:

      tag:TagResources

      ChimeSDKMeetings:CreateTags

      Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Applies one or more tags to an Amazon Chime SDK meeting. Note the following:

      • Not all resources have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.

      • Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.

      • You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.

      • To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.

      Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

      Minimum permissions

      In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag a ChimeSDKMeetings instance using the TagResources operation, you must have both of the following permissions:

      tag:TagResources

      ChimeSDKMeetings:CreateTags

      Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.

    • toBuilder

      public CreateMeetingRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateMeetingRequest.Builder,CreateMeetingRequest>
      Specified by:
      toBuilder in class ChimeSdkMeetingsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateMeetingRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateMeetingRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.