Class: Aws::ChimeSDKMeetings::Types::CreateMeetingRequest

Inherits:

Struct

• Object
• Struct
• Aws::ChimeSDKMeetings::Types::CreateMeetingRequest

Includes:

Structure

Defined in:

lib/aws-sdk-chimesdkmeetings/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_request_token, :meeting_host_id, :external_meeting_id]

Instance Attribute Summary

• #client_request_token ⇒ String

  The unique identifier for the client request.

• #external_meeting_id ⇒ String

  The external meeting ID.

• #media_placement_network_type ⇒ String

  The type of network for the media placement.

• #media_region ⇒ String

  The Region in which to create the meeting.

• #meeting_features ⇒ Types::MeetingFeaturesConfiguration

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

• #meeting_host_id ⇒ String

  Reserved.

• #notifications_configuration ⇒ Types::NotificationsConfiguration

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

• #primary_meeting_id ⇒ String

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

• #tags ⇒ Array<Types::Tag>

  Applies one or more tags to an Amazon Chime SDK meeting.

• #tenant_ids ⇒ Array<String>

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

Instance Attribute Details

#client_request_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end

#external_meeting_id ⇒ String

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.

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end

#media_placement_network_type ⇒ String

The type of network for the media placement. Either IPv4 only or dual-stack (IPv4 and IPv6).

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end

#media_region ⇒ String

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`.

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end

#meeting_features ⇒ Types::MeetingFeaturesConfiguration

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

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end

#meeting_host_id ⇒ String

Reserved.

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end

#notifications_configuration ⇒ Types::NotificationsConfiguration

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

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end

#primary_meeting_id ⇒ String

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

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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`

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html [2]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end

#tenant_ids ⇒ Array<String>

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

# File 'lib/aws-sdk-chimesdkmeetings/types.rb', line 608

class CreateMeetingRequest < Struct.new(
  :client_request_token,
  :media_region,
  :meeting_host_id,
  :external_meeting_id,
  :notifications_configuration,
  :meeting_features,
  :primary_meeting_id,
  :tenant_ids,
  :tags,
  :media_placement_network_type)
  SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
  include Aws::Structure
end