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

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

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

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

  • :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 avalid 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. Defaults to false.

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

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

    @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 and auth errors from expired credentials.

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

  • :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 rasing 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 yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble 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 yeidled by #session_for.

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



251
252
253
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 251

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:



282
283
284
285
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 282

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

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 "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
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:



318
319
320
321
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 318

def associate_phone_numbers_with_voice_connector(params = {}, options = {})
  req = build_request(:associate_phone_numbers_with_voice_connector, 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 "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
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:



354
355
356
357
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 354

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 dissasociated 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 "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
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:



409
410
411
412
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 409

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 "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
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:



456
457
458
459
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 456

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

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

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 "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
resp.phone_number_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



496
497
498
499
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 496

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

Response structure


resp.user_errors #=> Array
resp.user_errors[0].user_id #=> String
resp.user_errors[0].error_code #=> String, one of "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
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:



538
539
540
541
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 538

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"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Amazon Chime account.

Returns:

See Also:



581
582
583
584
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 581

def (params = {}, options = {})
  req = build_request(:create_account, 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:



625
626
627
628
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 625

def create_bot(params = {}, options = {})
  req = build_request(:create_bot, 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 can use only 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:



667
668
669
670
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 667

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

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

Creates an Amazon Chime Voice Connector under the administrator's AWS account. 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
  require_encryption: false, # required
})

Response structure


resp.voice_connector.voice_connector_id #=> String
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.

  • :require_encryption (required, Boolean) —

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

Returns:

See Also:



709
710
711
712
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 709

def create_voice_connector(params = {}, options = {})
  req = build_request(:create_voice_connector, 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:



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

def (params = {}, options = {})
  req = build_request(:delete_account, 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:



771
772
773
774
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 771

def delete_events_configuration(params = {}, options = {})
  req = build_request(:delete_events_configuration, 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:



798
799
800
801
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 798

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

#delete_voice_connector(params = {}) ⇒ Struct

Deletes the specified Amazon Chime Voice Connector. Any phone numbers assigned to the Amazon Chime Voice Connector must be unassigned 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:



822
823
824
825
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 822

def delete_voice_connector(params = {}, options = {})
  req = build_request(:delete_voice_connector, 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:



845
846
847
848
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 845

def delete_voice_connector_origination(params = {}, options = {})
  req = build_request(:delete_voice_connector_origination, 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:



868
869
870
871
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 868

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:



896
897
898
899
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 896

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:



923
924
925
926
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 923

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 number 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 "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
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:



959
960
961
962
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 959

def disassociate_phone_numbers_from_voice_connector(params = {}, options = {})
  req = build_request(:disassociate_phone_numbers_from_voice_connector, 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"

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

See Also:



995
996
997
998
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 995

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:



1031
1032
1033
1034
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1031

def (params = {}, options = {})
  req = build_request(:get_account_settings, 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:



1072
1073
1074
1075
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1072

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:



1107
1108
1109
1110
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1107

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:



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

def get_global_settings(params = {}, options = {})
  req = build_request(:get_global_settings, 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"
resp.phone_number.associations[0].associated_timestamp #=> Time
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:



1176
1177
1178
1179
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1176

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:



1213
1214
1215
1216
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1213

def get_phone_number_order(params = {}, options = {})
  req = build_request(:get_phone_number_order, 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_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.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:



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

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:



1294
1295
1296
1297
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1294

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



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

def get_voice_connector(params = {}, options = {})
  req = build_request(:get_voice_connector, 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:



1363
1364
1365
1366
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1363

def get_voice_connector_origination(params = {}, options = {})
  req = build_request(:get_voice_connector_origination, 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:



1398
1399
1400
1401
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1398

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:



1429
1430
1431
1432
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1429

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 invites to as many as 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
})

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

Returns:

See Also:



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

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.

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



1521
1522
1523
1524
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1521

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.bots #=> Array
resp.bots[0].bot_id #=> String
resp.bots[0].user_id #=> String
resp.bots[0].display_name #=> String
resp.bots[0].bot_type #=> String, one of "ChatBot"
resp.bots[0].disabled #=> 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. Default is 10.

  • :next_token (String) —

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

Returns:

See Also:



1570
1571
1572
1573
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1570

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

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:



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

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, or Amazon Chime Voice Connector.

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
  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"
resp.phone_numbers[0].associations[0].associated_timestamp #=> Time
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:



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

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

Examples:

Request syntax with placeholder values


resp = client.list_users({
  account_id: "NonEmptyString", # required
  user_email: "EmailAddress",
  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_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].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.

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



1738
1739
1740
1741
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1738

def list_users(params = {}, options = {})
  req = build_request(:list_users, 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:



1768
1769
1770
1771
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1768

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.

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



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

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:



1836
1837
1838
1839
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1836

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:



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

def put_events_configuration(params = {}, options = {})
  req = build_request(:put_events_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:



1930
1931
1932
1933
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1930

def put_voice_connector_origination(params = {}, options = {})
  req = build_request(:put_voice_connector_origination, 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:



1975
1976
1977
1978
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1975

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:



2007
2008
2009
2010
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2007

def put_voice_connector_termination_credentials(params = {}, options = {})
  req = build_request(:put_voice_connector_termination_credentials, 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:



2047
2048
2049
2050
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2047

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



2091
2092
2093
2094
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2091

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"
resp.phone_number.associations[0].associated_timestamp #=> Time
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:



2137
2138
2139
2140
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2137

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:



2190
2191
2192
2193
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2190

def search_available_phone_numbers(params = {}, options = {})
  req = build_request(:search_available_phone_numbers, 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"

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:



2230
2231
2232
2233
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2230

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:



2266
2267
2268
2269
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2266

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:



2311
2312
2313
2314
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2311

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:



2343
2344
2345
2346
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2343

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, for the specified phone number ID. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.

Examples:

Request syntax with placeholder values


resp = client.update_phone_number({
  phone_number_id: "String", # required
  product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
})

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"
resp.phone_number.associations[0].associated_timestamp #=> Time
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.

Returns:

See Also:



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

def update_phone_number(params = {}, options = {})
  req = build_request(:update_phone_number, 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
})

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

Returns:

See Also:



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

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:



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

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



2521
2522
2523
2524
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2521

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