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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateMeetingRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateMeetingRequest.Builderbuilder()StringclientRequestToken()The unique identifier for the client request.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexternalMeetingId()The external meeting ID.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.booleanhasTenantIds()For responses, this returns true if the service returned a value for the TenantIds property.StringmediaRegion()The Region in which to create the meeting.MeetingFeaturesConfigurationmeetingFeatures()Lists the audio and video features enabled for a meeting, such as echo reduction.StringmeetingHostId()Reserved.NotificationsConfigurationnotificationsConfiguration()The configuration for resource targets to receive notifications when meeting and attendee events occur.StringprimaryMeetingId()When specified, replicates the media from the primary meeting to the new meeting.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateMeetingRequest.Builder>serializableBuilderClass()List<Tag>tags()Applies one or more tags to an Amazon Chime SDK meeting.List<String>tenantIds()A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.CreateMeetingRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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 theisEmpty()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:TagResourcespermission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag aChimeSDKMeetingsinstance using theTagResourcesoperation, you must have both of the following permissions:tag:TagResourcesChimeSDKMeetings:CreateTagsSome services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the
s3:GetBucketTaggingpermission. 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:TagResourcespermission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag aChimeSDKMeetingsinstance using theTagResourcesoperation, you must have both of the following permissions:tag:TagResourcesChimeSDKMeetings:CreateTagsSome services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the
s3:GetBucketTaggingpermission. 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateMeetingRequest.Builder,CreateMeetingRequest>- Specified by:
toBuilderin classChimeSdkMeetingsRequest
-
builder
public static CreateMeetingRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateMeetingRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-