Class: Aws::Chime::Client

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

Overview

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

client = Aws::Chime::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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.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::InstanceProfileCredentials 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)
  • :account_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, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :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::Chime::EndpointProvider) —

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

  • :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.

  • :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_open_timeout (Float) — default: 15 —

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

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

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

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



444
445
446
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 444

def initialize(*args)
  super
end

Instance Method Details

#associate_phone_number_with_user(params = {}) ⇒ Struct

Associates a phone number with the specified Amazon Chime user.

Examples:

Request syntax with placeholder values


resp = client.associate_phone_number_with_user({
  account_id: "String", # required
  user_id: "String", # required
  e164_phone_number: "E164PhoneNumber", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

  • :e164_phone_number (required, String) —

    The phone number, in E.164 format.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



475
476
477
478
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 475

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

#associate_phone_numbers_with_voice_connector(params = {}) ⇒ Types::AssociatePhoneNumbersWithVoiceConnectorResponse

Associates phone numbers with the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.associate_phone_numbers_with_voice_connector({
  voice_connector_id: "NonEmptyString", # required
  e164_phone_numbers: ["E164PhoneNumber"], # required
  force_associate: false,
})

Response structure


resp.phone_number_errors #=> Array
resp.phone_number_errors[0].phone_number_id #=> String
resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

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

    List of phone numbers, in E.164 format.

  • :force_associate (Boolean) —

    If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

Returns:

See Also:



531
532
533
534
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 531

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

#associate_phone_numbers_with_voice_connector_group(params = {}) ⇒ Types::AssociatePhoneNumbersWithVoiceConnectorGroupResponse

Associates phone numbers with the specified Amazon Chime Voice Connector group.

This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.associate_phone_numbers_with_voice_connector_group({
  voice_connector_group_id: "NonEmptyString", # required
  e164_phone_numbers: ["E164PhoneNumber"], # required
  force_associate: false,
})

Response structure


resp.phone_number_errors #=> Array
resp.phone_number_errors[0].phone_number_id #=> String
resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Amazon Chime Voice Connector group ID.

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

    List of phone numbers, in E.164 format.

  • :force_associate (Boolean) —

    If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

Returns:

See Also:



588
589
590
591
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 588

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

#associate_signin_delegate_groups_with_account(params = {}) ⇒ Struct

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "NonEmptyString", # required
  signin_delegate_groups: [ # required
    {
      group_name: "NonEmptyString",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :signin_delegate_groups (required, Array<Types::SigninDelegateGroup>) —

    The sign-in delegate groups.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



619
620
621
622
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 619

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

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

Creates up to 100 new attendees for an active Amazon Chime SDK meeting.

This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_create_attendee({
  meeting_id: "GuidString", # required
  attendees: [ # required
    {
      external_user_id: "ExternalUserIdType", # required
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
    },
  ],
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

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

    The request containing the attendees to create.

Returns:

See Also:



687
688
689
690
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 687

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

#batch_create_channel_membership(params = {}) ⇒ Types::BatchCreateChannelMembershipResponse

Adds a specified number of users to a channel.

This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_create_channel_membership({
  channel_arn: "ChimeArn", # required
  type: "DEFAULT", # accepts DEFAULT, HIDDEN
  member_arns: ["ChimeArn"], # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.batch_channel_memberships.invited_by.arn #=> String
resp.batch_channel_memberships.invited_by.name #=> String
resp.batch_channel_memberships.type #=> String, one of "DEFAULT", "HIDDEN"
resp.batch_channel_memberships.members #=> Array
resp.batch_channel_memberships.members[0].arn #=> String
resp.batch_channel_memberships.members[0].name #=> String
resp.batch_channel_memberships.channel_arn #=> String
resp.errors #=> Array
resp.errors[0].member_arn #=> String
resp.errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel to which you're adding users.

  • :type (String) —

    The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

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

    The ARNs of the members you want to add to the channel.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



755
756
757
758
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 755

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

#batch_create_room_membership(params = {}) ⇒ Types::BatchCreateRoomMembershipResponse

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

Examples:

Request syntax with placeholder values


resp = client.batch_create_room_membership({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
  membership_item_list: [ # required
    {
      member_id: "NonEmptyString",
      role: "Administrator", # accepts Administrator, Member
    },
  ],
})

Response structure


resp.errors #=> Array
resp.errors[0].member_id #=> String
resp.errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

  • :membership_item_list (required, Array<Types::MembershipItem>) —

    The list of membership items.

Returns:

See Also:



802
803
804
805
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 802

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

#batch_delete_phone_number(params = {}) ⇒ Types::BatchDeletePhoneNumberResponse

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_phone_number({
  phone_number_ids: ["String"], # required
})

Response structure


resp.phone_number_errors #=> Array
resp.phone_number_errors[0].phone_number_id #=> String
resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    List of phone number IDs.

Returns:

See Also:



838
839
840
841
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 838

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

#batch_suspend_user(params = {}) ⇒ Types::BatchSuspendUserResponse

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

Examples:

Request syntax with placeholder values


resp = client.batch_suspend_user({
  account_id: "NonEmptyString", # required
  user_id_list: ["NonEmptyString"], # required
})

Response structure


resp.user_errors #=> Array
resp.user_errors[0].user_id #=> String
resp.user_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.user_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

    The request containing the user IDs to suspend.

Returns:

See Also:



893
894
895
896
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 893

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

#batch_unsuspend_user(params = {}) ⇒ Types::BatchUnsuspendUserResponse

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide.

Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

Examples:

Request syntax with placeholder values


resp = client.batch_unsuspend_user({
  account_id: "NonEmptyString", # required
  user_id_list: ["NonEmptyString"], # required
})

Response structure


resp.user_errors #=> Array
resp.user_errors[0].user_id #=> String
resp.user_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.user_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

    The request containing the user IDs to unsuspend.

Returns:

See Also:



941
942
943
944
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 941

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

#batch_update_phone_number(params = {}) ⇒ Types::BatchUpdatePhoneNumberResponse

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.

For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Examples:

Request syntax with placeholder values


resp = client.batch_update_phone_number({
  update_phone_number_request_items: [ # required
    {
      phone_number_id: "NonEmptyString", # required
      product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector, SipMediaApplicationDialIn
      calling_name: "CallingName",
    },
  ],
})

Response structure


resp.phone_number_errors #=> Array
resp.phone_number_errors[0].phone_number_id #=> String
resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :update_phone_number_request_items (required, Array<Types::UpdatePhoneNumberRequestItem>) —

    The request containing the phone number IDs and product types or calling names to update.

Returns:

See Also:



989
990
991
992
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 989

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

#batch_update_user(params = {}) ⇒ Types::BatchUpdateUserResponse

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

Examples:

Request syntax with placeholder values


resp = client.batch_update_user({
  account_id: "NonEmptyString", # required
  update_user_request_items: [ # required
    {
      user_id: "NonEmptyString", # required
      license_type: "Basic", # accepts Basic, Plus, Pro, ProTrial
      user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
      alexa_for_business_metadata: {
        is_alexa_for_business_enabled: false,
        alexa_for_business_room_arn: "SensitiveString",
      },
    },
  ],
})

Response structure


resp.user_errors #=> Array
resp.user_errors[0].user_id #=> String
resp.user_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.user_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :update_user_request_items (required, Array<Types::UpdateUserRequestItem>) —

    The request containing the user IDs and details to update.

Returns:

See Also:



1036
1037
1038
1039
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1036

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

#create_account(params = {}) ⇒ Types::CreateAccountResponse

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Examples:

Request syntax with placeholder values


resp = client.({
  name: "AccountName", # required
})

Response structure


resp.. #=> String
resp.. #=> String
resp..name #=> String
resp.. #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
resp..created_timestamp #=> Time
resp..default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp..supported_licenses #=> Array
resp..supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.. #=> String, one of "Suspended", "Active"
resp.. #=> Array
resp..[0].group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Amazon Chime account.

Returns:

See Also:



1082
1083
1084
1085
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1082

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

#create_app_instance(params = {}) ⇒ Types::CreateAppInstanceResponse

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_app_instance({
  name: "NonEmptyResourceName", # required
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.app_instance_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the AppInstance.

  • :metadata (String) —

    The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

  • :client_request_token (required, String) —

    The ClientRequestToken of the AppInstance.

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

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

    Tags assigned to the AppInstance.

Returns:

See Also:



1146
1147
1148
1149
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1146

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

#create_app_instance_admin(params = {}) ⇒ Types::CreateAppInstanceAdminResponse

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceAdmin, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

  • ChannelModerator actions across all channels in the AppInstance.

  • DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

Examples:

Request syntax with placeholder values


resp = client.create_app_instance_admin({
  app_instance_admin_arn: "ChimeArn", # required
  app_instance_arn: "ChimeArn", # required
})

Response structure


resp.app_instance_admin.arn #=> String
resp.app_instance_admin.name #=> String
resp.app_instance_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_admin_arn (required, String) —

    The ARN of the administrator of the current AppInstance.

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



1202
1203
1204
1205
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1202

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

#create_app_instance_user(params = {}) ⇒ Types::CreateAppInstanceUserResponse

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_app_instance_user({
  app_instance_arn: "ChimeArn", # required
  app_instance_user_id: "UserId", # required
  name: "UserName", # required
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.app_instance_user_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance request.

  • :app_instance_user_id (required, String) —

    The user ID of the AppInstance.

  • :name (required, String) —

    The user's name.

  • :metadata (String) —

    The request's metadata. Limited to a 1KB string in UTF-8.

  • :client_request_token (required, String) —

    The token assigned to the user requesting an AppInstance.

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

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

    Tags assigned to the AppInstanceUser.

Returns:

See Also:



1272
1273
1274
1275
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1272

def create_app_instance_user(params = {}, options = {})
  req = build_request(:create_app_instance_user, 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 SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_attendee({
  meeting_id: "GuidString", # required
  external_user_id: "ExternalUserIdType", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :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.

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

    The tag key-value pairs.

Returns:

See Also:



1332
1333
1334
1335
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1332

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

#create_bot(params = {}) ⇒ Types::CreateBotResponse

Creates a bot for an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


resp = client.create_bot({
  account_id: "NonEmptyString", # required
  display_name: "SensitiveString", # required
  domain: "NonEmptyString",
})

Response structure


resp.bot.bot_id #=> String
resp.bot.user_id #=> String
resp.bot.display_name #=> String
resp.bot.bot_type #=> String, one of "ChatBot"
resp.bot.disabled #=> Boolean
resp.bot.created_timestamp #=> Time
resp.bot.updated_timestamp #=> Time
resp.bot.bot_email #=> String
resp.bot.security_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :display_name (required, String) —

    The bot display name.

  • :domain (String) —

    The domain of the Amazon Chime Enterprise account.

Returns:

See Also:



1376
1377
1378
1379
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1376

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

#create_channel(params = {}) ⇒ Types::CreateChannelResponse

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_channel({
  app_instance_arn: "ChimeArn", # required
  name: "NonEmptyResourceName", # required
  mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
  privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the channel request.

  • :name (required, String) —

    The name of the channel.

  • :mode (String) —

    The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

  • :privacy (String) —

    The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

  • :metadata (String) —

    The metadata of the creation request. Limited to 1KB and UTF-8.

  • :client_request_token (required, String) —

    The client token for the request. An Idempotency token.

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

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

    The tags for the creation request.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



1466
1467
1468
1469
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1466

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

#create_channel_ban(params = {}) ⇒ Types::CreateChannelBanResponse

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_channel_ban({
  channel_arn: "ChimeArn", # required
  member_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.member.arn #=> String
resp.member.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the ban request.

  • :member_arn (required, String) —

    The ARN of the member being banned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



1530
1531
1532
1533
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1530

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

#create_channel_membership(params = {}) ⇒ Types::CreateChannelMembershipResponse

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

  • List messages

  • Send messages

  • Receive messages

  • Edit their own messages

  • Leave the channel

Privacy settings impact this action as follows:

  • Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

  • Private Channels: You must be a member to list or send messages.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_channel_membership({
  channel_arn: "ChimeArn", # required
  member_arn: "ChimeArn", # required
  type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.member.arn #=> String
resp.member.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel to which you're adding users.

  • :member_arn (required, String) —

    The ARN of the member you want to add to the channel.

  • :type (required, String) —

    The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



1614
1615
1616
1617
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1614

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

#create_channel_moderator(params = {}) ⇒ Types::CreateChannelModeratorResponse

Creates a new ChannelModerator. A channel moderator can:

  • Add and remove other members of the channel.

  • Add and remove other moderators of the channel.

  • Add and remove user bans for the channel.

  • Redact messages in the channel.

  • List messages in the channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelModerator, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_channel_moderator({
  channel_arn: "ChimeArn", # required
  channel_moderator_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.channel_moderator.arn #=> String
resp.channel_moderator.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :channel_moderator_arn (required, String) —

    The ARN of the moderator.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



1682
1683
1684
1685
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1682

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

#create_media_capture_pipeline(params = {}) ⇒ Types::CreateMediaCapturePipelineResponse

Creates a media capture pipeline.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_media_capture_pipeline({
  source_type: "ChimeSdkMeeting", # required, accepts ChimeSdkMeeting
  source_arn: "Arn", # required
  sink_type: "S3Bucket", # required, accepts S3Bucket
  sink_arn: "Arn", # required
  client_request_token: "ClientRequestToken",
  chime_sdk_meeting_configuration: {
    source_configuration: {
      selected_video_streams: {
        attendee_ids: ["GuidString"],
        external_user_ids: ["ExternalUserIdType"],
      },
    },
    artifacts_configuration: {
      audio: { # required
        mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo
      },
      video: { # required
        state: "Enabled", # required, accepts Enabled, Disabled
        mux_type: "VideoOnly", # accepts VideoOnly
      },
      content: { # required
        state: "Enabled", # required, accepts Enabled, Disabled
        mux_type: "ContentOnly", # accepts ContentOnly
      },
    },
  },
})

Response structure


resp.media_capture_pipeline.media_pipeline_id #=> String
resp.media_capture_pipeline.source_type #=> String, one of "ChimeSdkMeeting"
resp.media_capture_pipeline.source_arn #=> String
resp.media_capture_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
resp.media_capture_pipeline.sink_type #=> String, one of "S3Bucket"
resp.media_capture_pipeline.sink_arn #=> String
resp.media_capture_pipeline.created_timestamp #=> Time
resp.media_capture_pipeline.updated_timestamp #=> Time
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"

Parameters:

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

    ({})

Options Hash (params):

  • :source_type (required, String) —

    Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.

  • :source_arn (required, String) —

    ARN of the source from which the media artifacts are captured.

  • :sink_type (required, String) —

    Destination type to which the media artifacts are saved. You must use an S3 bucket.

  • :sink_arn (required, String) —

    The ARN of the sink type.

  • :client_request_token (String) —

    The unique identifier for the client request. The token makes the API request idempotent. Use a different token for different media pipeline requests.

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

  • :chime_sdk_meeting_configuration (Types::ChimeSdkMeetingConfiguration) —

    The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

Returns:

See Also:



1787
1788
1789
1790
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1787

def create_media_capture_pipeline(params = {}, options = {})
  req = build_request(:create_media_capture_pipeline, 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 SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_meeting({
  client_request_token: "ClientRequestToken", # required
  external_meeting_id: "ExternalMeetingIdType",
  meeting_host_id: "ExternalUserIdType",
  media_region: "String",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  notifications_configuration: {
    sns_topic_arn: "Arn",
    sqs_queue_arn: "Arn",
  },
})

Response structure


resp.meeting.meeting_id #=> String
resp.meeting.external_meeting_id #=> String
resp.meeting.media_placement.audio_host_url #=> String
resp.meeting.media_placement.audio_fallback_url #=> String
resp.meeting.media_placement.screen_data_url #=> String
resp.meeting.media_placement.screen_sharing_url #=> String
resp.meeting.media_placement.screen_viewing_url #=> String
resp.meeting.media_placement.signaling_url #=> String
resp.meeting.media_placement.turn_control_url #=> String
resp.meeting.media_placement.event_ingestion_url #=> String
resp.meeting.media_region #=> 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.**

  • :external_meeting_id (String) —

    The external meeting ID.

  • :meeting_host_id (String) —

    Reserved.

  • :media_region (String) —

    The Region in which to create the meeting. Default: us-east-1.

    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 .

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

    The tag key-value pairs.

  • :notifications_configuration (Types::MeetingNotificationConfiguration) —

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

Returns:

See Also:



1884
1885
1886
1887
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1884

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

#create_meeting_dial_out(params = {}) ⇒ Types::CreateMeetingDialOutResponse

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.

To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

This API is is not available in a dedicated namespace.

Examples:

Request syntax with placeholder values


resp = client.create_meeting_dial_out({
  meeting_id: "GuidString", # required
  from_phone_number: "E164PhoneNumber", # required
  to_phone_number: "E164PhoneNumber", # required
  join_token: "JoinTokenString", # required
})

Response structure


resp.transaction_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :from_phone_number (required, String) —

    Phone number used as the caller ID when the remote party receives a call.

  • :to_phone_number (required, String) —

    Phone number called when inviting someone to a meeting.

  • :join_token (required, String) —

    Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

Returns:

See Also:



1939
1940
1941
1942
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1939

def create_meeting_dial_out(params = {}, options = {})
  req = build_request(:create_meeting_dial_out, 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 SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeetingWithAttendees, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_meeting_with_attendees({
  client_request_token: "ClientRequestToken", # required
  external_meeting_id: "ExternalMeetingIdType",
  meeting_host_id: "ExternalUserIdType",
  media_region: "String",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  notifications_configuration: {
    sns_topic_arn: "Arn",
    sqs_queue_arn: "Arn",
  },
  attendees: [
    {
      external_user_id: "ExternalUserIdType", # required
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
    },
  ],
})

Response structure


resp.meeting.meeting_id #=> String
resp.meeting.external_meeting_id #=> String
resp.meeting.media_placement.audio_host_url #=> String
resp.meeting.media_placement.audio_fallback_url #=> String
resp.meeting.media_placement.screen_data_url #=> String
resp.meeting.media_placement.screen_sharing_url #=> String
resp.meeting.media_placement.screen_viewing_url #=> String
resp.meeting.media_placement.signaling_url #=> String
resp.meeting.media_placement.turn_control_url #=> String
resp.meeting.media_placement.event_ingestion_url #=> String
resp.meeting.media_region #=> 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

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

  • :external_meeting_id (String) —

    The external meeting ID.

  • :meeting_host_id (String) —

    Reserved.

  • :media_region (String) —

    The Region in which to create the meeting. Default: us-east-1 .

    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 .

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

    The tag key-value pairs.

  • :notifications_configuration (Types::MeetingNotificationConfiguration) —

    The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).

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

    The request containing the attendees to create.

Returns:

See Also:



2062
2063
2064
2065
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2062

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

#create_phone_number_order(params = {}) ⇒ Types::CreatePhoneNumberOrderResponse

Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Examples:

Request syntax with placeholder values


resp = client.create_phone_number_order({
  product_type: "BusinessCalling", # required, accepts BusinessCalling, VoiceConnector, SipMediaApplicationDialIn
  e164_phone_numbers: ["E164PhoneNumber"], # required
})

Response structure


resp.phone_number_order.phone_number_order_id #=> String
resp.phone_number_order.product_type #=> String, one of "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number_order.status #=> String, one of "Processing", "Successful", "Failed", "Partial"
resp.phone_number_order.ordered_phone_numbers #=> Array
resp.phone_number_order.ordered_phone_numbers[0].e164_phone_number #=> String
resp.phone_number_order.ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
resp.phone_number_order.created_timestamp #=> Time
resp.phone_number_order.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :product_type (required, String) —

    The phone number product type.

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

    List of phone numbers, in E.164 format.

Returns:

See Also:



2104
2105
2106
2107
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2104

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

#create_proxy_session(params = {}) ⇒ Types::CreateProxySessionResponse

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_proxy_session({
  voice_connector_id: "NonEmptyString128", # required
  participant_phone_numbers: ["E164PhoneNumber"], # required
  name: "ProxySessionNameString",
  expiry_minutes: 1,
  capabilities: ["Voice"], # required, accepts Voice, SMS
  number_selection_behavior: "PreferSticky", # accepts PreferSticky, AvoidSticky
  geo_match_level: "Country", # accepts Country, AreaCode
  geo_match_params: {
    country: "Country", # required
    area_code: "AreaCode", # required
  },
})

Response structure


resp.proxy_session.voice_connector_id #=> String
resp.proxy_session.proxy_session_id #=> String
resp.proxy_session.name #=> String
resp.proxy_session.status #=> String, one of "Open", "InProgress", "Closed"
resp.proxy_session.expiry_minutes #=> Integer
resp.proxy_session.capabilities #=> Array
resp.proxy_session.capabilities[0] #=> String, one of "Voice", "SMS"
resp.proxy_session.created_timestamp #=> Time
resp.proxy_session.updated_timestamp #=> Time
resp.proxy_session.ended_timestamp #=> Time
resp.proxy_session.participants #=> Array
resp.proxy_session.participants[0].phone_number #=> String
resp.proxy_session.participants[0].proxy_phone_number #=> String
resp.proxy_session.number_selection_behavior #=> String, one of "PreferSticky", "AvoidSticky"
resp.proxy_session.geo_match_level #=> String, one of "Country", "AreaCode"
resp.proxy_session.geo_match_params.country #=> String
resp.proxy_session.geo_match_params.area_code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

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

    The participant phone numbers.

  • :name (String) —

    The name of the proxy session.

  • :expiry_minutes (Integer) —

    The number of minutes allowed for the proxy session.

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

    The proxy session capabilities.

  • :number_selection_behavior (String) —

    The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

  • :geo_match_level (String) —

    The preference for matching the country or area code of the proxy phone number with that of the first participant.

  • :geo_match_params (Types::GeoMatchParams) —

    The country and area code for the proxy phone number.

Returns:

See Also:



2195
2196
2197
2198
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2195

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

#create_room(params = {}) ⇒ Types::CreateRoomResponse

Creates a chat room for the specified Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


resp = client.create_room({
  account_id: "NonEmptyString", # required
  name: "SensitiveString", # required
  client_request_token: "ClientRequestToken",
})

Response structure


resp.room.room_id #=> String
resp.room.name #=> String
resp.room. #=> String
resp.room.created_by #=> String
resp.room.created_timestamp #=> Time
resp.room.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :name (required, String) —

    The room name.

  • :client_request_token (String) —

    The idempotency token for the request.

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

Returns:

See Also:



2239
2240
2241
2242
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2239

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

#create_room_membership(params = {}) ⇒ Types::CreateRoomMembershipResponse

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

Examples:

Request syntax with placeholder values


resp = client.create_room_membership({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
  member_id: "NonEmptyString", # required
  role: "Administrator", # accepts Administrator, Member
})

Response structure


resp.room_membership.room_id #=> String
resp.room_membership.member.member_id #=> String
resp.room_membership.member.member_type #=> String, one of "User", "Bot", "Webhook"
resp.room_membership.member.email #=> String
resp.room_membership.member.full_name #=> String
resp.room_membership.member. #=> String
resp.room_membership.role #=> String, one of "Administrator", "Member"
resp.room_membership.invited_by #=> String
resp.room_membership.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

  • :member_id (required, String) —

    The Amazon Chime member ID (user ID or bot ID).

  • :role (String) —

    The role of the member.

Returns:

See Also:



2290
2291
2292
2293
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2290

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

#create_sip_media_application(params = {}) ⇒ Types::CreateSipMediaApplicationResponse

Creates a SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_sip_media_application({
  aws_region: "String", # required
  name: "SipMediaApplicationName", # required
  endpoints: [ # required
    {
      lambda_arn: "FunctionArn",
    },
  ],
})

Response structure


resp.sip_media_application.sip_media_application_id #=> String
resp.sip_media_application.aws_region #=> String
resp.sip_media_application.name #=> String
resp.sip_media_application.endpoints #=> Array
resp.sip_media_application.endpoints[0].lambda_arn #=> String
resp.sip_media_application.created_timestamp #=> Time
resp.sip_media_application.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :aws_region (required, String) —

    The AWS Region assigned to the SIP media application.

  • :name (required, String) —

    The SIP media application name.

  • :endpoints (required, Array<Types::SipMediaApplicationEndpoint>) —

    List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.

Returns:

See Also:



2350
2351
2352
2353
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2350

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

#create_sip_media_application_call(params = {}) ⇒ Types::CreateSipMediaApplicationCallResponse

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_sip_media_application_call({
  from_phone_number: "E164PhoneNumber", # required
  to_phone_number: "E164PhoneNumber", # required
  sip_media_application_id: "NonEmptyString", # required
  sip_headers: {
    "SensitiveString" => "SensitiveString",
  },
})

Response structure


resp.sip_media_application_call.transaction_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :from_phone_number (required, String) —

    The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.

  • :to_phone_number (required, String) —

    The phone number that the service should call.

  • :sip_media_application_id (required, String) —

    The ID of the SIP media application.

  • :sip_headers (Hash<String,String>) —

    The SIP headers added to an outbound call leg.

Returns:

See Also:



2408
2409
2410
2411
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2408

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

#create_sip_rule(params = {}) ⇒ Types::CreateSipRuleResponse

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_sip_rule({
  name: "SipRuleName", # required
  trigger_type: "ToPhoneNumber", # required, accepts ToPhoneNumber, RequestUriHostname
  trigger_value: "NonEmptyString", # required
  disabled: false,
  target_applications: [ # required
    {
      sip_media_application_id: "NonEmptyString",
      priority: 1,
      aws_region: "String",
    },
  ],
})

Response structure


resp.sip_rule.sip_rule_id #=> String
resp.sip_rule.name #=> String
resp.sip_rule.disabled #=> Boolean
resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
resp.sip_rule.trigger_value #=> String
resp.sip_rule.target_applications #=> Array
resp.sip_rule.target_applications[0].sip_media_application_id #=> String
resp.sip_rule.target_applications[0].priority #=> Integer
resp.sip_rule.target_applications[0].aws_region #=> String
resp.sip_rule.created_timestamp #=> Time
resp.sip_rule.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the SIP rule.

  • :trigger_type (required, String) —

    The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

  • :trigger_value (required, String) —

    If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

  • :disabled (Boolean) —

    Enables or disables a rule. You must disable rules before you can delete them.

  • :target_applications (required, Array<Types::SipRuleTargetApplication>) —

    List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.

Returns:

See Also:



2491
2492
2493
2494
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2491

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

#create_user(params = {}) ⇒ Types::CreateUserResponse

Creates a user under the specified Amazon Chime account.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  account_id: "NonEmptyString", # required
  username: "String",
  email: "EmailAddress",
  user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
})

Response structure


resp.user.user_id #=> String
resp.user. #=> String
resp.user.primary_email #=> String
resp.user.primary_provisioned_number #=> String
resp.user.display_name #=> String
resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.user.user_type #=> String, one of "PrivateUser", "SharedDevice"
resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
resp.user.registered_on #=> Time
resp.user.invited_on #=> Time
resp.user.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :username (String) —

    The user name.

  • :email (String) —

    The user's email address.

  • :user_type (String) —

    The user type.

Returns:

See Also:



2544
2545
2546
2547
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2544

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

#create_voice_connector(params = {}) ⇒ Types::CreateVoiceConnectorResponse

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_voice_connector({
  name: "VoiceConnectorName", # required
  aws_region: "us-east-1", # accepts us-east-1, us-west-2
  require_encryption: false, # required
})

Response structure


resp.voice_connector.voice_connector_id #=> String
resp.voice_connector.aws_region #=> String, one of "us-east-1", "us-west-2"
resp.voice_connector.name #=> String
resp.voice_connector.outbound_host_name #=> String
resp.voice_connector.require_encryption #=> Boolean
resp.voice_connector.created_timestamp #=> Time
resp.voice_connector.updated_timestamp #=> Time
resp.voice_connector.voice_connector_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Amazon Chime Voice Connector.

  • :aws_region (String) —

    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .

  • :require_encryption (required, Boolean) —

    When enabled, requires encryption for the Amazon Chime Voice Connector.

Returns:

See Also:



2609
2610
2611
2612
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2609

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

#create_voice_connector_group(params = {}) ⇒ Types::CreateVoiceConnectorGroupResponse

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_voice_connector_group({
  name: "VoiceConnectorGroupName", # required
  voice_connector_items: [
    {
      voice_connector_id: "NonEmptyString", # required
      priority: 1, # required
    },
  ],
})

Response structure


resp.voice_connector_group.voice_connector_group_id #=> String
resp.voice_connector_group.name #=> String
resp.voice_connector_group.voice_connector_items #=> Array
resp.voice_connector_group.voice_connector_items[0].voice_connector_id #=> String
resp.voice_connector_group.voice_connector_items[0].priority #=> Integer
resp.voice_connector_group.created_timestamp #=> Time
resp.voice_connector_group.updated_timestamp #=> Time
resp.voice_connector_group.voice_connector_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Amazon Chime Voice Connector group.

  • :voice_connector_items (Array<Types::VoiceConnectorItem>) —

    The Amazon Chime Voice Connectors to route inbound calls to.

Returns:

See Also:



2673
2674
2675
2676
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2673

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

#delete_account(params = {}) ⇒ Struct

Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo.

For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2708
2709
2710
2711
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2708

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

#delete_app_instance(params = {}) ⇒ Struct

Deletes an AppInstance and all associated data asynchronously.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_app_instance({
  app_instance_arn: "ChimeArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2743
2744
2745
2746
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2743

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

#delete_app_instance_admin(params = {}) ⇒ Struct

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceAdmin, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_app_instance_admin({
  app_instance_admin_arn: "ChimeArn", # required
  app_instance_arn: "ChimeArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_admin_arn (required, String) —

    The ARN of the AppInstance's administrator.

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2783
2784
2785
2786
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2783

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

#delete_app_instance_streaming_configurations(params = {}) ⇒ Struct

Deletes the streaming configurations of an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_app_instance_streaming_configurations({
  app_instance_arn: "ChimeArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the streaming configurations being deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2819
2820
2821
2822
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2819

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

#delete_app_instance_user(params = {}) ⇒ Struct

Deletes an AppInstanceUser.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_app_instance_user({
  app_instance_user_arn: "ChimeArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_user_arn (required, String) —

    The ARN of the user request being deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2854
2855
2856
2857
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2854

def delete_app_instance_user(params = {}, options = {})
  req = build_request(:delete_app_instance_user, 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 SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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:



2898
2899
2900
2901
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2898

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

#delete_channel(params = {}) ⇒ Struct

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_channel({
  channel_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel being deleted.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2944
2945
2946
2947
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2944

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

#delete_channel_ban(params = {}) ⇒ Struct

Removes a user from a channel's ban list.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_channel_ban({
  channel_arn: "ChimeArn", # required
  member_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel from which the AppInstanceUser was banned.

  • :member_arn (required, String) —

    The ARN of the AppInstanceUser that you want to reinstate.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2993
2994
2995
2996
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2993

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

#delete_channel_membership(params = {}) ⇒ Struct

Removes a member from a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_channel_membership({
  channel_arn: "ChimeArn", # required
  member_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel from which you want to remove the user.

  • :member_arn (required, String) —

    The ARN of the member that you're removing from the channel.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3042
3043
3044
3045
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3042

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

#delete_channel_message(params = {}) ⇒ Struct

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_channel_message({
  channel_arn: "ChimeArn", # required
  message_id: "MessageId", # required
  chime_bearer: "ChimeArn",
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :message_id (required, String) —

    The ID of the message being deleted.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3093
3094
3095
3096
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3093

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

#delete_channel_moderator(params = {}) ⇒ Struct

Deletes a channel moderator.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelModerator, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_channel_moderator({
  channel_arn: "ChimeArn", # required
  channel_moderator_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :channel_moderator_arn (required, String) —

    The ARN of the moderator being deleted.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3142
3143
3144
3145
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3142

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

#delete_events_configuration(params = {}) ⇒ Struct

Deletes the events configuration that allows a bot to receive outgoing events.

Examples:

Request syntax with placeholder values


resp = client.delete_events_configuration({
  account_id: "NonEmptyString", # required
  bot_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :bot_id (required, String) —

    The bot ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3169
3170
3171
3172
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3169

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

#delete_media_capture_pipeline(params = {}) ⇒ Struct

Deletes the media capture pipeline.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_media_capture_pipeline({
  media_pipeline_id: "GuidString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :media_pipeline_id (required, String) —

    The ID of the media capture pipeline being deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3204
3205
3206
3207
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3204

def delete_media_capture_pipeline(params = {}, options = {})
  req = build_request(:delete_media_capture_pipeline, 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 SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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:



3244
3245
3246
3247
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3244

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

#delete_phone_number(params = {}) ⇒ Struct

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Examples:

Request syntax with placeholder values


resp = client.delete_phone_number({
  phone_number_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3271
3272
3273
3274
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3271

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

#delete_proxy_session(params = {}) ⇒ Struct

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_proxy_session({
  voice_connector_id: "NonEmptyString128", # required
  proxy_session_id: "NonEmptyString128", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

  • :proxy_session_id (required, String) —

    The proxy session ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3311
3312
3313
3314
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3311

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

#delete_room(params = {}) ⇒ Struct

Deletes a chat room in an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


resp = client.delete_room({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The chat room ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3337
3338
3339
3340
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3337

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

#delete_room_membership(params = {}) ⇒ Struct

Removes a member from a chat room in an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


resp = client.delete_room_membership({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
  member_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

  • :member_id (required, String) —

    The member ID (user ID or bot ID).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3368
3369
3370
3371
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3368

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

#delete_sip_media_application(params = {}) ⇒ Struct

Deletes a SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_sip_media_application({
  sip_media_application_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3403
3404
3405
3406
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3403

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

#delete_sip_rule(params = {}) ⇒ Struct

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_sip_rule({
  sip_rule_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :sip_rule_id (required, String) —

    The SIP rule ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3439
3440
3441
3442
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3439

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

#delete_voice_connector(params = {}) ⇒ Struct

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_connector({
  voice_connector_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3476
3477
3478
3479
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3476

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

#delete_voice_connector_emergency_calling_configuration(params = {}) ⇒ Struct

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_connector_emergency_calling_configuration({
  voice_connector_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3513
3514
3515
3516
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3513

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

#delete_voice_connector_group(params = {}) ⇒ Struct

Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_connector_group({
  voice_connector_group_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Amazon Chime Voice Connector group ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3550
3551
3552
3553
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3550

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

#delete_voice_connector_origination(params = {}) ⇒ Struct

Deletes the origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_connector_origination({
  voice_connector_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3592
3593
3594
3595
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3592

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

#delete_voice_connector_proxy(params = {}) ⇒ Struct

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceProxy, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_connector_proxy({
  voice_connector_id: "NonEmptyString128", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3628
3629
3630
3631
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3628

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

#delete_voice_connector_streaming_configuration(params = {}) ⇒ Struct

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_connector_streaming_configuration({
  voice_connector_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3665
3666
3667
3668
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3665

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

#delete_voice_connector_termination(params = {}) ⇒ Struct

Deletes the termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTermination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_connector_termination({
  voice_connector_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3707
3708
3709
3710
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3707

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

#delete_voice_connector_termination_credentials(params = {}) ⇒ Struct

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_connector_termination_credentials({
  voice_connector_id: "NonEmptyString", # required
  usernames: ["SensitiveString"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

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

    The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3749
3750
3751
3752
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3749

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

#describe_app_instance(params = {}) ⇒ Types::DescribeAppInstanceResponse

Returns the full details of an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_app_instance({
  app_instance_arn: "ChimeArn", # required
})

Response structure


resp.app_instance.app_instance_arn #=> String
resp.app_instance.name #=> String
resp.app_instance.metadata #=> String
resp.app_instance.created_timestamp #=> Time
resp.app_instance.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



3794
3795
3796
3797
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3794

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

#describe_app_instance_admin(params = {}) ⇒ Types::DescribeAppInstanceAdminResponse

Returns the full details of an AppInstanceAdmin.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceAdmin, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_app_instance_admin({
  app_instance_admin_arn: "ChimeArn", # required
  app_instance_arn: "ChimeArn", # required
})

Response structure


resp.app_instance_admin.admin.arn #=> String
resp.app_instance_admin.admin.name #=> String
resp.app_instance_admin.app_instance_arn #=> String
resp.app_instance_admin.created_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_admin_arn (required, String) —

    The ARN of the AppInstanceAdmin.

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



3842
3843
3844
3845
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3842

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

#describe_app_instance_user(params = {}) ⇒ Types::DescribeAppInstanceUserResponse

Returns the full details of an AppInstanceUser.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_app_instance_user({
  app_instance_user_arn: "ChimeArn", # required
})

Response structure


resp.app_instance_user.app_instance_user_arn #=> String
resp.app_instance_user.name #=> String
resp.app_instance_user.created_timestamp #=> Time
resp.app_instance_user.metadata #=> String
resp.app_instance_user.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_user_arn (required, String) —

    The ARN of the AppInstanceUser.

Returns:

See Also:



3887
3888
3889
3890
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3887

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

#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse

Returns the full details of a channel in an Amazon Chime AppInstance.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_channel({
  channel_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel.name #=> String
resp.channel.channel_arn #=> String
resp.channel.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
resp.channel.privacy #=> String, one of "PUBLIC", "PRIVATE"
resp.channel.metadata #=> String
resp.channel.created_by.arn #=> String
resp.channel.created_by.name #=> String
resp.channel.created_timestamp #=> Time
resp.channel.last_message_timestamp #=> Time
resp.channel.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



3948
3949
3950
3951
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3948

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

#describe_channel_ban(params = {}) ⇒ Types::DescribeChannelBanResponse

Returns the full details of a channel ban.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_channel_ban({
  channel_arn: "ChimeArn", # required
  member_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_ban.member.arn #=> String
resp.channel_ban.member.name #=> String
resp.channel_ban.channel_arn #=> String
resp.channel_ban.created_timestamp #=> Time
resp.channel_ban.created_by.arn #=> String
resp.channel_ban.created_by.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel from which the user is banned.

  • :member_arn (required, String) —

    The ARN of the member being banned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



4008
4009
4010
4011
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4008

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

#describe_channel_membership(params = {}) ⇒ Types::DescribeChannelMembershipResponse

Returns the full details of a user's channel membership.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_channel_membership({
  channel_arn: "ChimeArn", # required
  member_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_membership.invited_by.arn #=> String
resp.channel_membership.invited_by.name #=> String
resp.channel_membership.type #=> String, one of "DEFAULT", "HIDDEN"
resp.channel_membership.member.arn #=> String
resp.channel_membership.member.name #=> String
resp.channel_membership.channel_arn #=> String
resp.channel_membership.created_timestamp #=> Time
resp.channel_membership.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :member_arn (required, String) —

    The ARN of the member.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



4070
4071
4072
4073
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4070

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

#describe_channel_membership_for_app_instance_user(params = {}) ⇒ Types::DescribeChannelMembershipForAppInstanceUserResponse

Returns the details of a channel based on the membership of the specified AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_channel_membership_for_app_instance_user({
  channel_arn: "ChimeArn", # required
  app_instance_user_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_membership.channel_summary.name #=> String
resp.channel_membership.channel_summary.channel_arn #=> String
resp.channel_membership.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
resp.channel_membership.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
resp.channel_membership.channel_summary.metadata #=> String
resp.channel_membership.channel_summary.last_message_timestamp #=> Time
resp.channel_membership.app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
resp.channel_membership.app_instance_user_membership_summary.read_marker_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel to which the user belongs.

  • :app_instance_user_arn (required, String) —

    The ARN of the user in a channel.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



4134
4135
4136
4137
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4134

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

#describe_channel_moderated_by_app_instance_user(params = {}) ⇒ Types::DescribeChannelModeratedByAppInstanceUserResponse

Returns the full details of a channel moderated by the specified AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_channel_moderated_by_app_instance_user({
  channel_arn: "ChimeArn", # required
  app_instance_user_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel.channel_summary.name #=> String
resp.channel.channel_summary.channel_arn #=> String
resp.channel.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
resp.channel.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
resp.channel.channel_summary.metadata #=> String
resp.channel.channel_summary.last_message_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the moderated channel.

  • :app_instance_user_arn (required, String) —

    The ARN of the AppInstanceUser in the moderated channel.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



4196
4197
4198
4199
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4196

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

#describe_channel_moderator(params = {}) ⇒ Types::DescribeChannelModeratorResponse

Returns the full details of a single ChannelModerator.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_channel_moderator({
  channel_arn: "ChimeArn", # required
  channel_moderator_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_moderator.moderator.arn #=> String
resp.channel_moderator.moderator.name #=> String
resp.channel_moderator.channel_arn #=> String
resp.channel_moderator.created_timestamp #=> Time
resp.channel_moderator.created_by.arn #=> String
resp.channel_moderator.created_by.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :channel_moderator_arn (required, String) —

    The ARN of the channel moderator.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



4256
4257
4258
4259
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4256

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

#disassociate_phone_number_from_user(params = {}) ⇒ Struct

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

Examples:

Request syntax with placeholder values


resp = client.disassociate_phone_number_from_user({
  account_id: "String", # required
  user_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4283
4284
4285
4286
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4283

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

#disassociate_phone_numbers_from_voice_connector(params = {}) ⇒ Types::DisassociatePhoneNumbersFromVoiceConnectorResponse

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.disassociate_phone_numbers_from_voice_connector({
  voice_connector_id: "NonEmptyString", # required
  e164_phone_numbers: ["E164PhoneNumber"], # required
})

Response structure


resp.phone_number_errors #=> Array
resp.phone_number_errors[0].phone_number_id #=> String
resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

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

    List of phone numbers, in E.164 format.

Returns:

See Also:



4333
4334
4335
4336
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4333

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

#disassociate_phone_numbers_from_voice_connector_group(params = {}) ⇒ Types::DisassociatePhoneNumbersFromVoiceConnectorGroupResponse

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.disassociate_phone_numbers_from_voice_connector_group({
  voice_connector_group_id: "NonEmptyString", # required
  e164_phone_numbers: ["E164PhoneNumber"], # required
})

Response structure


resp.phone_number_errors #=> Array
resp.phone_number_errors[0].phone_number_id #=> String
resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Amazon Chime Voice Connector group ID.

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

    List of phone numbers, in E.164 format.

Returns:

See Also:



4383
4384
4385
4386
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4383

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

#disassociate_signin_delegate_groups_from_account(params = {}) ⇒ Struct

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "NonEmptyString", # required
  group_names: ["String"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

    The sign-in delegate group names.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4410
4411
4412
4413
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4410

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

#get_account(params = {}) ⇒ Types::GetAccountResponse

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "NonEmptyString", # required
})

Response structure


resp.. #=> String
resp.. #=> String
resp..name #=> String
resp.. #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
resp..created_timestamp #=> Time
resp..default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp..supported_licenses #=> Array
resp..supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.. #=> String, one of "Suspended", "Active"
resp.. #=> Array
resp..[0].group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

See Also:



4449
4450
4451
4452
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4449

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

#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "NonEmptyString", # required
})

Response structure


resp..disable_remote_control #=> Boolean
resp..enable_dial_out #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

See Also:



4485
4486
4487
4488
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4485

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

#get_app_instance_retention_settings(params = {}) ⇒ Types::GetAppInstanceRetentionSettingsResponse

Gets the retention settings for an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_app_instance_retention_settings({
  app_instance_arn: "ChimeArn", # required
})

Response structure


resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
resp.initiate_deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



4528
4529
4530
4531
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4528

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

#get_app_instance_streaming_configurations(params = {}) ⇒ Types::GetAppInstanceStreamingConfigurationsResponse

Gets the streaming settings for an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_app_instance_streaming_configurations({
  app_instance_arn: "ChimeArn", # required
})

Response structure


resp.app_instance_streaming_configurations #=> Array
resp.app_instance_streaming_configurations[0].app_instance_data_type #=> String, one of "Channel", "ChannelMessage"
resp.app_instance_streaming_configurations[0].resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



4571
4572
4573
4574
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4571

def get_app_instance_streaming_configurations(params = {}, options = {})
  req = build_request(:get_app_instance_streaming_configurations, 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 SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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

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:



4622
4623
4624
4625
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4622

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

#get_bot(params = {}) ⇒ Types::GetBotResponse

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

Examples:

Request syntax with placeholder values


resp = client.get_bot({
  account_id: "NonEmptyString", # required
  bot_id: "NonEmptyString", # required
})

Response structure


resp.bot.bot_id #=> String
resp.bot.user_id #=> String
resp.bot.display_name #=> String
resp.bot.bot_type #=> String, one of "ChatBot"
resp.bot.disabled #=> Boolean
resp.bot.created_timestamp #=> Time
resp.bot.updated_timestamp #=> Time
resp.bot.bot_email #=> String
resp.bot.security_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :bot_id (required, String) —

    The bot ID.

Returns:

See Also:



4663
4664
4665
4666
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4663

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

#get_channel_message(params = {}) ⇒ Types::GetChannelMessageResponse

Gets the full details of a channel message.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_channel_message({
  channel_arn: "ChimeArn", # required
  message_id: "MessageId", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_message.channel_arn #=> String
resp.channel_message.message_id #=> String
resp.channel_message.content #=> String
resp.channel_message.metadata #=> String
resp.channel_message.type #=> String, one of "STANDARD", "CONTROL"
resp.channel_message.created_timestamp #=> Time
resp.channel_message.last_edited_timestamp #=> Time
resp.channel_message.last_updated_timestamp #=> Time
resp.channel_message.sender.arn #=> String
resp.channel_message.sender.name #=> String
resp.channel_message.redacted #=> Boolean
resp.channel_message.persistence #=> String, one of "PERSISTENT", "NON_PERSISTENT"

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :message_id (required, String) —

    The ID of the message.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



4729
4730
4731
4732
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4729

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

#get_events_configuration(params = {}) ⇒ Types::GetEventsConfigurationResponse

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

Examples:

Request syntax with placeholder values


resp = client.get_events_configuration({
  account_id: "NonEmptyString", # required
  bot_id: "NonEmptyString", # required
})

Response structure


resp.events_configuration.bot_id #=> String
resp.events_configuration.outbound_events_https_endpoint #=> String
resp.events_configuration.lambda_function_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :bot_id (required, String) —

    The bot ID.

Returns:

See Also:



4764
4765
4766
4767
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4764

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

#get_global_settings(params = {}) ⇒ Types::GetGlobalSettingsResponse

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Examples:

Response structure


resp.business_calling.cdr_bucket #=> String
resp.voice_connector.cdr_bucket #=> String

Parameters:

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

    ({})

Returns:

See Also:



4787
4788
4789
4790
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4787

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

#get_media_capture_pipeline(params = {}) ⇒ Types::GetMediaCapturePipelineResponse

Gets an existing media capture pipeline.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_media_capture_pipeline({
  media_pipeline_id: "GuidString", # required
})

Response structure


resp.media_capture_pipeline.media_pipeline_id #=> String
resp.media_capture_pipeline.source_type #=> String, one of "ChimeSdkMeeting"
resp.media_capture_pipeline.source_arn #=> String
resp.media_capture_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
resp.media_capture_pipeline.sink_type #=> String, one of "S3Bucket"
resp.media_capture_pipeline.sink_arn #=> String
resp.media_capture_pipeline.created_timestamp #=> Time
resp.media_capture_pipeline.updated_timestamp #=> Time
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"

Parameters:

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

    ({})

Options Hash (params):

  • :media_pipeline_id (required, String) —

    The ID of the pipeline that you want to get.

Returns:

See Also:



4844
4845
4846
4847
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4844

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

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

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

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 SDK 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.external_meeting_id #=> String
resp.meeting.media_placement.audio_host_url #=> String
resp.meeting.media_placement.audio_fallback_url #=> String
resp.meeting.media_placement.screen_data_url #=> String
resp.meeting.media_placement.screen_sharing_url #=> String
resp.meeting.media_placement.screen_viewing_url #=> String
resp.meeting.media_placement.signaling_url #=> String
resp.meeting.media_placement.turn_control_url #=> String
resp.meeting.media_placement.event_ingestion_url #=> String
resp.meeting.media_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

Returns:

See Also:



4898
4899
4900
4901
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4898

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

#get_messaging_session_endpoint(params = {}) ⇒ Types::GetMessagingSessionEndpointResponse

The details of the endpoint for the messaging session.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingSessionEndpoint, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Response structure


resp.endpoint.url #=> String

Parameters:

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

    ({})

Returns:

See Also:



4930
4931
4932
4933
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4930

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

#get_phone_number(params = {}) ⇒ Types::GetPhoneNumberResponse

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Examples:

Request syntax with placeholder values


resp = client.get_phone_number({
  phone_number_id: "String", # required
})

Response structure


resp.phone_number.phone_number_id #=> String
resp.phone_number.e164_phone_number #=> String
resp.phone_number.country #=> String
resp.phone_number.type #=> String, one of "Local", "TollFree"
resp.phone_number.product_type #=> String, one of "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number.status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
resp.phone_number.capabilities.inbound_call #=> Boolean
resp.phone_number.capabilities.outbound_call #=> Boolean
resp.phone_number.capabilities.inbound_sms #=> Boolean
resp.phone_number.capabilities.outbound_sms #=> Boolean
resp.phone_number.capabilities.inbound_mms #=> Boolean
resp.phone_number.capabilities.outbound_mms #=> Boolean
resp.phone_number.associations #=> Array
resp.phone_number.associations[0].value #=> String
resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
resp.phone_number.associations[0].associated_timestamp #=> Time
resp.phone_number.calling_name #=> String
resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
resp.phone_number.created_timestamp #=> Time
resp.phone_number.updated_timestamp #=> Time
resp.phone_number.deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number ID.

Returns:

See Also:



4979
4980
4981
4982
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4979

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

#get_phone_number_order(params = {}) ⇒ Types::GetPhoneNumberOrderResponse

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

Examples:

Request syntax with placeholder values


resp = client.get_phone_number_order({
  phone_number_order_id: "GuidString", # required
})

Response structure


resp.phone_number_order.phone_number_order_id #=> String
resp.phone_number_order.product_type #=> String, one of "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number_order.status #=> String, one of "Processing", "Successful", "Failed", "Partial"
resp.phone_number_order.ordered_phone_numbers #=> Array
resp.phone_number_order.ordered_phone_numbers[0].e164_phone_number #=> String
resp.phone_number_order.ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
resp.phone_number_order.created_timestamp #=> Time
resp.phone_number_order.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_order_id (required, String) —

    The ID for the phone number order.

Returns:

See Also:



5016
5017
5018
5019
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5016

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

#get_phone_number_settings(params = {}) ⇒ Types::GetPhoneNumberSettingsResponse

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Examples:

Response structure


resp.calling_name #=> String
resp.calling_name_updated_timestamp #=> Time

Parameters:

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

    ({})

Returns:

See Also:



5038
5039
5040
5041
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5038

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

#get_proxy_session(params = {}) ⇒ Types::GetProxySessionResponse

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_proxy_session({
  voice_connector_id: "NonEmptyString128", # required
  proxy_session_id: "NonEmptyString128", # required
})

Response structure


resp.proxy_session.voice_connector_id #=> String
resp.proxy_session.proxy_session_id #=> String
resp.proxy_session.name #=> String
resp.proxy_session.status #=> String, one of "Open", "InProgress", "Closed"
resp.proxy_session.expiry_minutes #=> Integer
resp.proxy_session.capabilities #=> Array
resp.proxy_session.capabilities[0] #=> String, one of "Voice", "SMS"
resp.proxy_session.created_timestamp #=> Time
resp.proxy_session.updated_timestamp #=> Time
resp.proxy_session.ended_timestamp #=> Time
resp.proxy_session.participants #=> Array
resp.proxy_session.participants[0].phone_number #=> String
resp.proxy_session.participants[0].proxy_phone_number #=> String
resp.proxy_session.number_selection_behavior #=> String, one of "PreferSticky", "AvoidSticky"
resp.proxy_session.geo_match_level #=> String, one of "Country", "AreaCode"
resp.proxy_session.geo_match_params.country #=> String
resp.proxy_session.geo_match_params.area_code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

  • :proxy_session_id (required, String) —

    The proxy session ID.

Returns:

See Also:



5100
5101
5102
5103
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5100

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

#get_retention_settings(params = {}) ⇒ Types::GetRetentionSettingsResponse

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Examples:

Request syntax with placeholder values


resp = client.get_retention_settings({
  account_id: "NonEmptyString", # required
})

Response structure


resp.retention_settings.room_retention_settings.retention_days #=> Integer
resp.retention_settings.conversation_retention_settings.retention_days #=> Integer
resp.initiate_deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

See Also:



5138
5139
5140
5141
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5138

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

#get_room(params = {}) ⇒ Types::GetRoomResponse

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


resp = client.get_room({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
})

Response structure


resp.room.room_id #=> String
resp.room.name #=> String
resp.room. #=> String
resp.room.created_by #=> String
resp.room.created_timestamp #=> Time
resp.room.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

Returns:

See Also:



5176
5177
5178
5179
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5176

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

#get_sip_media_application(params = {}) ⇒ Types::GetSipMediaApplicationResponse

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_sip_media_application({
  sip_media_application_id: "NonEmptyString", # required
})

Response structure


resp.sip_media_application.sip_media_application_id #=> String
resp.sip_media_application.aws_region #=> String
resp.sip_media_application.name #=> String
resp.sip_media_application.endpoints #=> Array
resp.sip_media_application.endpoints[0].lambda_arn #=> String
resp.sip_media_application.created_timestamp #=> Time
resp.sip_media_application.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

Returns:

See Also:



5224
5225
5226
5227
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5224

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

#get_sip_media_application_logging_configuration(params = {}) ⇒ Types::GetSipMediaApplicationLoggingConfigurationResponse

Returns the logging configuration for the specified SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_sip_media_application_logging_configuration({
  sip_media_application_id: "NonEmptyString", # required
})

Response structure


resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

Returns:

See Also:



5267
5268
5269
5270
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5267

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

#get_sip_rule(params = {}) ⇒ Types::GetSipRuleResponse

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_sip_rule({
  sip_rule_id: "NonEmptyString", # required
})

Response structure


resp.sip_rule.sip_rule_id #=> String
resp.sip_rule.name #=> String
resp.sip_rule.disabled #=> Boolean
resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
resp.sip_rule.trigger_value #=> String
resp.sip_rule.target_applications #=> Array
resp.sip_rule.target_applications[0].sip_media_application_id #=> String
resp.sip_rule.target_applications[0].priority #=> Integer
resp.sip_rule.target_applications[0].aws_region #=> String
resp.sip_rule.created_timestamp #=> Time
resp.sip_rule.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :sip_rule_id (required, String) —

    The SIP rule ID.

Returns:

See Also:



5319
5320
5321
5322
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5319

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

#get_user(params = {}) ⇒ Types::GetUserResponse

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

Examples:

Request syntax with placeholder values


resp = client.get_user({
  account_id: "NonEmptyString", # required
  user_id: "NonEmptyString", # required
})

Response structure


resp.user.user_id #=> String
resp.user. #=> String
resp.user.primary_email #=> String
resp.user.primary_provisioned_number #=> String
resp.user.display_name #=> String
resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.user.user_type #=> String, one of "PrivateUser", "SharedDevice"
resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
resp.user.registered_on #=> Time
resp.user.invited_on #=> Time
resp.user.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

Returns:

See Also:



5368
5369
5370
5371
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5368

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

#get_user_settings(params = {}) ⇒ Types::GetUserSettingsResponse

Retrieves settings for the specified user ID, such as any associated phone number settings.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "String", # required
  user_id: "String", # required
})

Response structure


resp..telephony.inbound_calling #=> Boolean
resp..telephony.outbound_calling #=> Boolean
resp..telephony.sms #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

Returns:

See Also:



5403
5404
5405
5406
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5403

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

#get_voice_connector(params = {}) ⇒ Types::GetVoiceConnectorResponse

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_voice_connector({
  voice_connector_id: "NonEmptyString", # required
})

Response structure


resp.voice_connector.voice_connector_id #=> String
resp.voice_connector.aws_region #=> String, one of "us-east-1", "us-west-2"
resp.voice_connector.name #=> String
resp.voice_connector.outbound_host_name #=> String
resp.voice_connector.require_encryption #=> Boolean
resp.voice_connector.created_timestamp #=> Time
resp.voice_connector.updated_timestamp #=> Time
resp.voice_connector.voice_connector_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



5452
5453
5454
5455
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5452

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

#get_voice_connector_emergency_calling_configuration(params = {}) ⇒ Types::GetVoiceConnectorEmergencyCallingConfigurationResponse

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_voice_connector_emergency_calling_configuration({
  voice_connector_id: "NonEmptyString", # required
})

Response structure


resp.emergency_calling_configuration.dnis #=> Array
resp.emergency_calling_configuration.dnis[0].emergency_phone_number #=> String
resp.emergency_calling_configuration.dnis[0].test_phone_number #=> String
resp.emergency_calling_configuration.dnis[0].calling_country #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



5498
5499
5500
5501
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5498

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

#get_voice_connector_group(params = {}) ⇒ Types::GetVoiceConnectorGroupResponse

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_voice_connector_group({
  voice_connector_group_id: "NonEmptyString", # required
})

Response structure


resp.voice_connector_group.voice_connector_group_id #=> String
resp.voice_connector_group.name #=> String
resp.voice_connector_group.voice_connector_items #=> Array
resp.voice_connector_group.voice_connector_items[0].voice_connector_id #=> String
resp.voice_connector_group.voice_connector_items[0].priority #=> Integer
resp.voice_connector_group.created_timestamp #=> Time
resp.voice_connector_group.updated_timestamp #=> Time
resp.voice_connector_group.voice_connector_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Amazon Chime Voice Connector group ID.

Returns:

See Also:



5547
5548
5549
5550
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5547

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

#get_voice_connector_logging_configuration(params = {}) ⇒ Types::GetVoiceConnectorLoggingConfigurationResponse

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_voice_connector_logging_configuration({
  voice_connector_id: "NonEmptyString", # required
})

Response structure


resp.logging_configuration.enable_sip_logs #=> Boolean
resp.logging_configuration.enable_media_metric_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



5591
5592
5593
5594
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5591

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

#get_voice_connector_origination(params = {}) ⇒ Types::GetVoiceConnectorOriginationResponse

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_voice_connector_origination({
  voice_connector_id: "NonEmptyString", # required
})

Response structure


resp.origination.routes #=> Array
resp.origination.routes[0].host #=> String
resp.origination.routes[0].port #=> Integer
resp.origination.routes[0].protocol #=> String, one of "TCP", "UDP"
resp.origination.routes[0].priority #=> Integer
resp.origination.routes[0].weight #=> Integer
resp.origination.disabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



5639
5640
5641
5642
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5639

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

#get_voice_connector_proxy(params = {}) ⇒ Types::GetVoiceConnectorProxyResponse

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorProxy, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_voice_connector_proxy({
  voice_connector_id: "NonEmptyString128", # required
})

Response structure


resp.proxy.default_session_expiry_minutes #=> Integer
resp.proxy.disabled #=> Boolean
resp.proxy.fall_back_phone_number #=> String
resp.proxy.phone_number_countries #=> Array
resp.proxy.phone_number_countries[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

Returns:

See Also:



5685
5686
5687
5688
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5685

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

#get_voice_connector_streaming_configuration(params = {}) ⇒ Types::GetVoiceConnectorStreamingConfigurationResponse

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_voice_connector_streaming_configuration({
  voice_connector_id: "NonEmptyString", # required
})

Response structure


resp.streaming_configuration.data_retention_in_hours #=> Integer
resp.streaming_configuration.disabled #=> Boolean
resp.streaming_configuration.streaming_notification_targets #=> Array
resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



5732
5733
5734
5735
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5732

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

#get_voice_connector_termination(params = {}) ⇒ Types::GetVoiceConnectorTerminationResponse

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTermination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_voice_connector_termination({
  voice_connector_id: "NonEmptyString", # required
})

Response structure


resp.termination.cps_limit #=> Integer
resp.termination.default_phone_number #=> String
resp.termination.calling_regions #=> Array
resp.termination.calling_regions[0] #=> String
resp.termination.cidr_allowed_list #=> Array
resp.termination.cidr_allowed_list[0] #=> String
resp.termination.disabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



5780
5781
5782
5783
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5780

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

#get_voice_connector_termination_health(params = {}) ⇒ Types::GetVoiceConnectorTerminationHealthResponse

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

Examples:

Request syntax with placeholder values


resp = client.get_voice_connector_termination_health({
  voice_connector_id: "NonEmptyString", # required
})

Response structure


resp.termination_health.timestamp #=> Time
resp.termination_health.source #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



5824
5825
5826
5827
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5824

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

#invite_users(params = {}) ⇒ Types::InviteUsersResponse

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

Examples:

Request syntax with placeholder values


resp = client.invite_users({
  account_id: "NonEmptyString", # required
  user_email_list: ["EmailAddress"], # required
  user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
})

Response structure


resp.invites #=> Array
resp.invites[0].invite_id #=> String
resp.invites[0].status #=> String, one of "Pending", "Accepted", "Failed"
resp.invites[0].email_address #=> String
resp.invites[0].email_status #=> String, one of "NotSent", "Sent", "Failed"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

    The user email addresses to which to send the email invitation.

  • :user_type (String) —

    The user type.

Returns:

See Also:



5866
5867
5868
5869
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5866

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

#list_accounts(params = {}) ⇒ Types::ListAccountsResponse

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

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_accounts({
  name: "AccountName",
  user_email: "EmailAddress",
  next_token: "String",
  max_results: 1,
})

Response structure


resp.accounts #=> Array
resp.accounts[0]. #=> String
resp.accounts[0]. #=> String
resp.accounts[0].name #=> String
resp.accounts[0]. #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
resp.accounts[0].created_timestamp #=> Time
resp.accounts[0].default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.accounts[0].supported_licenses #=> Array
resp.accounts[0].supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.accounts[0]. #=> String, one of "Suspended", "Active"
resp.accounts[0]. #=> Array
resp.accounts[0].[0].group_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    Amazon Chime account name prefix with which to filter results.

  • :user_email (String) —

    User email address with which to filter results.

  • :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. Defaults to 100.

Returns:

See Also:



5925
5926
5927
5928
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5925

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

#list_app_instance_admins(params = {}) ⇒ Types::ListAppInstanceAdminsResponse

Returns a list of the administrators in the AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceAdmins, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_app_instance_admins({
  app_instance_arn: "ChimeArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.app_instance_arn #=> String
resp.app_instance_admins #=> Array
resp.app_instance_admins[0].admin.arn #=> String
resp.app_instance_admins[0].admin.name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

  • :max_results (Integer) —

    The maximum number of administrators that you want to return.

  • :next_token (String) —

    The token returned from previous API requests until the number of administrators is reached.

Returns:

See Also:



5983
5984
5985
5986
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5983

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

#list_app_instance_users(params = {}) ⇒ Types::ListAppInstanceUsersResponse

List all AppInstanceUsers created under a single AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceUsers, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_app_instance_users({
  app_instance_arn: "ChimeArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.app_instance_arn #=> String
resp.app_instance_users #=> Array
resp.app_instance_users[0].app_instance_user_arn #=> String
resp.app_instance_users[0].name #=> String
resp.app_instance_users[0].metadata #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

  • :max_results (Integer) —

    The maximum number of requests that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested users are returned.

Returns:

See Also:



6042
6043
6044
6045
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6042

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

#list_app_instances(params = {}) ⇒ Types::ListAppInstancesResponse

Lists all Amazon Chime AppInstances created under a single AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_app_instances({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.app_instances #=> Array
resp.app_instances[0].app_instance_arn #=> String
resp.app_instances[0].name #=> String
resp.app_instances[0].metadata #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of AppInstances that you want to return.

  • :next_token (String) —

    The token passed by previous API requests until you reach the maximum number of AppInstances.

Returns:

See Also:



6096
6097
6098
6099
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6096

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

#list_attendee_tags(params = {}) ⇒ Types::ListAttendeeTagsResponse

Lists the tags applied to an Amazon Chime SDK attendee resource.

ListAttendeeTags is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

Examples:

Request syntax with placeholder values


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

Response structure


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

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:



6133
6134
6135
6136
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6133

def list_attendee_tags(params = {}, options = {})
  req = build_request(:list_attendee_tags, 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 SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAttendees, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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.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:



6192
6193
6194
6195
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6192

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

#list_bots(params = {}) ⇒ Types::ListBotsResponse

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

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_bots({
  account_id: "NonEmptyString", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.bots #=> Array
resp.bots[0].bot_id #=> String
resp.bots[0].user_id #=> String
resp.bots[0].display_name #=> String
resp.bots[0].bot_type #=> String, one of "ChatBot"
resp.bots[0].disabled #=> Boolean
resp.bots[0].created_timestamp #=> Time
resp.bots[0].updated_timestamp #=> Time
resp.bots[0].bot_email #=> String
resp.bots[0].security_token #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



6243
6244
6245
6246
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6243

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

#list_channel_bans(params = {}) ⇒ Types::ListChannelBansResponse

Lists all the users banned from a particular channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_channel_bans({
  channel_arn: "ChimeArn", # required
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.next_token #=> String
resp.channel_bans #=> Array
resp.channel_bans[0].member.arn #=> String
resp.channel_bans[0].member.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :max_results (Integer) —

    The maximum number of bans that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested bans are returned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



6311
6312
6313
6314
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6311

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

#list_channel_memberships(params = {}) ⇒ Types::ListChannelMembershipsResponse

Lists all channel memberships in a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMemberships, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_channel_memberships({
  channel_arn: "ChimeArn", # required
  type: "DEFAULT", # accepts DEFAULT, HIDDEN
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.channel_memberships #=> Array
resp.channel_memberships[0].member.arn #=> String
resp.channel_memberships[0].member.name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The maximum number of channel memberships that you want returned.

  • :type (String) —

    The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.

  • :max_results (Integer) —

    The maximum number of channel memberships that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested channel memberships are returned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



6387
6388
6389
6390
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6387

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

#list_channel_memberships_for_app_instance_user(params = {}) ⇒ Types::ListChannelMembershipsForAppInstanceUserResponse

Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_channel_memberships_for_app_instance_user({
  app_instance_user_arn: "ChimeArn",
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_memberships #=> Array
resp.channel_memberships[0].channel_summary.name #=> String
resp.channel_memberships[0].channel_summary.channel_arn #=> String
resp.channel_memberships[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
resp.channel_memberships[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
resp.channel_memberships[0].channel_summary.metadata #=> String
resp.channel_memberships[0].channel_summary.last_message_timestamp #=> Time
resp.channel_memberships[0].app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
resp.channel_memberships[0].app_instance_user_membership_summary.read_marker_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_user_arn (String) —

    The ARN of the AppInstanceUsers

  • :max_results (Integer) —

    The maximum number of users that you want returned.

  • :next_token (String) —

    The token returned from previous API requests until the number of channel memberships is reached.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



6462
6463
6464
6465
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6462

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

#list_channel_messages(params = {}) ⇒ Types::ListChannelMessagesResponse

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_channel_messages({
  channel_arn: "ChimeArn", # required
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  not_before: Time.now,
  not_after: Time.now,
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.next_token #=> String
resp.channel_messages #=> Array
resp.channel_messages[0].message_id #=> String
resp.channel_messages[0].content #=> String
resp.channel_messages[0].metadata #=> String
resp.channel_messages[0].type #=> String, one of "STANDARD", "CONTROL"
resp.channel_messages[0].created_timestamp #=> Time
resp.channel_messages[0].last_updated_timestamp #=> Time
resp.channel_messages[0].last_edited_timestamp #=> Time
resp.channel_messages[0].sender.arn #=> String
resp.channel_messages[0].sender.name #=> String
resp.channel_messages[0].redacted #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :sort_order (String) —

    The order in which you want messages sorted. Default is Descending, based on time created.

  • :not_before (Time, DateTime, Date, Integer, String) —

    The initial or starting time stamp for your requested messages.

  • :not_after (Time, DateTime, Date, Integer, String) —

    The final or ending time stamp for your requested messages.

  • :max_results (Integer) —

    The maximum number of messages that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested messages are returned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



6557
6558
6559
6560
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6557

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

#list_channel_moderators(params = {}) ⇒ Types::ListChannelModeratorsResponse

Lists all the moderators for a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelModerators, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_channel_moderators({
  channel_arn: "ChimeArn", # required
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.next_token #=> String
resp.channel_moderators #=> Array
resp.channel_moderators[0].moderator.arn #=> String
resp.channel_moderators[0].moderator.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :max_results (Integer) —

    The maximum number of moderators that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested moderators are returned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



6625
6626
6627
6628
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6625

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

#list_channels(params = {}) ⇒ Types::ListChannelsResponse

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

  • Use privacy = PUBLIC to retrieve all public channels in the account.

  • Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_channels({
  app_instance_arn: "ChimeArn", # required
  privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channels #=> Array
resp.channels[0].name #=> String
resp.channels[0].channel_arn #=> String
resp.channels[0].mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
resp.channels[0].privacy #=> String, one of "PUBLIC", "PRIVATE"
resp.channels[0].metadata #=> String
resp.channels[0].last_message_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

  • :privacy (String) —

    The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

  • :max_results (Integer) —

    The maximum number of channels that you want to return.

  • :next_token (String) —

    The token passed by previous API calls until all requested channels are returned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



6710
6711
6712
6713
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6710

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

#list_channels_moderated_by_app_instance_user(params = {}) ⇒ Types::ListChannelsModeratedByAppInstanceUserResponse

A list of the channels moderated by an AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_channels_moderated_by_app_instance_user({
  app_instance_user_arn: "ChimeArn",
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channels #=> Array
resp.channels[0].channel_summary.name #=> String
resp.channels[0].channel_summary.channel_arn #=> String
resp.channels[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
resp.channels[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
resp.channels[0].channel_summary.metadata #=> String
resp.channels[0].channel_summary.last_message_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_user_arn (String) —

    The ARN of the user in the moderated channel.

  • :max_results (Integer) —

    The maximum number of channels in the request.

  • :next_token (String) —

    The token returned from previous API requests until the number of channels moderated by the user is reached.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



6780
6781
6782
6783
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6780

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

#list_media_capture_pipelines(params = {}) ⇒ Types::ListMediaCapturePipelinesResponse

Returns a list of media capture pipelines.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_media_capture_pipelines({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.media_capture_pipelines #=> Array
resp.media_capture_pipelines[0].media_pipeline_id #=> String
resp.media_capture_pipelines[0].source_type #=> String, one of "ChimeSdkMeeting"
resp.media_capture_pipelines[0].source_arn #=> String
resp.media_capture_pipelines[0].status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
resp.media_capture_pipelines[0].sink_type #=> String, one of "S3Bucket"
resp.media_capture_pipelines[0].sink_arn #=> String
resp.media_capture_pipelines[0].created_timestamp #=> Time
resp.media_capture_pipelines[0].updated_timestamp #=> Time
resp.media_capture_pipelines[0].chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
resp.media_capture_pipelines[0].chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
resp.media_capture_pipelines[0].chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
resp.media_capture_pipelines[0].chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
resp.media_capture_pipelines[0].chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo"
resp.media_capture_pipelines[0].chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipelines[0].chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
resp.media_capture_pipelines[0].chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipelines[0].chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token used to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. Valid Range: 1 - 99.

Returns:

See Also:



6847
6848
6849
6850
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6847

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

#list_meeting_tags(params = {}) ⇒ Types::ListMeetingTagsResponse

Lists the tags applied to an Amazon Chime SDK meeting resource.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListTagsForResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

Returns:

See Also:



6890
6891
6892
6893
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6890

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

#list_meetings(params = {}) ⇒ Types::ListMeetingsResponse

Lists up to 100 active Amazon Chime SDK meetings.

ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK 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_meetings({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.meetings #=> Array
resp.meetings[0].meeting_id #=> String
resp.meetings[0].external_meeting_id #=> String
resp.meetings[0].media_placement.audio_host_url #=> String
resp.meetings[0].media_placement.audio_fallback_url #=> String
resp.meetings[0].media_placement.screen_data_url #=> String
resp.meetings[0].media_placement.screen_sharing_url #=> String
resp.meetings[0].media_placement.screen_viewing_url #=> String
resp.meetings[0].media_placement.signaling_url #=> String
resp.meetings[0].media_placement.turn_control_url #=> String
resp.meetings[0].media_placement.event_ingestion_url #=> String
resp.meetings[0].media_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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:



6947
6948
6949
6950
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6947

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

#list_phone_number_orders(params = {}) ⇒ Types::ListPhoneNumberOrdersResponse

Lists the phone number orders for the administrator's Amazon Chime account.

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_phone_number_orders({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.phone_number_orders #=> Array
resp.phone_number_orders[0].phone_number_order_id #=> String
resp.phone_number_orders[0].product_type #=> String, one of "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number_orders[0].status #=> String, one of "Processing", "Successful", "Failed", "Partial"
resp.phone_number_orders[0].ordered_phone_numbers #=> Array
resp.phone_number_orders[0].ordered_phone_numbers[0].e164_phone_number #=> String
resp.phone_number_orders[0].ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
resp.phone_number_orders[0].created_timestamp #=> Time
resp.phone_number_orders[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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:



6992
6993
6994
6995
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6992

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

#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

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_phone_numbers({
  status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
  product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector, SipMediaApplicationDialIn
  filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId, SipRuleId
  filter_value: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.phone_numbers #=> Array
resp.phone_numbers[0].phone_number_id #=> String
resp.phone_numbers[0].e164_phone_number #=> String
resp.phone_numbers[0].country #=> String
resp.phone_numbers[0].type #=> String, one of "Local", "TollFree"
resp.phone_numbers[0].product_type #=> String, one of "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_numbers[0].status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
resp.phone_numbers[0].capabilities.inbound_call #=> Boolean
resp.phone_numbers[0].capabilities.outbound_call #=> Boolean
resp.phone_numbers[0].capabilities.inbound_sms #=> Boolean
resp.phone_numbers[0].capabilities.outbound_sms #=> Boolean
resp.phone_numbers[0].capabilities.inbound_mms #=> Boolean
resp.phone_numbers[0].capabilities.outbound_mms #=> Boolean
resp.phone_numbers[0].associations #=> Array
resp.phone_numbers[0].associations[0].value #=> String
resp.phone_numbers[0].associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
resp.phone_numbers[0].associations[0].associated_timestamp #=> Time
resp.phone_numbers[0].calling_name #=> String
resp.phone_numbers[0].calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
resp.phone_numbers[0].created_timestamp #=> Time
resp.phone_numbers[0].updated_timestamp #=> Time
resp.phone_numbers[0].deletion_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :status (String) —

    The phone number status.

  • :product_type (String) —

    The phone number product type.

  • :filter_name (String) —

    The filter to use to limit the number of results.

  • :filter_value (String) —

    The value to use for the filter.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



7067
7068
7069
7070
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7067

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

#list_proxy_sessions(params = {}) ⇒ Types::ListProxySessionsResponse

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListProxySessions, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_proxy_sessions({
  voice_connector_id: "NonEmptyString128", # required
  status: "Open", # accepts Open, InProgress, Closed
  next_token: "NextTokenString",
  max_results: 1,
})

Response structure


resp.proxy_sessions #=> Array
resp.proxy_sessions[0].voice_connector_id #=> String
resp.proxy_sessions[0].proxy_session_id #=> String
resp.proxy_sessions[0].name #=> String
resp.proxy_sessions[0].status #=> String, one of "Open", "InProgress", "Closed"
resp.proxy_sessions[0].expiry_minutes #=> Integer
resp.proxy_sessions[0].capabilities #=> Array
resp.proxy_sessions[0].capabilities[0] #=> String, one of "Voice", "SMS"
resp.proxy_sessions[0].created_timestamp #=> Time
resp.proxy_sessions[0].updated_timestamp #=> Time
resp.proxy_sessions[0].ended_timestamp #=> Time
resp.proxy_sessions[0].participants #=> Array
resp.proxy_sessions[0].participants[0].phone_number #=> String
resp.proxy_sessions[0].participants[0].proxy_phone_number #=> String
resp.proxy_sessions[0].number_selection_behavior #=> String, one of "PreferSticky", "AvoidSticky"
resp.proxy_sessions[0].geo_match_level #=> String, one of "Country", "AreaCode"
resp.proxy_sessions[0].geo_match_params.country #=> String
resp.proxy_sessions[0].geo_match_params.area_code #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

  • :status (String) —

    The proxy session status.

  • :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:



7142
7143
7144
7145
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7142

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

#list_room_memberships(params = {}) ⇒ Types::ListRoomMembershipsResponse

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

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_room_memberships({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.room_memberships #=> Array
resp.room_memberships[0].room_id #=> String
resp.room_memberships[0].member.member_id #=> String
resp.room_memberships[0].member.member_type #=> String, one of "User", "Bot", "Webhook"
resp.room_memberships[0].member.email #=> String
resp.room_memberships[0].member.full_name #=> String
resp.room_memberships[0].member. #=> String
resp.room_memberships[0].role #=> String, one of "Administrator", "Member"
resp.room_memberships[0].invited_by #=> String
resp.room_memberships[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



7197
7198
7199
7200
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7197

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

#list_rooms(params = {}) ⇒ Types::ListRoomsResponse

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

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_rooms({
  account_id: "NonEmptyString", # required
  member_id: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.rooms #=> Array
resp.rooms[0].room_id #=> String
resp.rooms[0].name #=> String
resp.rooms[0]. #=> String
resp.rooms[0].created_by #=> String
resp.rooms[0].created_timestamp #=> Time
resp.rooms[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :member_id (String) —

    The member ID (user ID or bot ID).

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



7249
7250
7251
7252
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7249

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

#list_sip_media_applications(params = {}) ⇒ Types::ListSipMediaApplicationsResponse

Lists the SIP media applications under the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipMediaApplications, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_sip_media_applications({
  max_results: 1,
  next_token: "NextTokenString",
})

Response structure


resp.sip_media_applications #=> Array
resp.sip_media_applications[0].sip_media_application_id #=> String
resp.sip_media_applications[0].aws_region #=> String
resp.sip_media_applications[0].name #=> String
resp.sip_media_applications[0].endpoints #=> Array
resp.sip_media_applications[0].endpoints[0].lambda_arn #=> String
resp.sip_media_applications[0].created_timestamp #=> Time
resp.sip_media_applications[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



7307
7308
7309
7310
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7307

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

#list_sip_rules(params = {}) ⇒ Types::ListSipRulesResponse

Lists the SIP rules under the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_sip_rules({
  sip_media_application_id: "NonEmptyString",
  max_results: 1,
  next_token: "NextTokenString",
})

Response structure


resp.sip_rules #=> Array
resp.sip_rules[0].sip_rule_id #=> String
resp.sip_rules[0].name #=> String
resp.sip_rules[0].disabled #=> Boolean
resp.sip_rules[0].trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
resp.sip_rules[0].trigger_value #=> String
resp.sip_rules[0].target_applications #=> Array
resp.sip_rules[0].target_applications[0].sip_media_application_id #=> String
resp.sip_rules[0].target_applications[0].priority #=> Integer
resp.sip_rules[0].target_applications[0].aws_region #=> String
resp.sip_rules[0].created_timestamp #=> Time
resp.sip_rules[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (String) —

    The SIP media application ID.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



7372
7373
7374
7375
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7372

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

#list_supported_phone_number_countries(params = {}) ⇒ Types::ListSupportedPhoneNumberCountriesResponse

Lists supported phone number countries.

Examples:

Request syntax with placeholder values


resp = client.list_supported_phone_number_countries({
  product_type: "BusinessCalling", # required, accepts BusinessCalling, VoiceConnector, SipMediaApplicationDialIn
})

Response structure


resp.phone_number_countries #=> Array
resp.phone_number_countries[0].country_code #=> String
resp.phone_number_countries[0].supported_phone_number_types #=> Array
resp.phone_number_countries[0].supported_phone_number_types[0] #=> String, one of "Local", "TollFree"

Parameters:

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

    ({})

Options Hash (params):

  • :product_type (required, String) —

    The phone number product type.

Returns:

See Also:



7403
7404
7405
7406
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7403

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

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

Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.

This API is is no longer supported and will not be updated. We recommend using the applicable latest version in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # 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 resource ARN.

Returns:

See Also:



7451
7452
7453
7454
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7451

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

#list_users(params = {}) ⇒ Types::ListUsersResponse

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

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_users({
  account_id: "NonEmptyString", # required
  user_email: "EmailAddress",
  user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
  max_results: 1,
  next_token: "String",
})

Response structure


resp.users #=> Array
resp.users[0].user_id #=> String
resp.users[0]. #=> String
resp.users[0].primary_email #=> String
resp.users[0].primary_provisioned_number #=> String
resp.users[0].display_name #=> String
resp.users[0].license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.users[0].user_type #=> String, one of "PrivateUser", "SharedDevice"
resp.users[0].user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
resp.users[0].user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
resp.users[0].registered_on #=> Time
resp.users[0].invited_on #=> Time
resp.users[0].alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
resp.users[0].alexa_for_business_metadata.alexa_for_business_room_arn #=> String
resp.users[0].personal_pin #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_email (String) —

    Optional. The user email address used to filter results. Maximum 1.

  • :user_type (String) —

    The user type.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



7516
7517
7518
7519
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7516

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

#list_voice_connector_groups(params = {}) ⇒ Types::ListVoiceConnectorGroupsResponse

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorGroups, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_voice_connector_groups({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.voice_connector_groups #=> Array
resp.voice_connector_groups[0].voice_connector_group_id #=> String
resp.voice_connector_groups[0].name #=> String
resp.voice_connector_groups[0].voice_connector_items #=> Array
resp.voice_connector_groups[0].voice_connector_items[0].voice_connector_id #=> String
resp.voice_connector_groups[0].voice_connector_items[0].priority #=> Integer
resp.voice_connector_groups[0].created_timestamp #=> Time
resp.voice_connector_groups[0].updated_timestamp #=> Time
resp.voice_connector_groups[0].voice_connector_group_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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:



7574
7575
7576
7577
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7574

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

#list_voice_connector_termination_credentials(params = {}) ⇒ Types::ListVoiceConnectorTerminationCredentialsResponse

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.list_voice_connector_termination_credentials({
  voice_connector_id: "NonEmptyString", # required
})

Response structure


resp.usernames #=> Array
resp.usernames[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



7618
7619
7620
7621
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7618

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

#list_voice_connectors(params = {}) ⇒ Types::ListVoiceConnectorsResponse

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectors, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK 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_voice_connectors({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.voice_connectors #=> Array
resp.voice_connectors[0].voice_connector_id #=> String
resp.voice_connectors[0].aws_region #=> String, one of "us-east-1", "us-west-2"
resp.voice_connectors[0].name #=> String
resp.voice_connectors[0].outbound_host_name #=> String
resp.voice_connectors[0].require_encryption #=> Boolean
resp.voice_connectors[0].created_timestamp #=> Time
resp.voice_connectors[0].updated_timestamp #=> Time
resp.voice_connectors[0].voice_connector_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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:



7676
7677
7678
7679
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7676

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

#logout_user(params = {}) ⇒ Struct

Logs out the specified user from all of the devices they are currently logged into.

Examples:

Request syntax with placeholder values


resp = client.logout_user({
  account_id: "NonEmptyString", # required
  user_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7703
7704
7705
7706
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7703

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

#put_app_instance_retention_settings(params = {}) ⇒ Types::PutAppInstanceRetentionSettingsResponse

Sets the amount of time in days that a given AppInstance retains data.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_app_instance_retention_settings({
  app_instance_arn: "ChimeArn", # required
  app_instance_retention_settings: { # required
    channel_retention_settings: {
      retention_days: 1,
    },
  },
})

Response structure


resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
resp.initiate_deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

  • :app_instance_retention_settings (required, Types::AppInstanceRetentionSettings) —

    The time in days to retain data. Data type: number.

Returns:

See Also:



7755
7756
7757
7758
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7755

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

#put_app_instance_streaming_configurations(params = {}) ⇒ Types::PutAppInstanceStreamingConfigurationsResponse

The data streaming configurations of an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_app_instance_streaming_configurations({
  app_instance_arn: "ChimeArn", # required
  app_instance_streaming_configurations: [ # required
    {
      app_instance_data_type: "Channel", # required, accepts Channel, ChannelMessage
      resource_arn: "Arn", # required
    },
  ],
})

Response structure


resp.app_instance_streaming_configurations #=> Array
resp.app_instance_streaming_configurations[0].app_instance_data_type #=> String, one of "Channel", "ChannelMessage"
resp.app_instance_streaming_configurations[0].resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

  • :app_instance_streaming_configurations (required, Array<Types::AppInstanceStreamingConfiguration>) —

    The streaming configurations set for an AppInstance.

Returns:

See Also:



7807
7808
7809
7810
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7807

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

#put_events_configuration(params = {}) ⇒ Types::PutEventsConfigurationResponse

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

Examples:

Request syntax with placeholder values


resp = client.put_events_configuration({
  account_id: "NonEmptyString", # required
  bot_id: "NonEmptyString", # required
  outbound_events_https_endpoint: "SensitiveString",
  lambda_function_arn: "SensitiveString",
})

Response structure


resp.events_configuration.bot_id #=> String
resp.events_configuration.outbound_events_https_endpoint #=> String
resp.events_configuration.lambda_function_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :bot_id (required, String) —

    The bot ID.

  • :outbound_events_https_endpoint (String) —

    HTTPS endpoint that allows the bot to receive outgoing events.

  • :lambda_function_arn (String) —

    Lambda function ARN that allows the bot to receive outgoing events.

Returns:

See Also:



7851
7852
7853
7854
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7851

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

#put_retention_settings(params = {}) ⇒ Types::PutRetentionSettingsResponse

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.

To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Examples:

Request syntax with placeholder values


resp = client.put_retention_settings({
  account_id: "NonEmptyString", # required
  retention_settings: { # required
    room_retention_settings: {
      retention_days: 1,
    },
    conversation_retention_settings: {
      retention_days: 1,
    },
  },
})

Response structure


resp.retention_settings.room_retention_settings.retention_days #=> Integer
resp.retention_settings.conversation_retention_settings.retention_days #=> Integer
resp.initiate_deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :retention_settings (required, Types::RetentionSettings) —

    The retention settings.

Returns:

See Also:



7908
7909
7910
7911
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7908

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

#put_sip_media_application_logging_configuration(params = {}) ⇒ Types::PutSipMediaApplicationLoggingConfigurationResponse

Updates the logging configuration for the specified SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_sip_media_application_logging_configuration({
  sip_media_application_id: "NonEmptyString", # required
  sip_media_application_logging_configuration: {
    enable_sip_media_application_message_logs: false,
  },
})

Response structure


resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



7957
7958
7959
7960
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7957

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

#put_voice_connector_emergency_calling_configuration(params = {}) ⇒ Types::PutVoiceConnectorEmergencyCallingConfigurationResponse

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_emergency_calling_configuration({
  voice_connector_id: "NonEmptyString", # required
  emergency_calling_configuration: { # required
    dnis: [
      {
        emergency_phone_number: "E164PhoneNumber", # required
        test_phone_number: "E164PhoneNumber",
        calling_country: "Alpha2CountryCode", # required
      },
    ],
  },
})

Response structure


resp.emergency_calling_configuration.dnis #=> Array
resp.emergency_calling_configuration.dnis[0].emergency_phone_number #=> String
resp.emergency_calling_configuration.dnis[0].test_phone_number #=> String
resp.emergency_calling_configuration.dnis[0].calling_country #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

  • :emergency_calling_configuration (required, Types::EmergencyCallingConfiguration) —

    The emergency calling configuration details.

Returns:

See Also:



8018
8019
8020
8021
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8018

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

#put_voice_connector_logging_configuration(params = {}) ⇒ Types::PutVoiceConnectorLoggingConfigurationResponse

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_logging_configuration({
  voice_connector_id: "NonEmptyString", # required
  logging_configuration: { # required
    enable_sip_logs: false,
    enable_media_metric_logs: false,
  },
})

Response structure


resp.logging_configuration.enable_sip_logs #=> Boolean
resp.logging_configuration.enable_media_metric_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

  • :logging_configuration (required, Types::LoggingConfiguration) —

    The logging configuration details to add.

Returns:

See Also:



8069
8070
8071
8072
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8069

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

#put_voice_connector_origination(params = {}) ⇒ Types::PutVoiceConnectorOriginationResponse

Adds origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_origination({
  voice_connector_id: "NonEmptyString", # required
  origination: { # required
    routes: [
      {
        host: "String",
        port: 1,
        protocol: "TCP", # accepts TCP, UDP
        priority: 1,
        weight: 1,
      },
    ],
    disabled: false,
  },
})

Response structure


resp.origination.routes #=> Array
resp.origination.routes[0].host #=> String
resp.origination.routes[0].port #=> Integer
resp.origination.routes[0].protocol #=> String, one of "TCP", "UDP"
resp.origination.routes[0].priority #=> Integer
resp.origination.routes[0].weight #=> Integer
resp.origination.disabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

  • :origination (required, Types::Origination) —

    The origination setting details to add.

Returns:

See Also:



8138
8139
8140
8141
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8138

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

#put_voice_connector_proxy(params = {}) ⇒ Types::PutVoiceConnectorProxyResponse

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorProxy, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_proxy({
  voice_connector_id: "NonEmptyString128", # required
  default_session_expiry_minutes: 1, # required
  phone_number_pool_countries: ["Country"], # required
  fall_back_phone_number: "E164PhoneNumber",
  disabled: false,
})

Response structure


resp.proxy.default_session_expiry_minutes #=> Integer
resp.proxy.disabled #=> Boolean
resp.proxy.fall_back_phone_number #=> String
resp.proxy.phone_number_countries #=> Array
resp.proxy.phone_number_countries[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

  • :default_session_expiry_minutes (required, Integer) —

    The default number of minutes allowed for proxy sessions.

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

    The countries for proxy phone numbers to be selected from.

  • :fall_back_phone_number (String) —

    The phone number to route calls to after a proxy session expires.

  • :disabled (Boolean) —

    When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

Returns:

See Also:



8201
8202
8203
8204
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8201

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

#put_voice_connector_streaming_configuration(params = {}) ⇒ Types::PutVoiceConnectorStreamingConfigurationResponse

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_streaming_configuration({
  voice_connector_id: "NonEmptyString", # required
  streaming_configuration: { # required
    data_retention_in_hours: 1, # required
    disabled: false,
    streaming_notification_targets: [
      {
        notification_target: "EventBridge", # required, accepts EventBridge, SNS, SQS
      },
    ],
  },
})

Response structure


resp.streaming_configuration.data_retention_in_hours #=> Integer
resp.streaming_configuration.disabled #=> Boolean
resp.streaming_configuration.streaming_notification_targets #=> Array
resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

  • :streaming_configuration (required, Types::StreamingConfiguration) —

    The streaming configuration details to add.

Returns:

See Also:



8260
8261
8262
8263
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8260

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

#put_voice_connector_termination(params = {}) ⇒ Types::PutVoiceConnectorTerminationResponse

Adds termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTermination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_termination({
  voice_connector_id: "NonEmptyString", # required
  termination: { # required
    cps_limit: 1,
    default_phone_number: "E164PhoneNumber",
    calling_regions: ["CallingRegion"],
    cidr_allowed_list: ["String"],
    disabled: false,
  },
})

Response structure


resp.termination.cps_limit #=> Integer
resp.termination.default_phone_number #=> String
resp.termination.calling_regions #=> Array
resp.termination.calling_regions[0] #=> String
resp.termination.cidr_allowed_list #=> Array
resp.termination.cidr_allowed_list[0] #=> String
resp.termination.disabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

  • :termination (required, Types::Termination) —

    The termination setting details to add.

Returns:

See Also:



8324
8325
8326
8327
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8324

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

#put_voice_connector_termination_credentials(params = {}) ⇒ Struct

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_termination_credentials({
  voice_connector_id: "NonEmptyString", # required
  credentials: [
    {
      username: "SensitiveString",
      password: "SensitiveString",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

  • :credentials (Array<Types::Credential>) —

    The termination SIP credentials.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8369
8370
8371
8372
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8369

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

#redact_channel_message(params = {}) ⇒ Types::RedactChannelMessageResponse

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, RedactChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.redact_channel_message({
  channel_arn: "ChimeArn", # required
  message_id: "MessageId", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.message_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel containing the messages that you want to redact.

  • :message_id (required, String) —

    The ID of the message being redacted.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



8429
8430
8431
8432
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8429

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

#redact_conversation_message(params = {}) ⇒ Struct

Redacts the specified message from the specified Amazon Chime conversation.

Examples:

Request syntax with placeholder values


resp = client.redact_conversation_message({
  account_id: "NonEmptyString", # required
  conversation_id: "NonEmptyString", # required
  message_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :conversation_id (required, String) —

    The conversation ID.

  • :message_id (required, String) —

    The message ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8460
8461
8462
8463
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8460

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

#redact_room_message(params = {}) ⇒ Struct

Redacts the specified message from the specified Amazon Chime channel.

Examples:

Request syntax with placeholder values


resp = client.redact_room_message({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
  message_id: "NonEmptyString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

  • :message_id (required, String) —

    The message ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8490
8491
8492
8493
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8490

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

#regenerate_security_token(params = {}) ⇒ Types::RegenerateSecurityTokenResponse

Regenerates the security token for a bot.

Examples:

Request syntax with placeholder values


resp = client.regenerate_security_token({
  account_id: "NonEmptyString", # required
  bot_id: "NonEmptyString", # required
})

Response structure


resp.bot.bot_id #=> String
resp.bot.user_id #=> String
resp.bot.display_name #=> String
resp.bot.bot_type #=> String, one of "ChatBot"
resp.bot.disabled #=> Boolean
resp.bot.created_timestamp #=> Time
resp.bot.updated_timestamp #=> Time
resp.bot.bot_email #=> String
resp.bot.security_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :bot_id (required, String) —

    The bot ID.

Returns:

See Also:



8530
8531
8532
8533
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8530

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

#reset_personal_pin(params = {}) ⇒ Types::ResetPersonalPINResponse

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

Examples:

Request syntax with placeholder values


resp = client.reset_personal_pin({
  account_id: "NonEmptyString", # required
  user_id: "NonEmptyString", # required
})

Response structure


resp.user.user_id #=> String
resp.user. #=> String
resp.user.primary_email #=> String
resp.user.primary_provisioned_number #=> String
resp.user.display_name #=> String
resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.user.user_type #=> String, one of "PrivateUser", "SharedDevice"
resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
resp.user.registered_on #=> Time
resp.user.invited_on #=> Time
resp.user.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

Returns:

See Also:



8577
8578
8579
8580
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8577

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

#restore_phone_number(params = {}) ⇒ Types::RestorePhoneNumberResponse

Moves a phone number from the Deletion queue back into the phone number Inventory.

Examples:

Request syntax with placeholder values


resp = client.restore_phone_number({
  phone_number_id: "NonEmptyString", # required
})

Response structure


resp.phone_number.phone_number_id #=> String
resp.phone_number.e164_phone_number #=> String
resp.phone_number.country #=> String
resp.phone_number.type #=> String, one of "Local", "TollFree"
resp.phone_number.product_type #=> String, one of "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number.status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
resp.phone_number.capabilities.inbound_call #=> Boolean
resp.phone_number.capabilities.outbound_call #=> Boolean
resp.phone_number.capabilities.inbound_sms #=> Boolean
resp.phone_number.capabilities.outbound_sms #=> Boolean
resp.phone_number.capabilities.inbound_mms #=> Boolean
resp.phone_number.capabilities.outbound_mms #=> Boolean
resp.phone_number.associations #=> Array
resp.phone_number.associations[0].value #=> String
resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
resp.phone_number.associations[0].associated_timestamp #=> Time
resp.phone_number.calling_name #=> String
resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
resp.phone_number.created_timestamp #=> Time
resp.phone_number.updated_timestamp #=> Time
resp.phone_number.deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number.

Returns:

See Also:



8626
8627
8628
8629
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8626

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

#search_available_phone_numbers(params = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

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

Examples:

Request syntax with placeholder values


resp = client.search_available_phone_numbers({
  area_code: "String",
  city: "String",
  country: "Alpha2CountryCode",
  state: "String",
  toll_free_prefix: "TollFreePrefix",
  phone_number_type: "Local", # accepts Local, TollFree
  max_results: 1,
  next_token: "String",
})

Response structure


resp.e164_phone_numbers #=> Array
resp.e164_phone_numbers[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :area_code (String) —

    The area code used to filter results. Only applies to the US.

  • :city (String) —

    The city used to filter results. Only applies to the US.

  • :country (String) —

    The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

  • :state (String) —

    The state used to filter results. Required only if you provide City. Only applies to the US.

  • :toll_free_prefix (String) —

    The toll-free prefix that you use to filter results. Only applies to the US.

  • :phone_number_type (String) —

    The phone number type used to filter results. Required for non-US numbers.

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token used to retrieve the next page of results.

Returns:

See Also:



8695
8696
8697
8698
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8695

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

#send_channel_message(params = {}) ⇒ Types::SendChannelMessageResponse

Sends a message to a particular channel that the member is a part of.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

This API is is no longer supported and will not be updated. We recommend using the latest version, SendChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.send_channel_message({
  channel_arn: "ChimeArn", # required
  content: "NonEmptyContent", # required
  type: "STANDARD", # required, accepts STANDARD, CONTROL
  persistence: "PERSISTENT", # required, accepts PERSISTENT, NON_PERSISTENT
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.message_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :content (required, String) —

    The content of the message.

  • :type (required, String) —

    The type of message, STANDARD or CONTROL.

  • :persistence (required, String) —

    Boolean that controls whether the message is persisted on the back end. Required.

  • :metadata (String) —

    The optional metadata for each message.

  • :client_request_token (required, String) —

    The Idempotency token for each client request.

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

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



8776
8777
8778
8779
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8776

def send_channel_message(params = {}, options = {})
  req = build_request(:send_channel_message, 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.

This API is is no longer supported and will not be updated. We recommend using the latest version, StartMeetingTranscription, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

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
      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:



8862
8863
8864
8865
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8862

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.

This API is is no longer supported and will not be updated. We recommend using the latest version, StopMeetingTranscription, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

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:



8897
8898
8899
8900
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8897

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

#tag_attendee(params = {}) ⇒ Struct

Applies the specified tags to the specified Amazon Chime attendee.

TagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

Examples:

Request syntax with placeholder values


resp = client.tag_attendee({
  meeting_id: "GuidString", # required
  attendee_id: "GuidString", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # 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.

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

    The tag key-value pairs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8935
8936
8937
8938
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8935

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

#tag_meeting(params = {}) ⇒ Struct

Applies the specified tags to the specified Amazon Chime SDK meeting.

This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.tag_meeting({
  meeting_id: "GuidString", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

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

    The tag key-value pairs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8979
8980
8981
8982
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8979

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

#tag_resource(params = {}) ⇒ Struct

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource ARN.

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

    The tag key-value pairs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9024
9025
9026
9027
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9024

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

#untag_attendee(params = {}) ⇒ Struct

Untags the specified tags from the specified Amazon Chime SDK attendee.

UntagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

Examples:

Request syntax with placeholder values


resp = client.untag_attendee({
  meeting_id: "GuidString", # required
  attendee_id: "GuidString", # required
  tag_keys: ["TagKey"], # 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.

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

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9058
9059
9060
9061
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9058

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

#untag_meeting(params = {}) ⇒ Struct

Untags the specified tags from the specified Amazon Chime SDK meeting.

This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.untag_meeting({
  meeting_id: "GuidString", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

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

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9097
9098
9099
9100
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9097

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

#untag_resource(params = {}) ⇒ Struct

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource ARN.

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

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9140
9141
9142
9143
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9140

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

#update_account(params = {}) ⇒ Types::UpdateAccountResponse

Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "NonEmptyString", # required
  name: "AccountName",
  default_license: "Basic", # accepts Basic, Plus, Pro, ProTrial
})

Response structure


resp.. #=> String
resp.. #=> String
resp..name #=> String
resp.. #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
resp..created_timestamp #=> Time
resp..default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp..supported_licenses #=> Array
resp..supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.. #=> String, one of "Suspended", "Active"
resp.. #=> Array
resp..[0].group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :name (String) —

    The new name for the specified Amazon Chime account.

  • :default_license (String) —

    The default license applied when you add users to an Amazon Chime account.

Returns:

See Also:



9189
9190
9191
9192
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9189

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

#update_account_settings(params = {}) ⇒ Struct

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "NonEmptyString", # required
  account_settings: { # required
    disable_remote_control: false,
    enable_dial_out: false,
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :account_settings (required, Types::AccountSettings) —

    The Amazon Chime account settings to update.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9225
9226
9227
9228
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9225

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

#update_app_instance(params = {}) ⇒ Types::UpdateAppInstanceResponse

Updates AppInstance metadata.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_app_instance({
  app_instance_arn: "ChimeArn", # required
  name: "NonEmptyResourceName", # required
  metadata: "Metadata",
})

Response structure


resp.app_instance_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

  • :name (required, String) —

    The name that you want to change.

  • :metadata (String) —

    The metadata that you want to change.

Returns:

See Also:



9274
9275
9276
9277
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9274

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

#update_app_instance_user(params = {}) ⇒ Types::UpdateAppInstanceUserResponse

Updates the details of an AppInstanceUser. You can update names and metadata.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_app_instance_user({
  app_instance_user_arn: "ChimeArn", # required
  name: "UserName", # required
  metadata: "Metadata",
})

Response structure


resp.app_instance_user_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_user_arn (required, String) —

    The ARN of the AppInstanceUser.

  • :name (required, String) —

    The name of the AppInstanceUser.

  • :metadata (String) —

    The metadata of the AppInstanceUser.

Returns:

See Also:



9324
9325
9326
9327
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9324

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

#update_bot(params = {}) ⇒ Types::UpdateBotResponse

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


resp = client.update_bot({
  account_id: "NonEmptyString", # required
  bot_id: "NonEmptyString", # required
  disabled: false,
})

Response structure


resp.bot.bot_id #=> String
resp.bot.user_id #=> String
resp.bot.display_name #=> String
resp.bot.bot_type #=> String, one of "ChatBot"
resp.bot.disabled #=> Boolean
resp.bot.created_timestamp #=> Time
resp.bot.updated_timestamp #=> Time
resp.bot.bot_email #=> String
resp.bot.security_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :bot_id (required, String) —

    The bot ID.

  • :disabled (Boolean) —

    When true, stops the specified bot from running in your account.

Returns:

See Also:



9369
9370
9371
9372
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9369

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

#update_channel(params = {}) ⇒ Types::UpdateChannelResponse

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_channel({
  channel_arn: "ChimeArn", # required
  name: "NonEmptyResourceName", # required
  mode: "UNRESTRICTED", # required, accepts UNRESTRICTED, RESTRICTED
  metadata: "Metadata",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :name (required, String) —

    The name of the channel.

  • :mode (required, String) —

    The mode of the update request.

  • :metadata (String) —

    The metadata for the update request.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



9434
9435
9436
9437
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9434

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

#update_channel_message(params = {}) ⇒ Types::UpdateChannelMessageResponse

Updates the content of a message.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_channel_message({
  channel_arn: "ChimeArn", # required
  message_id: "MessageId", # required
  content: "Content",
  metadata: "Metadata",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.message_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :message_id (required, String) —

    The ID string of the message being updated.

  • :content (String) —

    The content of the message being updated.

  • :metadata (String) —

    The metadata of the message being updated.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



9499
9500
9501
9502
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9499

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

#update_channel_read_marker(params = {}) ⇒ Types::UpdateChannelReadMarkerResponse

The details of the time when a user last read messages in a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelReadMarker, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_channel_read_marker({
  channel_arn: "ChimeArn", # required
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



9550
9551
9552
9553
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9550

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

#update_global_settings(params = {}) ⇒ Struct

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Examples:

Request syntax with placeholder values


resp = client.update_global_settings({
  business_calling: {
    cdr_bucket: "String",
  },
  voice_connector: {
    cdr_bucket: "String",
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9582
9583
9584
9585
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9582

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

#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResponse

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Examples:

Request syntax with placeholder values


resp = client.update_phone_number({
  phone_number_id: "String", # required
  product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector, SipMediaApplicationDialIn
  calling_name: "CallingName",
})

Response structure


resp.phone_number.phone_number_id #=> String
resp.phone_number.e164_phone_number #=> String
resp.phone_number.country #=> String
resp.phone_number.type #=> String, one of "Local", "TollFree"
resp.phone_number.product_type #=> String, one of "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number.status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
resp.phone_number.capabilities.inbound_call #=> Boolean
resp.phone_number.capabilities.outbound_call #=> Boolean
resp.phone_number.capabilities.inbound_sms #=> Boolean
resp.phone_number.capabilities.outbound_sms #=> Boolean
resp.phone_number.capabilities.inbound_mms #=> Boolean
resp.phone_number.capabilities.outbound_mms #=> Boolean
resp.phone_number.associations #=> Array
resp.phone_number.associations[0].value #=> String
resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
resp.phone_number.associations[0].associated_timestamp #=> Time
resp.phone_number.calling_name #=> String
resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
resp.phone_number.created_timestamp #=> Time
resp.phone_number.updated_timestamp #=> Time
resp.phone_number.deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number ID.

  • :product_type (String) —

    The product type.

  • :calling_name (String) —

    The outbound calling name associated with the phone number.

Returns:

See Also:



9649
9650
9651
9652
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9649

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

#update_phone_number_settings(params = {}) ⇒ Struct

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

Examples:

Request syntax with placeholder values


resp = client.update_phone_number_settings({
  calling_name: "CallingName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :calling_name (required, String) —

    The default outbound calling name for the account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9674
9675
9676
9677
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9674

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

#update_proxy_session(params = {}) ⇒ Types::UpdateProxySessionResponse

Updates the specified proxy session details, such as voice or SMS capabilities.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_proxy_session({
  voice_connector_id: "NonEmptyString128", # required
  proxy_session_id: "NonEmptyString128", # required
  capabilities: ["Voice"], # required, accepts Voice, SMS
  expiry_minutes: 1,
})

Response structure


resp.proxy_session.voice_connector_id #=> String
resp.proxy_session.proxy_session_id #=> String
resp.proxy_session.name #=> String
resp.proxy_session.status #=> String, one of "Open", "InProgress", "Closed"
resp.proxy_session.expiry_minutes #=> Integer
resp.proxy_session.capabilities #=> Array
resp.proxy_session.capabilities[0] #=> String, one of "Voice", "SMS"
resp.proxy_session.created_timestamp #=> Time
resp.proxy_session.updated_timestamp #=> Time
resp.proxy_session.ended_timestamp #=> Time
resp.proxy_session.participants #=> Array
resp.proxy_session.participants[0].phone_number #=> String
resp.proxy_session.participants[0].proxy_phone_number #=> String
resp.proxy_session.number_selection_behavior #=> String, one of "PreferSticky", "AvoidSticky"
resp.proxy_session.geo_match_level #=> String, one of "Country", "AreaCode"
resp.proxy_session.geo_match_params.country #=> String
resp.proxy_session.geo_match_params.area_code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

  • :proxy_session_id (required, String) —

    The proxy session ID.

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

    The proxy session capabilities.

  • :expiry_minutes (Integer) —

    The number of minutes allowed for the proxy session.

Returns:

See Also:



9744
9745
9746
9747
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9744

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

#update_room(params = {}) ⇒ Types::UpdateRoomResponse

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


resp = client.update_room({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
  name: "SensitiveString",
})

Response structure


resp.room.room_id #=> String
resp.room.name #=> String
resp.room. #=> String
resp.room.created_by #=> String
resp.room.created_timestamp #=> Time
resp.room.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

  • :name (String) —

    The room name.

Returns:

See Also:



9786
9787
9788
9789
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9786

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

#update_room_membership(params = {}) ⇒ Types::UpdateRoomMembershipResponse

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

Examples:

Request syntax with placeholder values


resp = client.update_room_membership({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
  member_id: "NonEmptyString", # required
  role: "Administrator", # accepts Administrator, Member
})

Response structure


resp.room_membership.room_id #=> String
resp.room_membership.member.member_id #=> String
resp.room_membership.member.member_type #=> String, one of "User", "Bot", "Webhook"
resp.room_membership.member.email #=> String
resp.room_membership.member.full_name #=> String
resp.room_membership.member. #=> String
resp.room_membership.role #=> String, one of "Administrator", "Member"
resp.room_membership.invited_by #=> String
resp.room_membership.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

  • :member_id (required, String) —

    The member ID.

  • :role (String) —

    The role of the member.

Returns:

See Also:



9837
9838
9839
9840
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9837

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

#update_sip_media_application(params = {}) ⇒ Types::UpdateSipMediaApplicationResponse

Updates the details of the specified SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_sip_media_application({
  sip_media_application_id: "NonEmptyString", # required
  name: "SipMediaApplicationName",
  endpoints: [
    {
      lambda_arn: "FunctionArn",
    },
  ],
})

Response structure


resp.sip_media_application.sip_media_application_id #=> String
resp.sip_media_application.aws_region #=> String
resp.sip_media_application.name #=> String
resp.sip_media_application.endpoints #=> Array
resp.sip_media_application.endpoints[0].lambda_arn #=> String
resp.sip_media_application.created_timestamp #=> Time
resp.sip_media_application.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

  • :name (String) —

    The new name for the specified SIP media application.

  • :endpoints (Array<Types::SipMediaApplicationEndpoint>) —

    The new set of endpoints for the specified SIP media application.

Returns:

See Also:



9896
9897
9898
9899
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9896

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

#update_sip_media_application_call(params = {}) ⇒ Types::UpdateSipMediaApplicationCallResponse

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplicationCall, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_sip_media_application_call({
  sip_media_application_id: "NonEmptyString", # required
  transaction_id: "NonEmptyString", # required
  arguments: { # required
    "SensitiveString" => "SensitiveString",
  },
})

Response structure


resp.sip_media_application_call.transaction_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The ID of the SIP media application handling the call.

  • :transaction_id (required, String) —

    The ID of the call transaction.

  • :arguments (required, Hash<String,String>) —

    Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

Returns:

See Also:



9950
9951
9952
9953
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9950

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

#update_sip_rule(params = {}) ⇒ Types::UpdateSipRuleResponse

Updates the details of the specified SIP rule.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_sip_rule({
  sip_rule_id: "NonEmptyString", # required
  name: "SipRuleName", # required
  disabled: false,
  target_applications: [
    {
      sip_media_application_id: "NonEmptyString",
      priority: 1,
      aws_region: "String",
    },
  ],
})

Response structure


resp.sip_rule.sip_rule_id #=> String
resp.sip_rule.name #=> String
resp.sip_rule.disabled #=> Boolean
resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
resp.sip_rule.trigger_value #=> String
resp.sip_rule.target_applications #=> Array
resp.sip_rule.target_applications[0].sip_media_application_id #=> String
resp.sip_rule.target_applications[0].priority #=> Integer
resp.sip_rule.target_applications[0].aws_region #=> String
resp.sip_rule.created_timestamp #=> Time
resp.sip_rule.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :sip_rule_id (required, String) —

    The SIP rule ID.

  • :name (required, String) —

    The new name for the specified SIP rule.

  • :disabled (Boolean) —

    The new value specified to indicate whether the rule is disabled.

  • :target_applications (Array<Types::SipRuleTargetApplication>) —

    The new value of the list of target applications.

Returns:

See Also:



10019
10020
10021
10022
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10019

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

#update_user(params = {}) ⇒ Types::UpdateUserResponse

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

Examples:

Request syntax with placeholder values


resp = client.update_user({
  account_id: "NonEmptyString", # required
  user_id: "NonEmptyString", # required
  license_type: "Basic", # accepts Basic, Plus, Pro, ProTrial
  user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
  alexa_for_business_metadata: {
    is_alexa_for_business_enabled: false,
    alexa_for_business_room_arn: "SensitiveString",
  },
})

Response structure


resp.user.user_id #=> String
resp.user. #=> String
resp.user.primary_email #=> String
resp.user.primary_provisioned_number #=> String
resp.user.display_name #=> String
resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
resp.user.user_type #=> String, one of "PrivateUser", "SharedDevice"
resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
resp.user.registered_on #=> Time
resp.user.invited_on #=> Time
resp.user.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

  • :license_type (String) —

    The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

  • :user_type (String) —

    The user type.

  • :alexa_for_business_metadata (Types::AlexaForBusinessMetadata) —

    The Alexa for Business metadata.

Returns:

See Also:



10081
10082
10083
10084
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10081

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

#update_user_settings(params = {}) ⇒ Struct

Updates the settings for the specified user, such as phone number settings.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "String", # required
  user_id: "String", # required
  user_settings: { # required
    telephony: { # required
      inbound_calling: false, # required
      outbound_calling: false, # required
      sms: false, # required
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

  • :user_settings (required, Types::UserSettings) —

    The user settings to update.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10118
10119
10120
10121
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10118

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

#update_voice_connector(params = {}) ⇒ Types::UpdateVoiceConnectorResponse

Updates details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_voice_connector({
  voice_connector_id: "NonEmptyString", # required
  name: "VoiceConnectorName", # required
  require_encryption: false, # required
})

Response structure


resp.voice_connector.voice_connector_id #=> String
resp.voice_connector.aws_region #=> String, one of "us-east-1", "us-west-2"
resp.voice_connector.name #=> String
resp.voice_connector.outbound_host_name #=> String
resp.voice_connector.require_encryption #=> Boolean
resp.voice_connector.created_timestamp #=> Time
resp.voice_connector.updated_timestamp #=> Time
resp.voice_connector.voice_connector_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

  • :name (required, String) —

    The name of the Amazon Chime Voice Connector.

  • :require_encryption (required, Boolean) —

    When enabled, requires encryption for the Amazon Chime Voice Connector.

Returns:

See Also:



10175
10176
10177
10178
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10175

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

#update_voice_connector_group(params = {}) ⇒ Types::UpdateVoiceConnectorGroupResponse

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_voice_connector_group({
  voice_connector_group_id: "NonEmptyString", # required
  name: "VoiceConnectorGroupName", # required
  voice_connector_items: [ # required
    {
      voice_connector_id: "NonEmptyString", # required
      priority: 1, # required
    },
  ],
})

Response structure


resp.voice_connector_group.voice_connector_group_id #=> String
resp.voice_connector_group.name #=> String
resp.voice_connector_group.voice_connector_items #=> Array
resp.voice_connector_group.voice_connector_items[0].voice_connector_id #=> String
resp.voice_connector_group.voice_connector_items[0].priority #=> Integer
resp.voice_connector_group.created_timestamp #=> Time
resp.voice_connector_group.updated_timestamp #=> Time
resp.voice_connector_group.voice_connector_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Amazon Chime Voice Connector group ID.

  • :name (required, String) —

    The name of the Amazon Chime Voice Connector group.

  • :voice_connector_items (required, Array<Types::VoiceConnectorItem>) —

    The VoiceConnectorItems to associate with the group.

Returns:

See Also:



10237
10238
10239
10240
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10237

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

#validate_e911_address(params = {}) ⇒ Types::ValidateE911AddressResponse

Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

This API is is no longer supported and will not be updated. We recommend using the latest version, ValidateE911Address, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.validate_e911_address({
  aws_account_id: "NonEmptyString", # required
  street_number: "SensitiveNonEmptyString", # required
  street_info: "SensitiveNonEmptyString", # required
  city: "SensitiveNonEmptyString", # required
  state: "SensitiveNonEmptyString", # required
  country: "SensitiveNonEmptyString", # required
  postal_code: "SensitiveNonEmptyString", # required
})

Response structure


resp.validation_result #=> Integer
resp.address_external_id #=> String
resp.address.street_name #=> String
resp.address.street_suffix #=> String
resp.address.post_directional #=> String
resp.address.pre_directional #=> String
resp.address.street_number #=> String
resp.address.city #=> String
resp.address.state #=> String
resp.address.postal_code #=> String
resp.address.postal_code_plus_4 #=> String
resp.address.country #=> String
resp.candidate_address_list #=> Array
resp.candidate_address_list[0].street_info #=> String
resp.candidate_address_list[0].street_number #=> String
resp.candidate_address_list[0].city #=> String
resp.candidate_address_list[0].state #=> String
resp.candidate_address_list[0].postal_code #=> String
resp.candidate_address_list[0].postal_code_plus_4 #=> String
resp.candidate_address_list[0].country #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The AWS account ID.

  • :street_number (required, String) —

    The address street number, such as 200 or 2121.

  • :street_info (required, String) —

    The address street information, such as 8th Avenue.

  • :city (required, String) —

    The address city, such as Portland.

  • :state (required, String) —

    The address state, such as ME.

  • :country (required, String) —

    The address country, such as US.

  • :postal_code (required, String) —

    The address postal code, such as 04352.

Returns:

See Also:



10328
10329
10330
10331
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10328

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