Class: Aws::ChimeSDKMeetings::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb

Overview

An API client for ChimeSDKMeetings. To construct a client, you need to configure a :region and :credentials.

client = Aws::ChimeSDKMeetings::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ChimeSDKMeetings::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ChimeSDKMeetings::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



385
386
387
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 385

def initialize(*args)
  super
end

Instance Method Details

#batch_create_attendee(params = {}) ⇒ Types::BatchCreateAttendeeResponse

Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_create_attendee({
  meeting_id: "GuidString", # required
  attendees: [ # required
    {
      external_user_id: "ExternalUserId", # required
      capabilities: {
        audio: "SendReceive", # required, accepts SendReceive, Send, Receive, None
        video: "SendReceive", # required, accepts SendReceive, Send, Receive, None
        content: "SendReceive", # required, accepts SendReceive, Send, Receive, None
      },
    },
  ],
})

Response structure


resp.attendees #=> Array
resp.attendees[0].external_user_id #=> String
resp.attendees[0].attendee_id #=> String
resp.attendees[0].join_token #=> String
resp.attendees[0].capabilities.audio #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendees[0].capabilities.video #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendees[0].capabilities.content #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.errors #=> Array
resp.errors[0].external_user_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK ID of the meeting to which you're adding attendees.

  • :attendees (required, Array<Types::CreateAttendeeRequestItem>) —

    The attendee information, including attendees' IDs and join tokens.

Returns:

See Also:



445
446
447
448
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 445

def batch_create_attendee(params = {}, options = {})
  req = build_request(:batch_create_attendee, params)
  req.send_request(options)
end

#batch_update_attendee_capabilities_except(params = {}) ⇒ Struct

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

  • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

  • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

  • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Examples:

Request syntax with placeholder values


resp = client.batch_update_attendee_capabilities_except({
  meeting_id: "GuidString", # required
  excluded_attendee_ids: [ # required
    {
      attendee_id: "GuidString", # required
    },
  ],
  capabilities: { # required
    audio: "SendReceive", # required, accepts SendReceive, Send, Receive, None
    video: "SendReceive", # required, accepts SendReceive, Send, Receive, None
    content: "SendReceive", # required, accepts SendReceive, Send, Receive, None
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The ID of the meeting associated with the update request.

  • :excluded_attendee_ids (required, Array<Types::AttendeeIdItem>) —

    The AttendeeIDs that you want to exclude from one or more capabilities.

  • :capabilities (required, Types::AttendeeCapabilities) —

    The capabilities (audio, video, or content) that you want to update.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



512
513
514
515
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 512

def batch_update_attendee_capabilities_except(params = {}, options = {})
  req = build_request(:batch_update_attendee_capabilities_except, params)
  req.send_request(options)
end

#create_attendee(params = {}) ⇒ Types::CreateAttendeeResponse

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_attendee({
  meeting_id: "GuidString", # required
  external_user_id: "ExternalUserId", # required
  capabilities: {
    audio: "SendReceive", # required, accepts SendReceive, Send, Receive, None
    video: "SendReceive", # required, accepts SendReceive, Send, Receive, None
    content: "SendReceive", # required, accepts SendReceive, Send, Receive, None
  },
})

Response structure


resp.attendee.external_user_id #=> String
resp.attendee.attendee_id #=> String
resp.attendee.join_token #=> String
resp.attendee.capabilities.audio #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendee.capabilities.video #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendee.capabilities.content #=> String, one of "SendReceive", "Send", "Receive", "None"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The unique ID of the meeting.

  • :external_user_id (required, String) —

    The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

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

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

  • :capabilities (Types::AttendeeCapabilities) —

    The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

    You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

    When using capabilities, be aware of these corner cases:

    • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

    • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Returns:

See Also:



597
598
599
600
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 597

def create_attendee(params = {}, options = {})
  req = build_request(:create_attendee, params)
  req.send_request(options)
end

#create_meeting(params = {}) ⇒ Types::CreateMeetingResponse

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_meeting({
  client_request_token: "ClientRequestToken", # required
  media_region: "MediaRegion", # required
  meeting_host_id: "ExternalUserId",
  external_meeting_id: "ExternalMeetingId", # required
  notifications_configuration: {
    lambda_function_arn: "Arn",
    sns_topic_arn: "Arn",
    sqs_queue_arn: "Arn",
  },
  meeting_features: {
    audio: {
      echo_reduction: "AVAILABLE", # accepts AVAILABLE, UNAVAILABLE
    },
  },
  primary_meeting_id: "PrimaryMeetingId",
  tenant_ids: ["TenantId"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.meeting.meeting_id #=> String
resp.meeting.meeting_host_id #=> String
resp.meeting.external_meeting_id #=> String
resp.meeting.media_region #=> String
resp.meeting.media_placement.audio_host_url #=> String
resp.meeting.media_placement.audio_fallback_url #=> String
resp.meeting.media_placement.signaling_url #=> String
resp.meeting.media_placement.turn_control_url #=> String
resp.meeting.media_placement.screen_data_url #=> String
resp.meeting.media_placement.screen_viewing_url #=> String
resp.meeting.media_placement.screen_sharing_url #=> String
resp.meeting.media_placement.event_ingestion_url #=> String
resp.meeting.meeting_features.audio.echo_reduction #=> String, one of "AVAILABLE", "UNAVAILABLE"
resp.meeting.primary_meeting_id #=> String
resp.meeting.tenant_ids #=> Array
resp.meeting.tenant_ids[0] #=> String
resp.meeting.meeting_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_request_token (required, 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.**

  • :media_region (required, 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 AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

  • :meeting_host_id (String) —

    Reserved.

  • :external_meeting_id (required, 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.

  • :notifications_configuration (Types::NotificationsConfiguration) —

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

  • :meeting_features (Types::MeetingFeaturesConfiguration) —

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

  • :primary_meeting_id (String) —

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

  • :tenant_ids (Array<String>) —

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

  • :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 AWS Region for the AWS 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.

Returns:

See Also:



766
767
768
769
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 766

def create_meeting(params = {}, options = {})
  req = build_request(:create_meeting, params)
  req.send_request(options)
end

#create_meeting_with_attendees(params = {}) ⇒ Types::CreateMeetingWithAttendeesResponse

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_meeting_with_attendees({
  client_request_token: "ClientRequestToken", # required
  media_region: "MediaRegion", # required
  meeting_host_id: "ExternalUserId",
  external_meeting_id: "ExternalMeetingId", # required
  meeting_features: {
    audio: {
      echo_reduction: "AVAILABLE", # accepts AVAILABLE, UNAVAILABLE
    },
  },
  notifications_configuration: {
    lambda_function_arn: "Arn",
    sns_topic_arn: "Arn",
    sqs_queue_arn: "Arn",
  },
  attendees: [ # required
    {
      external_user_id: "ExternalUserId", # required
      capabilities: {
        audio: "SendReceive", # required, accepts SendReceive, Send, Receive, None
        video: "SendReceive", # required, accepts SendReceive, Send, Receive, None
        content: "SendReceive", # required, accepts SendReceive, Send, Receive, None
      },
    },
  ],
  primary_meeting_id: "PrimaryMeetingId",
  tenant_ids: ["TenantId"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.meeting.meeting_id #=> String
resp.meeting.meeting_host_id #=> String
resp.meeting.external_meeting_id #=> String
resp.meeting.media_region #=> String
resp.meeting.media_placement.audio_host_url #=> String
resp.meeting.media_placement.audio_fallback_url #=> String
resp.meeting.media_placement.signaling_url #=> String
resp.meeting.media_placement.turn_control_url #=> String
resp.meeting.media_placement.screen_data_url #=> String
resp.meeting.media_placement.screen_viewing_url #=> String
resp.meeting.media_placement.screen_sharing_url #=> String
resp.meeting.media_placement.event_ingestion_url #=> String
resp.meeting.meeting_features.audio.echo_reduction #=> String, one of "AVAILABLE", "UNAVAILABLE"
resp.meeting.primary_meeting_id #=> String
resp.meeting.tenant_ids #=> Array
resp.meeting.tenant_ids[0] #=> String
resp.meeting.meeting_arn #=> String
resp.attendees #=> Array
resp.attendees[0].external_user_id #=> String
resp.attendees[0].attendee_id #=> String
resp.attendees[0].join_token #=> String
resp.attendees[0].capabilities.audio #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendees[0].capabilities.video #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendees[0].capabilities.content #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.errors #=> Array
resp.errors[0].external_user_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_request_token (required, 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.**

  • :media_region (required, 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 AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

  • :meeting_host_id (String) —

    Reserved.

  • :external_meeting_id (required, 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.

  • :meeting_features (Types::MeetingFeaturesConfiguration) —

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

  • :notifications_configuration (Types::NotificationsConfiguration) —

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

  • :attendees (required, Array<Types::CreateAttendeeRequestItem>) —

    The attendee information, including attendees' IDs and join tokens.

  • :primary_meeting_id (String) —

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

  • :tenant_ids (Array<String>) —

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

  • :tags (Array<Types::Tag>) —

    The tags in the request.

Returns:

See Also:



912
913
914
915
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 912

def create_meeting_with_attendees(params = {}, options = {})
  req = build_request(:create_meeting_with_attendees, params)
  req.send_request(options)
end

#delete_attendee(params = {}) ⇒ Struct

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_attendee({
  meeting_id: "GuidString", # required
  attendee_id: "GuidString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String) —

    The Amazon Chime SDK attendee ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



946
947
948
949
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 946

def delete_attendee(params = {}, options = {})
  req = build_request(:delete_attendee, params)
  req.send_request(options)
end

#delete_meeting(params = {}) ⇒ Struct

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_meeting({
  meeting_id: "GuidString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



976
977
978
979
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 976

def delete_meeting(params = {}, options = {})
  req = build_request(:delete_meeting, params)
  req.send_request(options)
end

#get_attendee(params = {}) ⇒ Types::GetAttendeeResponse

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_attendee({
  meeting_id: "GuidString", # required
  attendee_id: "GuidString", # required
})

Response structure


resp.attendee.external_user_id #=> String
resp.attendee.attendee_id #=> String
resp.attendee.join_token #=> String
resp.attendee.capabilities.audio #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendee.capabilities.video #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendee.capabilities.content #=> String, one of "SendReceive", "Send", "Receive", "None"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String) —

    The Amazon Chime SDK attendee ID.

Returns:

See Also:



1019
1020
1021
1022
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1019

def get_attendee(params = {}, options = {})
  req = build_request(:get_attendee, params)
  req.send_request(options)
end

#get_meeting(params = {}) ⇒ Types::GetMeetingResponse

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_meeting({
  meeting_id: "GuidString", # required
})

Response structure


resp.meeting.meeting_id #=> String
resp.meeting.meeting_host_id #=> String
resp.meeting.external_meeting_id #=> String
resp.meeting.media_region #=> String
resp.meeting.media_placement.audio_host_url #=> String
resp.meeting.media_placement.audio_fallback_url #=> String
resp.meeting.media_placement.signaling_url #=> String
resp.meeting.media_placement.turn_control_url #=> String
resp.meeting.media_placement.screen_data_url #=> String
resp.meeting.media_placement.screen_viewing_url #=> String
resp.meeting.media_placement.screen_sharing_url #=> String
resp.meeting.media_placement.event_ingestion_url #=> String
resp.meeting.meeting_features.audio.echo_reduction #=> String, one of "AVAILABLE", "UNAVAILABLE"
resp.meeting.primary_meeting_id #=> String
resp.meeting.tenant_ids #=> Array
resp.meeting.tenant_ids[0] #=> String
resp.meeting.meeting_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

Returns:

See Also:



1069
1070
1071
1072
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1069

def get_meeting(params = {}, options = {})
  req = build_request(:get_meeting, params)
  req.send_request(options)
end

#list_attendees(params = {}) ⇒ Types::ListAttendeesResponse

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_attendees({
  meeting_id: "GuidString", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.attendees #=> Array
resp.attendees[0].external_user_id #=> String
resp.attendees[0].attendee_id #=> String
resp.attendees[0].join_token #=> String
resp.attendees[0].capabilities.audio #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendees[0].capabilities.video #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendees[0].capabilities.content #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :next_token (String) —

    The token to use to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

Returns:

See Also:



1121
1122
1123
1124
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1121

def list_attendees(params = {}, options = {})
  req = build_request(:list_attendees, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of the tags available for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

Returns:

See Also:



1151
1152
1153
1154
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1151

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#start_meeting_transcription(params = {}) ⇒ Struct

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

Examples:

Request syntax with placeholder values


resp = client.start_meeting_transcription({
  meeting_id: "GuidString", # required
  transcription_configuration: { # required
    engine_transcribe_settings: {
      language_code: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, th-TH, hi-IN
      vocabulary_filter_method: "remove", # accepts remove, mask, tag
      vocabulary_filter_name: "String",
      vocabulary_name: "String",
      region: "us-east-2", # accepts us-east-2, us-east-1, us-west-2, ap-northeast-2, ap-southeast-2, ap-northeast-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, sa-east-1, auto, us-gov-west-1
      enable_partial_results_stabilization: false,
      partial_results_stability: "low", # accepts low, medium, high
      content_identification_type: "PII", # accepts PII
      content_redaction_type: "PII", # accepts PII
      pii_entity_types: "TranscribePiiEntityTypes",
      language_model_name: "TranscribeLanguageModelName",
      identify_language: false,
      language_options: "TranscribeLanguageOptions",
      preferred_language: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, th-TH, hi-IN
      vocabulary_names: "TranscribeVocabularyNamesOrFilterNamesString",
      vocabulary_filter_names: "TranscribeVocabularyNamesOrFilterNamesString",
    },
    engine_transcribe_medical_settings: {
      language_code: "en-US", # required, accepts en-US
      specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE, CARDIOLOGY, NEUROLOGY, ONCOLOGY, RADIOLOGY, UROLOGY
      type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
      vocabulary_name: "String",
      region: "us-east-1", # accepts us-east-1, us-east-2, us-west-2, ap-southeast-2, ca-central-1, eu-west-1, auto
      content_identification_type: "PHI", # accepts PHI
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The unique ID of the meeting being transcribed.

  • :transcription_configuration (required, Types::TranscriptionConfiguration) —

    The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1225
1226
1227
1228
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1225

def start_meeting_transcription(params = {}, options = {})
  req = build_request(:start_meeting_transcription, params)
  req.send_request(options)
end

#stop_meeting_transcription(params = {}) ⇒ Struct

Stops transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

Examples:

Request syntax with placeholder values


resp = client.stop_meeting_transcription({
  meeting_id: "GuidString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The unique ID of the meeting for which you stop transcription.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1259
1260
1261
1262
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1259

def stop_meeting_transcription(params = {}, options = {})
  req = build_request(:stop_meeting_transcription, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

The resource that supports tags.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

  • :tags (required, Array<Types::Tag>) —

    Lists the requested tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1290
1291
1292
1293
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1290

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

  • To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag.

  • You can only tag resources that are located in the specified AWS Region for the calling AWS account.

Minimum permissions

In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions:

tag:UntagResource

ChimeSDKMeetings:DeleteTags

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource that you're removing tags from.

  • :tag_keys (required, Array<String>) —

    The tag keys being removed from the resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1339
1340
1341
1342
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1339

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_attendee_capabilities(params = {}) ⇒ Types::UpdateAttendeeCapabilitiesResponse

The capabilities that you want to update.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

  • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

  • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

  • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Examples:

Request syntax with placeholder values


resp = client.update_attendee_capabilities({
  meeting_id: "GuidString", # required
  attendee_id: "GuidString", # required
  capabilities: { # required
    audio: "SendReceive", # required, accepts SendReceive, Send, Receive, None
    video: "SendReceive", # required, accepts SendReceive, Send, Receive, None
    content: "SendReceive", # required, accepts SendReceive, Send, Receive, None
  },
})

Response structure


resp.attendee.external_user_id #=> String
resp.attendee.attendee_id #=> String
resp.attendee.join_token #=> String
resp.attendee.capabilities.audio #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendee.capabilities.video #=> String, one of "SendReceive", "Send", "Receive", "None"
resp.attendee.capabilities.content #=> String, one of "SendReceive", "Send", "Receive", "None"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The ID of the meeting associated with the update request.

  • :attendee_id (required, String) —

    The ID of the attendee associated with the update request.

  • :capabilities (required, Types::AttendeeCapabilities) —

    The capabilities that you want to update.

Returns:

See Also:



1410
1411
1412
1413
 
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1410

def update_attendee_capabilities(params = {}, options = {})
  req = build_request(:update_attendee_capabilities, params)
  req.send_request(options)
end