Class: Aws::Chime::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

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

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

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

  • :client_side_monitoring (Boolean) — default: false

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

  • :client_side_monitoring_client_id (String) — default: ""

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000

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

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

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

  • :convert_params (Boolean) — default: true

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

  • :correct_clock_skew (Boolean) — default: true

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

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :endpoint (String)

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

  • :endpoint_cache_max_entries (Integer) — default: 1000

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

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

  • :endpoint_discovery (Boolean) — default: false

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info

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

  • :logger (Logger)

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

  • :max_attempts (Integer) — default: 3

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

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

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

  • :retry_backoff (Proc)

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

  • :retry_base_delay (Float) — default: 0.3

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

  • :retry_jitter (Symbol) — default: :none

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

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

  • :retry_limit (Integer) — default: 3

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

  • :retry_max_delay (Integer) — default: 0

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

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

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

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

  • :validate_params (Boolean) — default: true

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

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

  • :http_read_timeout (Integer) — default: 60

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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



305
306
307
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 305

def initialize(*args)
  super
end

Instance Method Details

#associate_phone_number_with_user(params = {}) ⇒ Struct

Associates a phone number with the specified Amazon Chime user.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

  • :e164_phone_number (required, String)

    The phone number, in E.164 format.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



336
337
338
339
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 336

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

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

Associates phone numbers with the specified Amazon Chime Voice Connector.

Examples:

Request syntax with placeholder values


resp = client.associate_phone_numbers_with_voice_connector({
  voice_connector_id: "NonEmptyString", # required
  e164_phone_numbers: ["E164PhoneNumber"],
  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", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

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



379
380
381
382
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 379

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

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

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

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"],
  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", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String)

    The Amazon Chime Voice Connector group ID.

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



422
423
424
425
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 422

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

#associate_signin_delegate_groups_with_account(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

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

    The sign-in delegate groups.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



453
454
455
456
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 453

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

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

Creates up to 100 new attendees for an active Amazon Chime SDK meeting. 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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

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

    The request containing the attendees to create.

Returns:

See Also:



509
510
511
512
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 509

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

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

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be 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", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The room ID.

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

    The list of membership items.

Returns:

See Also:



556
557
558
559
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 556

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_ids (required, Array<String>)

    List of phone number IDs.

Returns:

See Also:



592
593
594
595
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 592

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

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id_list (required, Array<String>)

    The request containing the user IDs to suspend.

Returns:

See Also:



647
648
649
650
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 647

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

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

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the 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", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.user_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id_list (required, Array<String>)

    The request containing the user IDs to unsuspend.

Returns:

See Also:



694
695
696
697
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 694

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

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

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update 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", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

See Also:



742
743
744
745
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 742

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

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

    The request containing the user IDs and details to update.

Returns:

See Also:



789
790
791
792
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 789

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the Amazon Chime account.

Returns:

See Also:



834
835
836
837
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 834

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :external_user_id (required, String)

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

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

    The tag key-value pairs.

Returns:

See Also:



884
885
886
887
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 884

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

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

Creates a bot for an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :display_name (required, String)

    The bot display name.

  • :domain (String)

    The domain of the Amazon Chime Enterprise account.

Returns:

See Also:



928
929
930
931
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 928

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

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

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about 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

Parameters:

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

    ({})

Options Hash (params):

  • :client_request_token (required, String)

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

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

  • :external_meeting_id (String)

    The external meeting ID.

  • :meeting_host_id (String)

    Reserved.

  • :media_region (String)

    The Region in which to create the meeting. Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-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:



1008
1009
1010
1011
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1008

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

#create_phone_number_order(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :product_type (required, String)

    The phone number product type.

  • :e164_phone_numbers (required, Array<String>)

    List of phone numbers, in E.164 format.

Returns:

See Also:



1050
1051
1052
1053
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1050

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime voice connector ID.

  • :participant_phone_numbers (required, Array<String>)

    The participant phone numbers.

  • :name (String)

    The name of the proxy session.

  • :expiry_minutes (Integer)

    The number of minutes allowed for the proxy session.

  • :capabilities (required, Array<String>)

    The proxy session capabilities.

  • :number_selection_behavior (String)

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

  • :geo_match_level (String)

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

  • :geo_match_params (Types::GeoMatchParams)

    The country and area code for the proxy phone number.

Returns:

See Also:



1128
1129
1130
1131
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1128

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :name (required, String)

    The room name.

  • :client_request_token (String)

    The idempotency token for the request.

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

Returns:

See Also:



1172
1173
1174
1175
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1172

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The room ID.

  • :member_id (required, String)

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

  • :role (String)

    The role of the member.

Returns:

See Also:



1223
1224
1225
1226
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1223

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

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

Creates a user under the specified Amazon Chime account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :username (String)

    The user name.

  • :email (String)

    The user's email address.

  • :user_type (String)

    The user type.

Returns:

See Also:



1276
1277
1278
1279
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1276

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the Amazon Chime Voice Connector.

  • :aws_region (String)

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

  • :require_encryption (required, Boolean)

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

Returns:

See Also:



1327
1328
1329
1330
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1327

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

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

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

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the Amazon Chime Voice Connector group.

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

    The Amazon Chime Voice Connectors to route inbound calls to.

Returns:

See Also:



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

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

#delete_account(params = {}) ⇒ Struct

Deletes the specified Amazon Chime account. You must suspend all users before deleting 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1412
1413
1414
1415
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1412

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

#delete_attendee(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String)

    The Amazon Chime SDK attendee ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1446
1447
1448
1449
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1446

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

#delete_events_configuration(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1473
1474
1475
1476
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1473

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

#delete_meeting(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1502
1503
1504
1505
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1502

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

#delete_phone_number(params = {}) ⇒ Struct

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String)

    The phone number ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#delete_proxy_session(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime voice connector ID.

  • :proxy_session_id (required, String)

    The proxy session ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1556
1557
1558
1559
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1556

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

#delete_room(params = {}) ⇒ Struct

Deletes a chat room in an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The chat room ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1582
1583
1584
1585
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1582

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

#delete_room_membership(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The room ID.

  • :member_id (required, String)

    The member ID (user ID or bot ID).

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#delete_voice_connector(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1637
1638
1639
1640
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1637

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

#delete_voice_connector_group(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String)

    The Amazon Chime Voice Connector group ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1661
1662
1663
1664
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1661

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

#delete_voice_connector_origination(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#delete_voice_connector_proxy(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1707
1708
1709
1710
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1707

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

#delete_voice_connector_streaming_configuration(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1730
1731
1732
1733
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1730

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

#delete_voice_connector_termination(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1753
1754
1755
1756
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1753

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

#delete_voice_connector_termination_credentials(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :usernames (Array<String>)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1781
1782
1783
1784
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1781

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

#disassociate_phone_number_from_user(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1808
1809
1810
1811
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1808

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

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

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

Examples:

Request syntax with placeholder values


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

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", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :e164_phone_numbers (Array<String>)

    List of phone numbers, in E.164 format.

Returns:

See Also:



1844
1845
1846
1847
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1844

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

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

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

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

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", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String)

    The Amazon Chime Voice Connector group ID.

  • :e164_phone_numbers (Array<String>)

    List of phone numbers, in E.164 format.

Returns:

See Also:



1880
1881
1882
1883
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1880

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

#disassociate_signin_delegate_groups_from_account(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :group_names (required, Array<String>)

    The sign-in delegate group names.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1907
1908
1909
1910
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1907

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

Returns:

See Also:



1945
1946
1947
1948
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1945

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

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

Returns:

See Also:



1981
1982
1983
1984
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1981

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String)

    The Amazon Chime SDK attendee ID.

Returns:

See Also:



2021
2022
2023
2024
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2021

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

Returns:

See Also:



2097
2098
2099
2100
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2097

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

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

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

Examples:

Response structure


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

Parameters:

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

    ({})

Returns:

See Also:



2120
2121
2122
2123
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2120

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

Returns:

See Also:



2163
2164
2165
2166
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2163

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.phone_number.phone_number_id #=> String
resp.phone_number.e164_phone_number #=> String
resp.phone_number.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 #=> Boolean
resp.phone_number.capabilities.outbound_call #=> Boolean
resp.phone_number.capabilities.inbound_sms #=> Boolean
resp.phone_number.capabilities.outbound_sms #=> Boolean
resp.phone_number.capabilities.inbound_mms #=> Boolean
resp.phone_number.capabilities.outbound_mms #=> Boolean
resp.phone_number.associations #=> Array
resp.phone_number.associations[0].value #=> String
resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
resp.phone_number.associations[0].associated_timestamp #=> Time
resp.phone_number.calling_name #=> String
resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
resp.phone_number.created_timestamp #=> Time
resp.phone_number.updated_timestamp #=> Time
resp.phone_number.deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String)

    The phone number ID.

Returns:

See Also:



2211
2212
2213
2214
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2211

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

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_order_id (required, String)

    The ID for the phone number order.

Returns:

See Also:



2248
2249
2250
2251
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2248

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

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

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

Examples:

Response structure


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

Parameters:

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

    ({})

Returns:

See Also:



2270
2271
2272
2273
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2270

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime voice connector ID.

  • :proxy_session_id (required, String)

    The proxy session ID.

Returns:

See Also:



2319
2320
2321
2322
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2319

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.retention_settings.room_retention_settings.retention_days #=> Integer
resp.retention_settings.conversation_retention_settings.retention_days #=> Integer
resp.initiate_deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

Returns:

See Also:



2357
2358
2359
2360
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2357

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

#get_room(params = {}) ⇒ Types::GetRoomResponse

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The room ID.

Returns:

See Also:



2395
2396
2397
2398
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2395

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

#get_user(params = {}) ⇒ Types::GetUserResponse

Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

See Also:



2444
2445
2446
2447
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2444

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

#get_user_settings(params = {}) ⇒ Types::GetUserSettingsResponse

Retrieves settings for the specified user ID, such as any associated phone number settings.

Examples:

Request syntax with placeholder values


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

Response structure


resp..telephony.inbound_calling #=> Boolean
resp..telephony.outbound_calling #=> Boolean
resp..telephony.sms #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

See Also:



2479
2480
2481
2482
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2479

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



2514
2515
2516
2517
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2514

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

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

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String)

    The Amazon Chime Voice Connector group ID.

Returns:

See Also:



2549
2550
2551
2552
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2549

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

#get_voice_connector_logging_configuration(params = {}) ⇒ Types::GetVoiceConnectorLoggingConfigurationResponse

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Examples:

Request syntax with placeholder values


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

Response structure


resp.logging_configuration.enable_sip_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



2579
2580
2581
2582
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2579

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.origination.routes #=> Array
resp.origination.routes[0].host #=> String
resp.origination.routes[0].port #=> Integer
resp.origination.routes[0].protocol #=> String, one of "TCP", "UDP"
resp.origination.routes[0].priority #=> Integer
resp.origination.routes[0].weight #=> Integer
resp.origination.disabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



2614
2615
2616
2617
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2614

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.proxy.default_session_expiry_minutes #=> Integer
resp.proxy.disabled #=> Boolean
resp.proxy.fall_back_phone_number #=> String
resp.proxy.phone_number_countries #=> Array
resp.proxy.phone_number_countries[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime voice connector ID.

Returns:

See Also:



2647
2648
2649
2650
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2647

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

#get_voice_connector_streaming_configuration(params = {}) ⇒ Types::GetVoiceConnectorStreamingConfigurationResponse

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Examples:

Request syntax with placeholder values


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

Response structure


resp.streaming_configuration.data_retention_in_hours #=> Integer
resp.streaming_configuration.disabled #=> Boolean
resp.streaming_configuration.streaming_notification_targets #=> Array
resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



2681
2682
2683
2684
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2681

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.termination.cps_limit #=> Integer
resp.termination.default_phone_number #=> String
resp.termination.calling_regions #=> Array
resp.termination.calling_regions[0] #=> String
resp.termination.cidr_allowed_list #=> Array
resp.termination.cidr_allowed_list[0] #=> String
resp.termination.disabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



2716
2717
2718
2719
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2716

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

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

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

Examples:

Request syntax with placeholder values


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

Response structure


resp.termination_health.timestamp #=> Time
resp.termination_health.source #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



2747
2748
2749
2750
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2747

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

#invite_users(params = {}) ⇒ Types::InviteUsersResponse

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

Examples:

Request syntax with placeholder values


resp = client.invite_users({
  account_id: "NonEmptyString", # required
  user_email_list: ["EmailAddress"], # required
  user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
})

Response structure


resp.invites #=> Array
resp.invites[0].invite_id #=> String
resp.invites[0].status #=> String, one of "Pending", "Accepted", "Failed"
resp.invites[0].email_address #=> String
resp.invites[0].email_status #=> String, one of "NotSent", "Sent", "Failed"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_email_list (required, Array<String>)

    The user email addresses to which to send the email invitation.

  • :user_type (String)

    The user type.

Returns:

See Also:



2789
2790
2791
2792
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2789

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

#list_accounts(params = {}) ⇒ Types::ListAccountsResponse

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

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

Examples:

Request syntax with placeholder values


resp = client.list_accounts({
  name: "AccountName",
  user_email: "EmailAddress",
  next_token: "String",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (String)

    Amazon Chime account name prefix with which to filter results.

  • :user_email (String)

    User email address with which to filter results.

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



2847
2848
2849
2850
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2847

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

#list_attendee_tags(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String)

    The Amazon Chime SDK attendee ID.

Returns:

See Also:



2881
2882
2883
2884
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2881

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.attendees #=> Array
resp.attendees[0].external_user_id #=> String
resp.attendees[0].attendee_id #=> String
resp.attendees[0].join_token #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



2930
2931
2932
2933
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2930

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_bots({
  account_id: "NonEmptyString", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.bots #=> Array
resp.bots[0].bot_id #=> String
resp.bots[0].user_id #=> String
resp.bots[0].display_name #=> String
resp.bots[0].bot_type #=> String, one of "ChatBot"
resp.bots[0].disabled #=> Boolean
resp.bots[0].created_timestamp #=> Time
resp.bots[0].updated_timestamp #=> Time
resp.bots[0].bot_email #=> String
resp.bots[0].security_token #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :max_results (Integer)

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

  • :next_token (String)

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

Returns:

See Also:



2981
2982
2983
2984
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2981

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

#list_meeting_tags(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

Returns:

See Also:



3011
3012
3013
3014
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3011

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



3063
3064
3065
3066
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3063

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_phone_number_orders({
  next_token: "String",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



3108
3109
3110
3111
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3108

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

#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

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

Examples:

Request syntax with placeholder values


resp = client.list_phone_numbers({
  status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
  product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
  filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId
  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 #=> Boolean
resp.phone_numbers[0].capabilities.outbound_call #=> Boolean
resp.phone_numbers[0].capabilities.inbound_sms #=> Boolean
resp.phone_numbers[0].capabilities.outbound_sms #=> Boolean
resp.phone_numbers[0].capabilities.inbound_mms #=> Boolean
resp.phone_numbers[0].capabilities.outbound_mms #=> Boolean
resp.phone_numbers[0].associations #=> Array
resp.phone_numbers[0].associations[0].value #=> String
resp.phone_numbers[0].associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
resp.phone_numbers[0].associations[0].associated_timestamp #=> Time
resp.phone_numbers[0].calling_name #=> String
resp.phone_numbers[0].calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
resp.phone_numbers[0].created_timestamp #=> Time
resp.phone_numbers[0].updated_timestamp #=> Time
resp.phone_numbers[0].deletion_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :status (String)

    The phone number status.

  • :product_type (String)

    The phone number product type.

  • :filter_name (String)

    The filter to use to limit the number of results.

  • :filter_value (String)

    The value to use for the filter.

  • :max_results (Integer)

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

  • :next_token (String)

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

Returns:

See Also:



3182
3183
3184
3185
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3182

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_proxy_sessions({
  voice_connector_id: "NonEmptyString128", # required
  status: "Open", # accepts Open, InProgress, Closed
  next_token: "NextTokenString",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime voice connector ID.

  • :status (String)

    The proxy session status.

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



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

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

#list_room_memberships(params = {}) ⇒ Types::ListRoomMembershipsResponse

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

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

Examples:

Request syntax with placeholder values


resp = client.list_room_memberships({
  account_id: "NonEmptyString", # required
  room_id: "NonEmptyString", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.room_memberships #=> Array
resp.room_memberships[0].room_id #=> String
resp.room_memberships[0].member.member_id #=> String
resp.room_memberships[0].member.member_type #=> String, one of "User", "Bot", "Webhook"
resp.room_memberships[0].member.email #=> String
resp.room_memberships[0].member.full_name #=> String
resp.room_memberships[0].member. #=> String
resp.room_memberships[0].role #=> String, one of "Administrator", "Member"
resp.room_memberships[0].invited_by #=> String
resp.room_memberships[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The room ID.

  • :max_results (Integer)

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

  • :next_token (String)

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

Returns:

See Also:



3299
3300
3301
3302
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3299

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

#list_rooms(params = {}) ⇒ Types::ListRoomsResponse

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

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

Examples:

Request syntax with placeholder values


resp = client.list_rooms({
  account_id: "NonEmptyString", # required
  member_id: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.rooms #=> Array
resp.rooms[0].room_id #=> String
resp.rooms[0].name #=> String
resp.rooms[0]. #=> String
resp.rooms[0].created_by #=> String
resp.rooms[0].created_timestamp #=> Time
resp.rooms[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :member_id (String)

    The member ID (user ID or bot ID).

  • :max_results (Integer)

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

  • :next_token (String)

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

Returns:

See Also:



3351
3352
3353
3354
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3351

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

#list_tags_for_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The resource ARN.

Returns:

See Also:



3381
3382
3383
3384
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3381

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

#list_users(params = {}) ⇒ Types::ListUsersResponse

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

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

Examples:

Request syntax with placeholder values


resp = client.list_users({
  account_id: "NonEmptyString", # required
  user_email: "EmailAddress",
  user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
  max_results: 1,
  next_token: "String",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_email (String)

    Optional. The user email address used to filter results. Maximum 1.

  • :user_type (String)

    The user type.

  • :max_results (Integer)

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

  • :next_token (String)

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

Returns:

See Also:



3446
3447
3448
3449
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3446

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_voice_connector_groups({
  next_token: "String",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



3490
3491
3492
3493
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3490

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



3520
3521
3522
3523
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3520

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_voice_connectors({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.voice_connectors #=> Array
resp.voice_connectors[0].voice_connector_id #=> String
resp.voice_connectors[0].aws_region #=> String, one of "us-east-1", "us-west-2"
resp.voice_connectors[0].name #=> String
resp.voice_connectors[0].outbound_host_name #=> String
resp.voice_connectors[0].require_encryption #=> Boolean
resp.voice_connectors[0].created_timestamp #=> Time
resp.voice_connectors[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



3564
3565
3566
3567
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3564

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

#logout_user(params = {}) ⇒ Struct

Logs out the specified user from all of the devices they are currently logged into.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#put_events_configuration(params = {}) ⇒ Types::PutEventsConfigurationResponse

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

Examples:

Request syntax with placeholder values


resp = client.put_events_configuration({
  account_id: "NonEmptyString", # required
  bot_id: "NonEmptyString", # required
  outbound_events_https_endpoint: "SensitiveString",
  lambda_function_arn: "SensitiveString",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

  • :outbound_events_https_endpoint (String)

    HTTPS endpoint that allows the bot to receive outgoing events.

  • :lambda_function_arn (String)

    Lambda function ARN that allows the bot to receive outgoing events.

Returns:

See Also:



3635
3636
3637
3638
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3635

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

#put_retention_settings(params = {}) ⇒ Types::PutRetentionSettingsResponse

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.

To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Examples:

Request syntax with placeholder values


resp = client.put_retention_settings({
  account_id: "NonEmptyString", # required
  retention_settings: { # required
    room_retention_settings: {
      retention_days: 1,
    },
    conversation_retention_settings: {
      retention_days: 1,
    },
  },
})

Response structure


resp.retention_settings.room_retention_settings.retention_days #=> Integer
resp.retention_settings.conversation_retention_settings.retention_days #=> Integer
resp.initiate_deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :retention_settings (required, Types::RetentionSettings)

    The retention settings.

Returns:

See Also:



3692
3693
3694
3695
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3692

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

#put_voice_connector_logging_configuration(params = {}) ⇒ Types::PutVoiceConnectorLoggingConfigurationResponse

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :logging_configuration (required, Types::LoggingConfiguration)

    The logging configuration details to add.

Returns:

See Also:



3728
3729
3730
3731
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3728

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

#put_voice_connector_origination(params = {}) ⇒ Types::PutVoiceConnectorOriginationResponse

Adds origination settings for the specified Amazon Chime Voice Connector.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_origination({
  voice_connector_id: "NonEmptyString", # required
  origination: { # required
    routes: [
      {
        host: "String",
        port: 1,
        protocol: "TCP", # accepts TCP, UDP
        priority: 1,
        weight: 1,
      },
    ],
    disabled: false,
  },
})

Response structure


resp.origination.routes #=> Array
resp.origination.routes[0].host #=> String
resp.origination.routes[0].port #=> Integer
resp.origination.routes[0].protocol #=> String, one of "TCP", "UDP"
resp.origination.routes[0].priority #=> Integer
resp.origination.routes[0].weight #=> Integer
resp.origination.disabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :origination (required, Types::Origination)

    The origination setting details to add.

Returns:

See Also:



3778
3779
3780
3781
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3778

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

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

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

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_proxy({
  voice_connector_id: "NonEmptyString128", # required
  default_session_expiry_minutes: 1, # required
  phone_number_pool_countries: ["Country"], # required
  fall_back_phone_number: "E164PhoneNumber",
  disabled: false,
})

Response structure


resp.proxy.default_session_expiry_minutes #=> Integer
resp.proxy.disabled #=> Boolean
resp.proxy.fall_back_phone_number #=> String
resp.proxy.phone_number_countries #=> Array
resp.proxy.phone_number_countries[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime voice connector ID.

  • :default_session_expiry_minutes (required, Integer)

    The default number of minutes allowed for proxy sessions.

  • :phone_number_pool_countries (required, Array<String>)

    The countries for proxy phone numbers to be selected from.

  • :fall_back_phone_number (String)

    The phone number to route calls to after a proxy session expires.

  • :disabled (Boolean)

    When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

Returns:

See Also:



3828
3829
3830
3831
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3828

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

#put_voice_connector_streaming_configuration(params = {}) ⇒ Types::PutVoiceConnectorStreamingConfigurationResponse

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to 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 #=> Boolean
resp.streaming_configuration.streaming_notification_targets #=> Array
resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :streaming_configuration (required, Types::StreamingConfiguration)

    The streaming configuration details to add.

Returns:

See Also:



3874
3875
3876
3877
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3874

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

#put_voice_connector_termination(params = {}) ⇒ Types::PutVoiceConnectorTerminationResponse

Adds termination settings for the specified Amazon Chime Voice Connector.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_termination({
  voice_connector_id: "NonEmptyString", # required
  termination: { # required
    cps_limit: 1,
    default_phone_number: "E164PhoneNumber",
    calling_regions: ["CallingRegion"],
    cidr_allowed_list: ["String"],
    disabled: false,
  },
})

Response structure


resp.termination.cps_limit #=> Integer
resp.termination.default_phone_number #=> String
resp.termination.calling_regions #=> Array
resp.termination.calling_regions[0] #=> String
resp.termination.cidr_allowed_list #=> Array
resp.termination.cidr_allowed_list[0] #=> String
resp.termination.disabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :termination (required, Types::Termination)

    The termination setting details to add.

Returns:

See Also:



3919
3920
3921
3922
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3919

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

#put_voice_connector_termination_credentials(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :credentials (Array<Types::Credential>)

    The termination SIP credentials.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3951
3952
3953
3954
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3951

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

#redact_conversation_message(params = {}) ⇒ Struct

Redacts the specified message from the specified Amazon Chime conversation.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :conversation_id (required, String)

    The conversation ID.

  • :message_id (required, String)

    The message ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3982
3983
3984
3985
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3982

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

#redact_room_message(params = {}) ⇒ Struct

Redacts the specified message from the specified Amazon Chime chat room.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The room ID.

  • :message_id (required, String)

    The message ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4013
4014
4015
4016
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4013

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

#regenerate_security_token(params = {}) ⇒ Types::RegenerateSecurityTokenResponse

Regenerates the security token for a bot.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

Returns:

See Also:



4053
4054
4055
4056
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4053

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

#reset_personal_pin(params = {}) ⇒ Types::ResetPersonalPINResponse

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

See Also:



4100
4101
4102
4103
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4100

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

#restore_phone_number(params = {}) ⇒ Types::RestorePhoneNumberResponse

Moves a phone number from the Deletion queue back into the phone number Inventory.

Examples:

Request syntax with placeholder values


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

Response structure


resp.phone_number.phone_number_id #=> String
resp.phone_number.e164_phone_number #=> String
resp.phone_number.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 #=> Boolean
resp.phone_number.capabilities.outbound_call #=> Boolean
resp.phone_number.capabilities.inbound_sms #=> Boolean
resp.phone_number.capabilities.outbound_sms #=> Boolean
resp.phone_number.capabilities.inbound_mms #=> Boolean
resp.phone_number.capabilities.outbound_mms #=> Boolean
resp.phone_number.associations #=> Array
resp.phone_number.associations[0].value #=> String
resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
resp.phone_number.associations[0].associated_timestamp #=> Time
resp.phone_number.calling_name #=> String
resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
resp.phone_number.created_timestamp #=> Time
resp.phone_number.updated_timestamp #=> Time
resp.phone_number.deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String)

    The phone number.

Returns:

See Also:



4148
4149
4150
4151
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4148

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

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

Searches 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

Parameters:

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

    ({})

Options Hash (params):

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



4201
4202
4203
4204
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4201

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

#tag_attendee(params = {}) ⇒ Struct

Applies the specified tags to the specified Amazon Chime SDK attendee.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String)

    The Amazon Chime SDK attendee ID.

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

    The tag key-value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4236
4237
4238
4239
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4236

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

#tag_meeting(params = {}) ⇒ Struct

Applies the specified tags to the specified Amazon Chime SDK meeting.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

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

    The tag key-value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4267
4268
4269
4270
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4267

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

#tag_resource(params = {}) ⇒ Struct

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The resource ARN.

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

    The tag key-value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4299
4300
4301
4302
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4299

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

#untag_attendee(params = {}) ⇒ Struct

Untags the specified tags from the specified Amazon Chime SDK attendee.

Examples:

Request syntax with placeholder values


resp = client.untag_attendee({
  meeting_id: "GuidString", # required
  attendee_id: "GuidString", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String)

    The Amazon Chime SDK attendee ID.

  • :tag_keys (required, Array<String>)

    The tag keys.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4330
4331
4332
4333
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4330

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

#untag_meeting(params = {}) ⇒ Struct

Untags the specified tags from the specified Amazon Chime SDK meeting.

Examples:

Request syntax with placeholder values


resp = client.untag_meeting({
  meeting_id: "GuidString", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :tag_keys (required, Array<String>)

    The tag keys.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4356
4357
4358
4359
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4356

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

#untag_resource(params = {}) ⇒ Struct

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The resource ARN.

  • :tag_keys (required, Array<String>)

    The tag keys.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#update_account(params = {}) ⇒ Types::UpdateAccountResponse

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

Examples:

Request syntax with placeholder values


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

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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :name (String)

    The new name for the specified Amazon Chime account.

Returns:

See Also:



4425
4426
4427
4428
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4425

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

#update_account_settings(params = {}) ⇒ Struct

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "NonEmptyString", # required
  account_settings: { # required
    disable_remote_control: false,
    enable_dial_out: false,
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :account_settings (required, Types::AccountSettings)

    The Amazon Chime account settings to update.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4461
4462
4463
4464
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4461

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

#update_bot(params = {}) ⇒ Types::UpdateBotResponse

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :bot_id (required, String)

    The bot ID.

  • :disabled (Boolean)

    When true, stops the specified bot from running in your account.

Returns:

See Also:



4506
4507
4508
4509
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4506

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

#update_global_settings(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.update_global_settings({
  business_calling: { # required
    cdr_bucket: "String",
  },
  voice_connector: { # required
    cdr_bucket: "String",
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4538
4539
4540
4541
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4538

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

#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResponse

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For toll-free numbers, you 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.update_phone_number({
  phone_number_id: "String", # required
  product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
  calling_name: "CallingName",
})

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 #=> Boolean
resp.phone_number.capabilities.outbound_call #=> Boolean
resp.phone_number.capabilities.inbound_sms #=> Boolean
resp.phone_number.capabilities.outbound_sms #=> Boolean
resp.phone_number.capabilities.inbound_mms #=> Boolean
resp.phone_number.capabilities.outbound_mms #=> Boolean
resp.phone_number.associations #=> Array
resp.phone_number.associations[0].value #=> String
resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
resp.phone_number.associations[0].associated_timestamp #=> Time
resp.phone_number.calling_name #=> String
resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
resp.phone_number.created_timestamp #=> Time
resp.phone_number.updated_timestamp #=> Time
resp.phone_number.deletion_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String)

    The phone number ID.

  • :product_type (String)

    The product type.

  • :calling_name (String)

    The outbound calling name associated with the phone number.

Returns:

See Also:



4603
4604
4605
4606
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4603

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

#update_phone_number_settings(params = {}) ⇒ Struct

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

Examples:

Request syntax with placeholder values


resp = client.update_phone_number_settings({
  calling_name: "CallingName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :calling_name (required, String)

    The default outbound calling name for the account.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4628
4629
4630
4631
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4628

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

#update_proxy_session(params = {}) ⇒ Types::UpdateProxySessionResponse

Updates the specified proxy session details, such as voice or SMS capabilities.

Examples:

Request syntax with placeholder values


resp = client.update_proxy_session({
  voice_connector_id: "NonEmptyString128", # required
  proxy_session_id: "NonEmptyString128", # required
  capabilities: ["Voice"], # required, accepts Voice, SMS
  expiry_minutes: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime voice connector ID.

  • :proxy_session_id (required, String)

    The proxy session ID.

  • :capabilities (required, Array<String>)

    The proxy session capabilities.

  • :expiry_minutes (Integer)

    The number of minutes allowed for the proxy session.

Returns:

See Also:



4685
4686
4687
4688
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4685

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

#update_room(params = {}) ⇒ Types::UpdateRoomResponse

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The room ID.

  • :name (String)

    The room name.

Returns:

See Also:



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

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

#update_room_membership(params = {}) ⇒ Types::UpdateRoomMembershipResponse

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :room_id (required, String)

    The room ID.

  • :member_id (required, String)

    The member ID.

  • :role (String)

    The role of the member.

Returns:

See Also:



4778
4779
4780
4781
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4778

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

#update_user(params = {}) ⇒ Types::UpdateUserResponse

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

  • :license_type (String)

    The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

  • :user_type (String)

    The user type.

  • :alexa_for_business_metadata (Types::AlexaForBusinessMetadata)

    The Alexa for Business metadata.

Returns:

See Also:



4840
4841
4842
4843
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4840

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

#update_user_settings(params = {}) ⇒ Struct

Updates the settings for the specified user, such as phone number settings.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "String", # required
  user_id: "String", # required
  user_settings: { # required
    telephony: { # required
      inbound_calling: false, # required
      outbound_calling: false, # required
      sms: false, # required
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

  • :user_settings (required, Types::UserSettings)

    The user settings to update.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4877
4878
4879
4880
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4877

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

#update_voice_connector(params = {}) ⇒ Types::UpdateVoiceConnectorResponse

Updates details for the specified Amazon Chime Voice Connector.

Examples:

Request syntax with placeholder values


resp = client.update_voice_connector({
  voice_connector_id: "NonEmptyString", # required
  name: "VoiceConnectorName", # required
  require_encryption: false, # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

  • :name (required, String)

    The name of the Amazon Chime Voice Connector.

  • :require_encryption (required, Boolean)

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

Returns:

See Also:



4920
4921
4922
4923
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4920

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

#update_voice_connector_group(params = {}) ⇒ Types::UpdateVoiceConnectorGroupResponse

Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String)

    The Amazon Chime Voice Connector group ID.

  • :name (required, String)

    The name of the Amazon Chime Voice Connector group.

  • :voice_connector_items (required, Array<Types::VoiceConnectorItem>)

    The VoiceConnectorItems to associate with the group.

Returns:

See Also:



4968
4969
4970
4971
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4968

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