AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Chime::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

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

chime = Aws::Chime::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::Chime::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::Chime::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

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

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#associate_phone_number_with_user(options = {}) ⇒ 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
})

Options Hash (options):

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

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

Associates phone numbers with the specified Amazon Chime Voice Connector.

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

Options Hash (options):

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

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

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

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

Options Hash (options):

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

#associate_signin_delegate_groups_with_account(options = {}) ⇒ 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",
    },
  ],
})

Options Hash (options):

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

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

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

Examples:

Request syntax with placeholder values


resp = client.batch_create_attendee({
  meeting_id: "GuidString", # required
  attendees: [ # required
    {
      external_user_id: "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

Options Hash (options):

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

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

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be either 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

Options Hash (options):

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

#batch_delete_phone_number(options = {}) ⇒ 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

Options Hash (options):

  • :phone_number_ids (required, Array<String>)

    List of phone number IDs.

Returns:

See Also:

#batch_suspend_user(options = {}) ⇒ 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

Options Hash (options):

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

#batch_unsuspend_user(options = {}) ⇒ 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 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

Options Hash (options):

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

#batch_update_phone_number(options = {}) ⇒ 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 either the product type or the calling name.

For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector 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
      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

Options Hash (options):

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

#batch_update_user(options = {}) ⇒ 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

Options Hash (options):

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

#create_account(options = {}) ⇒ 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.. #=> Array
resp..[0].group_name #=> String

Options Hash (options):

  • :name (required, String)

    The name of the Amazon Chime account.

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


resp = client.create_app_instance({
  name: "NonEmptyResourceName", # required
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.app_instance_arn #=> String

Options Hash (options):

  • :name (required, String)

    The name of the app instance.

  • :metadata (String)

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

  • :client_request_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. The ClientRequestToken of the app instance.

Returns:

See Also:

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

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

  • ChannelModerator actions across all channels in the app instance.

  • 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

Options Hash (options):

  • :app_instance_admin_arn (required, String)

    The ARN of the administrator of the current app instance.

  • :app_instance_arn (required, String)

    The ARN of the app instance.

Returns:

See Also:

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

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

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
})

Response structure


resp.app_instance_user_arn #=> String

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance request.

  • :app_instance_user_id (required, String)

    The user ID of the app instance.

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

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. The token assigned to the user requesting an app instance.

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


resp = client.create_attendee({
  meeting_id: "GuidString", # required
  external_user_id: "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

Options Hash (options):

  • :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. If you create an attendee with the same external user id, the service returns the existing record.

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

    The tag key-value pairs.

Returns:

See Also:

#create_bot(options = {}) ⇒ 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 #=> true/false
resp.bot.created_timestamp #=> Time
resp.bot.updated_timestamp #=> Time
resp.bot.bot_email #=> String
resp.bot.security_token #=> String

Options Hash (options):

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

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

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

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

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
    },
  ],
})

Response structure


resp.channel_arn #=> String

Options Hash (options):

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

  • :metadata (String)

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

  • :client_request_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. The client token for the request. An Idempotency token.

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

Returns:

See Also:

#create_channel_ban(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the ban request.

  • :member_arn (required, String)

    The ARN of the member being banned.

Returns:

See Also:

#create_channel_membership(options = {}) ⇒ 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.

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
})

Response structure


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

Options Hash (options):

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

Returns:

See Also:

#create_channel_moderator(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the channel.

  • :channel_moderator_arn (required, String)

    The ARN of the moderator.

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


resp = client.create_meeting({
  client_request_token: "ClientRequestToken", # required
  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_region #=> String

Options Hash (options):

  • :client_request_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. The unique identifier for the client request. Use a different token for different meetings.

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

#create_meeting_dial_out(options = {}) ⇒ 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 joins them into 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 API with the corresponding SIP media application ID.

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

Options Hash (options):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

    Type: String

    Pattern: [a-fA-F0-9]`8(?:-[a-fA-F0-9]4)3-[a-fA-F0-9]12`

    Required: No

  • :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 API to get a join token.

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


resp = client.create_meeting_with_attendees({
  client_request_token: "ClientRequestToken", # required
  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_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

Options Hash (options):

  • :client_request_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. The unique identifier for the client request. Use a different token for different meetings.

  • :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 Amazon Chime SDK meeting and attendee events occur. 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:

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

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Examples:

Request syntax with placeholder values


resp = client.create_phone_number_order({
  product_type: "BusinessCalling", # required, accepts BusinessCalling, VoiceConnector
  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"
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

Options Hash (options):

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

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

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

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

Options Hash (options):

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

#create_room(options = {}) ⇒ 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

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :name (required, String)

    The room name.

  • :client_request_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. The idempotency token for the request.

Returns:

See Also:

#create_room_membership(options = {}) ⇒ 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

Options Hash (options):

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

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

Creates a SIP media application.

Examples:

Request syntax with placeholder values


resp = client.create_sip_media_application({
  aws_region: "String", # required
  name: "SipMediaApplicationName",
  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

Options Hash (options):

  • :aws_region (required, String)

    AWS Region assigned to the SIP media application.

  • :name (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:

#create_sip_media_application_call(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.sip_media_application_call.transaction_id #=> String

Options Hash (options):

  • :from_phone_number (String)

    The phone number that a user calls from.

  • :to_phone_number (String)

    The phone number that the user dials in order to connect to a meeting

  • :sip_media_application_id (required, String)

    The ID of the SIP media application.

Returns:

See Also:

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

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

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 #=> true/false
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

Options Hash (options):

  • :name (required, String)

    The name of the SIP rule.

  • :trigger_type (required, String)

    The type of trigger whose value is assigned to the SIP rule in TriggerValue. Allowed trigger values are RequestUriHostname and ToPhoneNumber.

  • :trigger_value (required, String)

    If TriggerType is RequestUriHostname then the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a If TriggerType is RequestUriHostname, then the value can be the outbound hostname of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a ToPhoneNumber value matches the incoming SIP request.

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

#create_user(options = {}) ⇒ 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..is_alexa_for_business_enabled #=> true/false
resp.user..alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Options Hash (options):

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

#create_voice_connector(options = {}) ⇒ 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.

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 #=> true/false
resp.voice_connector.created_timestamp #=> Time
resp.voice_connector.updated_timestamp #=> Time

Options Hash (options):

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

#create_voice_connector_group(options = {}) ⇒ 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.

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

Options Hash (options):

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

#delete_account(options = {}) ⇒ Struct

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

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 a 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
})

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_app_instance(options = {}) ⇒ Struct

Deletes an AppInstance and all associated data asynchronously.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_app_instance_admin(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :app_instance_admin_arn (required, String)

    The ARN of the app instance\'s administrator.

  • :app_instance_arn (required, String)

    The ARN of the app instance.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_app_instance_streaming_configurations(options = {}) ⇒ Struct

Deletes the streaming configurations of an app instance.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the streaming configurations being deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_app_instance_user(options = {}) ⇒ Struct

Deletes an AppInstanceUser.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :app_instance_user_arn (required, String)

    The ARN of the user request being deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_attendee(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

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

#delete_channel(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the channel being deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_channel_ban(options = {}) ⇒ Struct

Removes a user from a channel's ban list.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the channel from which the app instance user was banned.

  • :member_arn (required, String)

    The ARN of the app instance user that you want to reinstate.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_channel_membership(options = {}) ⇒ Struct

Removes a member from a channel.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_channel_message(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the channel.

  • :message_id (required, String)

    The ID of the message being deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_channel_moderator(options = {}) ⇒ Struct

Deletes a channel moderator.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the channel.

  • :channel_moderator_arn (required, String)

    The ARN of the moderator being deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_events_configuration(options = {}) ⇒ 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
})

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_meeting(options = {}) ⇒ Struct

Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_phone_number(options = {}) ⇒ 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
})

Options Hash (options):

  • :phone_number_id (required, String)

    The phone number ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_proxy_session(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

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

#delete_room(options = {}) ⇒ 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
})

Options Hash (options):

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

#delete_room_membership(options = {}) ⇒ 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
})

Options Hash (options):

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

#delete_sip_media_application(options = {}) ⇒ Struct

Deletes a SIP media application.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :sip_media_application_id (required, String)

    The SIP media application ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_sip_rule(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :sip_rule_id (required, String)

    The SIP rule ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_voice_connector(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_voice_connector_emergency_calling_configuration(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_voice_connector_group(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :voice_connector_group_id (required, String)

    The Amazon Chime Voice Connector group ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_voice_connector_origination(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_voice_connector_proxy(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_voice_connector_streaming_configuration(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_voice_connector_termination(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_voice_connector_termination_credentials(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

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

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

Returns the full details of an AppInstance.

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. #=> String
resp.app_instance.created_timestamp #=> Time
resp.app_instance.last_updated_timestamp #=> Time

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance.

Returns:

See Also:

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

Returns the full details of an AppInstanceAdmin.

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

Options Hash (options):

  • :app_instance_admin_arn (required, String)

    The ARN of the app instance administrator.

  • :app_instance_arn (required, String)

    The ARN of the app instance.

Returns:

See Also:

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

Returns the full details of an AppInstanceUser.

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. #=> String
resp.app_instance_user.last_updated_timestamp #=> Time

Options Hash (options):

  • :app_instance_user_arn (required, String)

    The ARN of the app instance user.

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


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

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. #=> 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

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the channel.

Returns:

See Also:

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

Returns the full details of a channel ban.

Examples:

Request syntax with placeholder values


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

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

Options Hash (options):

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

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


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

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

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the channel.

  • :member_arn (required, String)

    The ARN of the member.

Returns:

See Also:

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

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

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
})

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. #=> 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

Options Hash (options):

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

Returns:

See Also:

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

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

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
})

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. #=> String
resp.channel.channel_summary.last_message_timestamp #=> Time

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the moderated channel.

  • :app_instance_user_arn (required, String)

    The ARN of the app instance user in the moderated channel.

Returns:

See Also:

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

Returns the full details of a single ChannelModerator.

Examples:

Request syntax with placeholder values


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

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

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the channel.

  • :channel_moderator_arn (required, String)

    The ARN of the channel moderator.

Returns:

See Also:

#disassociate_phone_number_from_user(options = {}) ⇒ 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
})

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

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

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

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

Options Hash (options):

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

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

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

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

Options Hash (options):

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

#disassociate_signin_delegate_groups_from_account(options = {}) ⇒ 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
})

Options Hash (options):

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

#get_account(options = {}) ⇒ 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.. #=> Array
resp..[0].group_name #=> String

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

Returns:

See Also:

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

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out 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 #=> true/false
resp..enable_dial_out #=> true/false

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

Returns:

See Also:

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

Gets the retention settings for an app instance.

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

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance.

Returns:

See Also:

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

Gets the streaming settings for an app instance.

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

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance.

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String)

    The Amazon Chime SDK attendee ID.

Returns:

See Also:

#get_bot(options = {}) ⇒ 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 #=> true/false
resp.bot.created_timestamp #=> Time
resp.bot.updated_timestamp #=> Time
resp.bot.bot_email #=> String
resp.bot.security_token #=> String

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

Returns:

See Also:

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

Gets the full details of a channel message.

Examples:

Request syntax with placeholder values


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

Response structure


resp.channel_message.channel_arn #=> String
resp.channel_message.message_id #=> String
resp.channel_message.content #=> String
resp.channel_message. #=> 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 #=> true/false
resp.channel_message.persistence #=> String, one of "PERSISTENT", "NON_PERSISTENT"

Options Hash (options):

  • :channel_arn (required, String)

    The ARN of the channel.

  • :message_id (required, String)

    The ID of the message.

Returns:

See Also:

#get_events_configuration(options = {}) ⇒ 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

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

Returns:

See Also:

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

Retrieves 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.get_global_settings()

Response structure


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

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.meeting.meeting_id #=> String
resp.meeting.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_region #=> String

Options Hash (options):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

Returns:

See Also:

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

The endpoint for the messaging session.

Examples:

Request syntax with placeholder values


resp = client.get_messaging_session_endpoint()

Response structure


resp.endpoint.url #=> String

Returns:

See Also:

#get_phone_number(options = {}) ⇒ 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.type #=> String, one of "Local", "TollFree"
resp.phone_number.product_type #=> String, one of "BusinessCalling", "VoiceConnector"
resp.phone_number.status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
resp.phone_number.capabilities.inbound_call #=> true/false
resp.phone_number.capabilities.outbound_call #=> true/false
resp.phone_number.capabilities.inbound_sms #=> true/false
resp.phone_number.capabilities.outbound_sms #=> true/false
resp.phone_number.capabilities.inbound_mms #=> true/false
resp.phone_number.capabilities.outbound_mms #=> true/false
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

Options Hash (options):

  • :phone_number_id (required, String)

    The phone number ID.

Returns:

See Also:

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

Retrieves details for the specified phone number order, such as 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"
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

Options Hash (options):

  • :phone_number_order_id (required, String)

    The ID for the phone number order.

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


resp = client.get_phone_number_settings()

Response structure


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

Returns:

See Also:

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

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

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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime voice connector ID.

  • :proxy_session_id (required, String)

    The proxy session ID.

Returns:

See Also:

#get_retention_settings(options = {}) ⇒ 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

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

Returns:

See Also:

#get_room(options = {}) ⇒ 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

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The room ID.

Returns:

See Also:

#get_sip_media_application(options = {}) ⇒ Types::GetSipMediaApplicationResponse

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

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

Options Hash (options):

  • :sip_media_application_id (required, String)

    The SIP media application ID.

Returns:

See Also:

#get_sip_media_application_logging_configuration(options = {}) ⇒ Types::GetSipMediaApplicationLoggingConfigurationResponse

Returns the logging configuration for the specified SIP media application.

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 #=> true/false

Options Hash (options):

  • :sip_media_application_id (required, String)

    The ID of the SIP media application.

Returns:

See Also:

#get_sip_rule(options = {}) ⇒ Types::GetSipRuleResponse

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

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 #=> true/false
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

Options Hash (options):

  • :sip_rule_id (required, String)

    The SIP rule ID.

Returns:

See Also:

#get_user(options = {}) ⇒ 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..is_alexa_for_business_enabled #=> true/false
resp.user..alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

See Also:

#get_user_settings(options = {}) ⇒ 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 #=> true/false
resp..telephony.outbound_calling #=> true/false
resp..telephony.sms #=> true/false

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

See Also:

#get_voice_connector(options = {}) ⇒ Types::GetVoiceConnectorResponse

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.

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 #=> true/false
resp.voice_connector.created_timestamp #=> Time
resp.voice_connector.updated_timestamp #=> Time

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:

#get_voice_connector_emergency_calling_configuration(options = {}) ⇒ Types::GetVoiceConnectorEmergencyCallingConfigurationResponse

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:

#get_voice_connector_group(options = {}) ⇒ Types::GetVoiceConnectorGroupResponse

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems.

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

Options Hash (options):

  • :voice_connector_group_id (required, String)

    The Amazon Chime Voice Connector group ID.

Returns:

See Also:

#get_voice_connector_logging_configuration(options = {}) ⇒ 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.

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 #=> true/false

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:

#get_voice_connector_origination(options = {}) ⇒ Types::GetVoiceConnectorOriginationResponse

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

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 #=> true/false

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:

#get_voice_connector_proxy(options = {}) ⇒ Types::GetVoiceConnectorProxyResponse

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

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 #=> true/false
resp.proxy.fall_back_phone_number #=> String
resp.proxy.phone_number_countries #=> Array
resp.proxy.phone_number_countries[0] #=> String

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime voice connector ID.

Returns:

See Also:

#get_voice_connector_streaming_configuration(options = {}) ⇒ 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.

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 #=> true/false
resp.streaming_configuration.streaming_notification_targets #=> Array
resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:

#get_voice_connector_termination(options = {}) ⇒ Types::GetVoiceConnectorTerminationResponse

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

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 #=> true/false

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:

#get_voice_connector_termination_health(options = {}) ⇒ Types::GetVoiceConnectorTerminationHealthResponse

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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:

#invite_users(options = {}) ⇒ 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"

Options Hash (options):

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

#list_accounts(options = {}) ⇒ 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.

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]. #=> Array
resp.accounts[0].[0].group_name #=> String
resp.next_token #=> String

Options Hash (options):

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

#list_app_instance_admins(options = {}) ⇒ Types::ListAppInstanceAdminsResponse

Returns a list of the administrators in the app instance.

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

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance.

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

#list_app_instance_users(options = {}) ⇒ Types::ListAppInstanceUsersResponse

List all AppInstanceUsers created under a single app instance.

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]. #=> String
resp.next_token #=> String

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance.

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

#list_app_instances(options = {}) ⇒ Types::ListAppInstancesResponse

Lists all Amazon Chime app instances created under a single AWS account.

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]. #=> String
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer)

    The maximum number of app instances that you want to return.

  • :next_token (String)

    The token passed by previous API requests until you reach the maximum number of app instances.

Returns:

See Also:

#list_attendee_tags(options = {}) ⇒ Types::ListAttendeeTagsResponse

Lists the tags applied to an Amazon Chime SDK attendee resource.

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

Options Hash (options):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String)

    The Amazon Chime SDK attendee ID.

Returns:

See Also:

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

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

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

Options Hash (options):

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

#list_bots(options = {}) ⇒ Types::ListBotsResponse

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

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 #=> true/false
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

Options Hash (options):

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

#list_channel_bans(options = {}) ⇒ Types::ListChannelBansResponse

Lists all the users banned from a particular channel.

Examples:

Request syntax with placeholder values


resp = client.list_channel_bans({
  channel_arn: "ChimeArn", # required
  max_results: 1,
  next_token: "NextToken",
})

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

Options Hash (options):

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

Returns:

See Also:

#list_channel_memberships(options = {}) ⇒ Types::ListChannelMembershipsResponse

Lists all channel memberships in a channel.

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

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

Options Hash (options):

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

Returns:

See Also:

#list_channel_memberships_for_app_instance_user(options = {}) ⇒ 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.

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

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. #=> 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

Options Hash (options):

  • :app_instance_user_arn (String)

    The ARN of the app instance users

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

Returns:

See Also:

#list_channel_messages(options = {}) ⇒ Types::ListChannelMessagesResponse

List all the messages in a channel. Returns a paginated list of ChannelMessages. Sorted in descending order by default, based on the creation timestamp.

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.

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

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]. #=> 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 #=> true/false

Options Hash (options):

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

    The initial or starting time stamp for your requested messages.

  • :not_after (Time)

    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.

Returns:

See Also:

#list_channel_moderators(options = {}) ⇒ Types::ListChannelModeratorsResponse

Lists all the moderators for a channel.

Examples:

Request syntax with placeholder values


resp = client.list_channel_moderators({
  channel_arn: "ChimeArn", # required
  max_results: 1,
  next_token: "NextToken",
})

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

Options Hash (options):

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

Returns:

See Also:

#list_channels(options = {}) ⇒ 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.

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

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]. #=> String
resp.channels[0].last_message_timestamp #=> Time
resp.next_token #=> String

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance.

  • :privacy (String)

    The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an app instance administrator 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.

Returns:

See Also:

#list_channels_moderated_by_app_instance_user(options = {}) ⇒ Types::ListChannelsModeratedByAppInstanceUserResponse

A list of the channels moderated by an app instance user.

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

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. #=> String
resp.channels[0].channel_summary.last_message_timestamp #=> Time
resp.next_token #=> String

Options Hash (options):

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

Returns:

See Also:

#list_meeting_tags(options = {}) ⇒ Types::ListMeetingTagsResponse

Lists the tags applied to an Amazon Chime SDK meeting resource.

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

Options Hash (options):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

Returns:

See Also:

#list_meetings(options = {}) ⇒ Types::ListMeetingsResponse

Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.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_region #=> String
resp.next_token #=> String

Options Hash (options):

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

#list_phone_number_orders(options = {}) ⇒ Types::ListPhoneNumberOrdersResponse

Lists the phone number orders for the administrator's Amazon Chime account.

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"
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

Options Hash (options):

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

#list_phone_numbers(options = {}) ⇒ 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.

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
  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].type #=> String, one of "Local", "TollFree"
resp.phone_numbers[0].product_type #=> String, one of "BusinessCalling", "VoiceConnector"
resp.phone_numbers[0].status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
resp.phone_numbers[0].capabilities.inbound_call #=> true/false
resp.phone_numbers[0].capabilities.outbound_call #=> true/false
resp.phone_numbers[0].capabilities.inbound_sms #=> true/false
resp.phone_numbers[0].capabilities.outbound_sms #=> true/false
resp.phone_numbers[0].capabilities.inbound_mms #=> true/false
resp.phone_numbers[0].capabilities.outbound_mms #=> true/false
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

Options Hash (options):

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

#list_proxy_sessions(options = {}) ⇒ Types::ListProxySessionsResponse

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

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

Options Hash (options):

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

#list_room_memberships(options = {}) ⇒ 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.

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

Options Hash (options):

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

#list_rooms(options = {}) ⇒ 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.

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

Options Hash (options):

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

#list_sip_media_applications(options = {}) ⇒ Types::ListSipMediaApplicationsResponse

Lists the SIP media applications under the administrator's AWS account.

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

Options Hash (options):

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

#list_sip_rules(options = {}) ⇒ Types::ListSipRulesResponse

Lists the SIP rules under the administrator's AWS account.

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 #=> true/false
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

Options Hash (options):

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

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

Lists the tags applied to an Amazon Chime SDK meeting resource.

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

Options Hash (options):

  • :resource_arn (required, String)

    The resource ARN.

Returns:

See Also:

#list_users(options = {}) ⇒ 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.

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]..is_alexa_for_business_enabled #=> true/false
resp.users[0]..alexa_for_business_room_arn #=> String
resp.users[0].personal_pin #=> String
resp.next_token #=> String

Options Hash (options):

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

#list_voice_connector_groups(options = {}) ⇒ Types::ListVoiceConnectorGroupsResponse

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

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

Options Hash (options):

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

#list_voice_connector_termination_credentials(options = {}) ⇒ Types::ListVoiceConnectorTerminationCredentialsResponse

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

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

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:

#list_voice_connectors(options = {}) ⇒ Types::ListVoiceConnectorsResponse

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

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 #=> true/false
resp.voice_connectors[0].created_timestamp #=> Time
resp.voice_connectors[0].updated_timestamp #=> Time
resp.next_token #=> String

Options Hash (options):

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

#logout_user(options = {}) ⇒ 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
})

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#put_app_instance_retention_settings(options = {}) ⇒ Types::PutAppInstanceRetentionSettingsResponse

Sets the amount of time in days that a given app instance retains data.

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

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance.

  • :app_instance_retention_settings (required, Types::AppInstanceRetentionSettings)

    The time in days to retain data. Data type: number.

Returns:

See Also:

#put_app_instance_streaming_configurations(options = {}) ⇒ Types::PutAppInstanceStreamingConfigurationsResponse

The data streaming configurations of an app instance.

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

Options Hash (options):

  • :app_instance_arn (required, String)

    The ARN of the app instance.

  • :app_instance_streaming_configurations (required, Array<Types::AppInstanceStreamingConfiguration>)

    The streaming configurations set for an app instance.

Returns:

See Also:

#put_events_configuration(options = {}) ⇒ 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

Options Hash (options):

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

#put_retention_settings(options = {}) ⇒ 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

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :retention_settings (required, Types::RetentionSettings)

    The retention settings.

Returns:

See Also:

#put_sip_media_application_logging_configuration(options = {}) ⇒ Types::PutSipMediaApplicationLoggingConfigurationResponse

Updates the logging configuration for the specified SIP media application.

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 #=> true/false

Options Hash (options):

Returns:

See Also:

#put_voice_connector_emergency_calling_configuration(options = {}) ⇒ 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.

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

Options Hash (options):

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

#put_voice_connector_logging_configuration(options = {}) ⇒ 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.

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

Response structure


resp.logging_configuration.enable_sip_logs #=> true/false

Options Hash (options):

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

#put_voice_connector_origination(options = {}) ⇒ 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.

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 #=> true/false

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :origination (required, Types::Origination)

    The origination setting details to add.

Returns:

See Also:

#put_voice_connector_proxy(options = {}) ⇒ Types::PutVoiceConnectorProxyResponse

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

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 #=> true/false
resp.proxy.fall_back_phone_number #=> String
resp.proxy.phone_number_countries #=> Array
resp.proxy.phone_number_countries[0] #=> String

Options Hash (options):

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

#put_voice_connector_streaming_configuration(options = {}) ⇒ 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 Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

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 #=> true/false
resp.streaming_configuration.streaming_notification_targets #=> Array
resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"

Options Hash (options):

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

#put_voice_connector_termination(options = {}) ⇒ 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.

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 #=> true/false

Options Hash (options):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :termination (required, Types::Termination)

    The termination setting details to add.

Returns:

See Also:

#put_voice_connector_termination_credentials(options = {}) ⇒ Struct

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_termination_credentials({
  voice_connector_id: "NonEmptyString", # required
  credentials: [
    {
      username: "SensitiveString",
      password: "SensitiveString",
    },
  ],
})

Options Hash (options):

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

#redact_channel_message(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.channel_arn #=> String
resp.message_id #=> String

Options Hash (options):

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

Returns:

See Also:

#redact_conversation_message(options = {}) ⇒ 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
})

Options Hash (options):

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

#redact_room_message(options = {}) ⇒ 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
})

Options Hash (options):

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

#regenerate_security_token(options = {}) ⇒ 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 #=> true/false
resp.bot.created_timestamp #=> Time
resp.bot.updated_timestamp #=> Time
resp.bot.bot_email #=> String
resp.bot.security_token #=> String

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

Returns:

See Also:

#reset_personal_pin(options = {}) ⇒ 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..is_alexa_for_business_enabled #=> true/false
resp.user..alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Options Hash (options):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

See Also:

#restore_phone_number(options = {}) ⇒ 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.type #=> String, one of "Local", "TollFree"
resp.phone_number.product_type #=> String, one of "BusinessCalling", "VoiceConnector"
resp.phone_number.status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
resp.phone_number.capabilities.inbound_call #=> true/false
resp.phone_number.capabilities.outbound_call #=> true/false
resp.phone_number.capabilities.inbound_sms #=> true/false
resp.phone_number.capabilities.outbound_sms #=> true/false
resp.phone_number.capabilities.inbound_mms #=> true/false
resp.phone_number.capabilities.outbound_mms #=> true/false
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

Options Hash (options):

  • :phone_number_id (required, String)

    The phone number.

Returns:

See Also:

#search_available_phone_numbers(options = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse

Searches phone numbers that can be ordered.

Examples:

Request syntax with placeholder values


resp = client.search_available_phone_numbers({
  area_code: "String",
  city: "String",
  country: "String",
  state: "String",
  toll_free_prefix: "TollFreePrefix",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.e164_phone_numbers #=> Array
resp.e164_phone_numbers[0] #=> String

Options Hash (options):

  • :area_code (String)

    The area code used to filter results.

  • :city (String)

    The city used to filter results.

  • :country (String)

    The country used to filter results.

  • :state (String)

    The state used to filter results.

  • :toll_free_prefix (String)

    The toll-free prefix that you use to filter results.

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

#send_channel_message(options = {}) ⇒ Types::SendChannelMessageResponse

Sends a message to a particular channel that the member is a part of.

STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

Examples:

Request syntax with placeholder values


resp = client.send_channel_message({
  channel_arn: "ChimeArn", # required