class Aws::ChimeSDKMeetings::Client

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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Attributes

identifier[R]

@api private

Public Class Methods

errors_module() click to toggle source

@api private

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 964
def errors_module
  Errors
end
new(*args) click to toggle source

@overload initialize(options)

@param [Hash] options
@option options [required, Aws::CredentialProvider] :credentials
  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.

@option options [required, String] :region
  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`

@option options [String] :access_key_id

@option options [Boolean] :active_endpoint_cache (false)
  When set to `true`, a thread polling for endpoints will be running in
  the background every 60 secs (default). Defaults to `false`.

@option options [Boolean] :adaptive_retry_wait_to_fill (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.

@option options [Boolean] :client_side_monitoring (false)
  When `true`, client-side metrics will be collected for all API requests from
  this client.

@option options [String] :client_side_monitoring_client_id ("")
  Allows you to provide an identifier for this client which will be attached to
  all generated client side metrics. Defaults to an empty string.

@option options [String] :client_side_monitoring_host ("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.

@option options [Integer] :client_side_monitoring_port (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.

@option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
  Allows you to provide a custom client-side monitoring publisher class. By default,
  will use the Client Side Monitoring Agent Publisher.

@option options [Boolean] :convert_params (true)
  When `true`, an attempt is made to coerce request parameters into
  the required types.

@option options [Boolean] :correct_clock_skew (true)
  Used only in `standard` and adaptive retry modes. Specifies whether to apply
  a clock skew correction and retry requests with skewed client clocks.

@option options [String] :defaults_mode ("legacy")
  See {Aws::DefaultsModeConfiguration} for a list of the
  accepted modes and the configuration defaults that are included.

@option options [Boolean] :disable_host_prefix_injection (false)
  Set to true to disable SDK automatically adding host prefix
  to default service endpoint when available.

@option options [String] :endpoint
  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.

@option options [Integer] :endpoint_cache_max_entries (1000)
  Used for the maximum size limit of the LRU cache storing endpoints data
  for endpoint discovery enabled operations. Defaults to 1000.

@option options [Integer] :endpoint_cache_max_threads (10)
  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

@option options [Integer] :endpoint_cache_poll_interval (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.

@option options [Boolean] :endpoint_discovery (false)
  When set to `true`, endpoint discovery will be enabled for operations when available.

@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
  The log formatter.

@option options [Symbol] :log_level (:info)
  The log level to send messages to the `:logger` at.

@option options [Logger] :logger
  The Logger instance to send log messages to.  If this option
  is not set, logging will be disabled.

@option options [Integer] :max_attempts (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.

@option options [String] :profile ("default")
  Used when loading credentials from the shared credentials file
  at HOME/.aws/credentials.  When not specified, 'default' is used.

@option options [Proc] :retry_backoff
  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
  This option is only used in the `legacy` retry mode.

@option options [Float] :retry_base_delay (0.3)
  The base delay in seconds used by the default backoff function. This option
  is only used in the `legacy` retry mode.

@option options [Symbol] :retry_jitter (: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

@option options [Integer] :retry_limit (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.

@option options [Integer] :retry_max_delay (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.

@option options [String] :retry_mode ("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.

@option options [String] :secret_access_key

@option options [String] :session_token

@option options [Boolean] :stub_responses (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
  {ClientStubs#stub_responses}. See {ClientStubs} for more information.

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

@option options [Boolean] :use_dualstack_endpoint
  When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
  will be used if available.

@option options [Boolean] :use_fips_endpoint
  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`.

@option options [Boolean] :validate_params (true)
  When `true`, request parameters are validated before
  sending the request.

@option options [URI::HTTP,String] :http_proxy A proxy to send
  requests through.  Formatted like 'http://proxy.com:123'.

@option options [Float] :http_open_timeout (15) The number of
  seconds to wait when opening a HTTP session before raising a
  `Timeout::Error`.

@option options [Float] :http_read_timeout (60) The default
  number of seconds to wait for response data.  This value can
  safely be set per-request on the session.

@option options [Float] :http_idle_timeout (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.

@option options [Float] :http_continue_timeout (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.

@option options [Float] :ssl_timeout (nil) Sets the SSL timeout
  in seconds.

@option options [Boolean] :http_wire_trace (false) When `true`,
  HTTP debug output will be sent to the `:logger`.

@option options [Boolean] :ssl_verify_peer (true) When `true`,
  SSL peer certificates are verified when establishing a
  connection.

@option options [String] :ssl_ca_bundle 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.

@option options [String] :ssl_ca_directory 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.
Calls superclass method
# File lib/aws-sdk-chimesdkmeetings/client.rb, line 348
def initialize(*args)
  super
end

Public Instance Methods

batch_create_attendee(params = {}, options = {}) click to toggle source

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

[1]: docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html

@option params [required, String] :meeting_id

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

@option params [required, Array<Types::CreateAttendeeRequestItem>] :attendees

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

@return [Types::BatchCreateAttendeeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::BatchCreateAttendeeResponse#attendees #attendees} => Array&lt;Types::Attendee&gt;
* {Types::BatchCreateAttendeeResponse#errors #errors} => Array&lt;Types::CreateAttendeeError&gt;

@example Request syntax with placeholder values

resp = client.batch_create_attendee({
  meeting_id: "GuidString", # required
  attendees: [ # required
    {
      external_user_id: "ExternalUserId", # required
    },
  ],
})

@example 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.errors #=> Array
resp.errors[0].external_user_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/BatchCreateAttendee AWS API Documentation

@overload batch_create_attendee(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 400
def batch_create_attendee(params = {}, options = {})
  req = build_request(:batch_create_attendee, params)
  req.send_request(options)
end
build_request(operation_name, params = {}) click to toggle source

@param params ({}) @api private

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 939
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-chimesdkmeetings'
  context[:gem_version] = '1.9.0'
  Seahorse::Client::Request.new(handlers, context)
end
create_attendee(params = {}, options = {}) click to toggle source

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

[1]: docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html

@option params [required, String] :meeting_id

The unique ID of the meeting.

@option params [required, String] :external_user_id

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

@return [Types::CreateAttendeeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateAttendeeResponse#attendee #attendee} => Types::Attendee

@example Request syntax with placeholder values

resp = client.create_attendee({
  meeting_id: "GuidString", # required
  external_user_id: "ExternalUserId", # required
})

@example Response structure

resp.attendee.external_user_id #=> String
resp.attendee.attendee_id #=> String
resp.attendee.join_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateAttendee AWS API Documentation

@overload create_attendee(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 441
def create_attendee(params = {}, options = {})
  req = build_request(:create_attendee, params)
  req.send_request(options)
end
create_meeting(params = {}, options = {}) click to toggle source

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][2

in the *Amazon Chime Developer Guide*.

[1]: docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html [2]: docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html

@option params [required, String] :client_request_token

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

@option params [required, String] :media_region

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

@option params [String] :meeting_host_id

Reserved.

@option params [required, String] :external_meeting_id

The external meeting ID.

@option params [Types::NotificationsConfiguration] :notifications_configuration

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

@option params [Types::MeetingFeaturesConfiguration] :meeting_features

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

@option params [String] :primary_meeting_id

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

@return [Types::CreateMeetingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateMeetingResponse#meeting #meeting} => Types::Meeting

@example 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",
})

@example 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

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateMeeting AWS API Documentation

@overload create_meeting(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 539
def create_meeting(params = {}, options = {})
  req = build_request(:create_meeting, params)
  req.send_request(options)
end
create_meeting_with_attendees(params = {}, options = {}) click to toggle source

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

[1]: docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html [2]: docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html

@option params [required, String] :client_request_token

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

@option params [required, String] :media_region

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

@option params [String] :meeting_host_id

Reserved.

@option params [required, String] :external_meeting_id

The external meeting ID.

@option params [Types::MeetingFeaturesConfiguration] :meeting_features

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

@option params [Types::NotificationsConfiguration] :notifications_configuration

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

@option params [required, Array<Types::CreateAttendeeRequestItem>] :attendees

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

@option params [String] :primary_meeting_id

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

@return [Types::CreateMeetingWithAttendeesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateMeetingWithAttendeesResponse#meeting #meeting} => Types::Meeting
* {Types::CreateMeetingWithAttendeesResponse#attendees #attendees} => Array&lt;Types::Attendee&gt;
* {Types::CreateMeetingWithAttendeesResponse#errors #errors} => Array&lt;Types::CreateAttendeeError&gt;

@example 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
    },
  ],
  primary_meeting_id: "PrimaryMeetingId",
})

@example 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.attendees #=> Array
resp.attendees[0].external_user_id #=> String
resp.attendees[0].attendee_id #=> String
resp.attendees[0].join_token #=> String
resp.errors #=> Array
resp.errors[0].external_user_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateMeetingWithAttendees AWS API Documentation

@overload create_meeting_with_attendees(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 655
def create_meeting_with_attendees(params = {}, options = {})
  req = build_request(:create_meeting_with_attendees, params)
  req.send_request(options)
end
delete_attendee(params = {}, options = {}) click to toggle source

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

[1]: docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html

@option params [required, String] :meeting_id

The Amazon Chime SDK meeting ID.

@option params [required, String] :attendee_id

The Amazon Chime SDK attendee ID.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/DeleteAttendee AWS API Documentation

@overload delete_attendee(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 689
def delete_attendee(params = {}, options = {})
  req = build_request(:delete_attendee, params)
  req.send_request(options)
end
delete_meeting(params = {}, options = {}) click to toggle source

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

[1]: docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html

@option params [required, String] :meeting_id

The Amazon Chime SDK meeting ID.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/DeleteMeeting AWS API Documentation

@overload delete_meeting(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 719
def delete_meeting(params = {}, options = {})
  req = build_request(:delete_meeting, params)
  req.send_request(options)
end
get_attendee(params = {}, options = {}) click to toggle source

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][1

in the *Amazon Chime Developer Guide*.

[1]: docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html

@option params [required, String] :meeting_id

The Amazon Chime SDK meeting ID.

@option params [required, String] :attendee_id

The Amazon Chime SDK attendee ID.

@return [Types::GetAttendeeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetAttendeeResponse#attendee #attendee} => Types::Attendee

@example Request syntax with placeholder values

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

@example Response structure

resp.attendee.external_user_id #=> String
resp.attendee.attendee_id #=> String
resp.attendee.join_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/GetAttendee AWS API Documentation

@overload get_attendee(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 759
def get_attendee(params = {}, options = {})
  req = build_request(:get_attendee, params)
  req.send_request(options)
end
get_meeting(params = {}, options = {}) click to toggle source

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

[1]: docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html

@option params [required, String] :meeting_id

The Amazon Chime SDK meeting ID.

@return [Types::GetMeetingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetMeetingResponse#meeting #meeting} => Types::Meeting

@example Request syntax with placeholder values

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

@example 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

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/GetMeeting AWS API Documentation

@overload get_meeting(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 806
def get_meeting(params = {}, options = {})
  req = build_request(:get_meeting, params)
  req.send_request(options)
end
list_attendees(params = {}, options = {}) click to toggle source

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

[1]: docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html

@option params [required, String] :meeting_id

The Amazon Chime SDK meeting ID.

@option params [String] :next_token

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

@option params [Integer] :max_results

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

@return [Types::ListAttendeesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListAttendeesResponse#attendees #attendees} => Array&lt;Types::Attendee&gt;
* {Types::ListAttendeesResponse#next_token #next_token} => String

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

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

@example 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.next_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/ListAttendees AWS API Documentation

@overload list_attendees(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 855
def list_attendees(params = {}, options = {})
  req = build_request(:list_attendees, params)
  req.send_request(options)
end
start_meeting_transcription(params = {}, options = {}) click to toggle source

Starts transcription for the specified ‘meetingId`.

@option params [required, String] :meeting_id

The unique ID of the meeting being transcribed.

@option params [required, Types::TranscriptionConfiguration] :transcription_configuration

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

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example 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
      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
      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
    },
    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
    },
  },
})

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/StartMeetingTranscription AWS API Documentation

@overload start_meeting_transcription(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 908
def start_meeting_transcription(params = {}, options = {})
  req = build_request(:start_meeting_transcription, params)
  req.send_request(options)
end
stop_meeting_transcription(params = {}, options = {}) click to toggle source

Stops transcription for the specified ‘meetingId`.

@option params [required, String] :meeting_id

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

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/StopMeetingTranscription AWS API Documentation

@overload stop_meeting_transcription(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 930
def stop_meeting_transcription(params = {}, options = {})
  req = build_request(:stop_meeting_transcription, params)
  req.send_request(options)
end
waiter_names() click to toggle source

@api private @deprecated

# File lib/aws-sdk-chimesdkmeetings/client.rb, line 954
def waiter_names
  []
end