Class: Aws::Chime::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

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

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

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

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

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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. Takes effect only when disable_clock_skew_correction is not set.

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

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

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

    The log formatter.

  • :log_level (Symbol) — default: :info —

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

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

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

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

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

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

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

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

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::Chime::EndpointProvider) —

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



478
479
480
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 478

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:



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

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



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

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

    The list of membership items.

Returns:

See Also:



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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    List of phone number IDs.

Returns:

See Also:



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

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

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

    The request containing the user IDs to suspend.

Returns:

See Also:



678
679
680
681
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 678

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

    The request containing the user IDs to unsuspend.

Returns:

See Also:



726
727
728
729
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 726

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

See Also:



774
775
776
777
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 774

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

    The request containing the user IDs and details to update.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Amazon Chime account.

Returns:

See Also:



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

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:



911
912
913
914
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 911

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

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

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

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

This API is not available in a dedicated namespace.

Examples:

Request syntax with placeholder values


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

Response structure


resp.transaction_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :from_phone_number (required, String) —

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

  • :to_phone_number (required, String) —

    Phone number called when inviting someone to a meeting.

  • :join_token (required, String) —

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

Returns:

See Also:



966
967
968
969
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 966

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :product_type (required, String) —

    The phone number product type.

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

    List of phone numbers, in E.164 format.

Returns:

See Also:



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

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



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

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:



1103
1104
1105
1106
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1103

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.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :username (String) —

    The user name.

  • :email (String) —

    The user's email address.

  • :user_type (String) —

    The user type.

Returns:

See Also:



1156
1157
1158
1159
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1156

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

#delete_account(params = {}) ⇒ Struct

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

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

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1191
1192
1193
1194
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1191

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:



1218
1219
1220
1221
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1218

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:



1245
1246
1247
1248
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1245

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



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

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:



1302
1303
1304
1305
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1302

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



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

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



1356
1357
1358
1359
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1356

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

See Also:



1395
1396
1397
1398
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1395

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

See Also:



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

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:



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

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:



1507
1508
1509
1510
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1507

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:



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

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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number ID.

Returns:

See Also:



1579
1580
1581
1582
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1579

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_order_id (required, String) —

    The ID for the phone number order.

Returns:

See Also:



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

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:



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

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



1676
1677
1678
1679
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1676

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:



1714
1715
1716
1717
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1714

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.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

Returns:

See Also:



1763
1764
1765
1766
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1763

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:



1798
1799
1800
1801
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1798

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



1840
1841
1842
1843
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1840

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    Amazon Chime account name prefix with which to filter results.

  • :user_email (String) —

    User email address with which to filter results.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



1899
1900
1901
1902
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1899

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.

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:



1950
1951
1952
1953
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1950

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.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



1995
1996
1997
1998
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1995

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_phone_numbers({
  status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
  product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector, SipMediaApplicationDialIn
  filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId, SipRuleId
  filter_value: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :status (String) —

    The phone number status.

  • :product_type (String) —

    The phone number product type.

  • :filter_name (String) —

    The filter to use to limit the number of results.

  • :filter_value (String) —

    The value to use for the filter.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2070
2071
2072
2073
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2070

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



2125
2126
2127
2128
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2125

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:



2177
2178
2179
2180
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2177

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

#list_supported_phone_number_countries(params = {}) ⇒ Types::ListSupportedPhoneNumberCountriesResponse

Lists supported phone number countries.

Examples:

Request syntax with placeholder values


resp = client.list_supported_phone_number_countries({
  product_type: "BusinessCalling", # required, accepts BusinessCalling, VoiceConnector, SipMediaApplicationDialIn
})

Response structure


resp.phone_number_countries #=> Array
resp.phone_number_countries[0].country_code #=> String
resp.phone_number_countries[0].supported_phone_number_types #=> Array
resp.phone_number_countries[0].supported_phone_number_types[0] #=> String, one of "Local", "TollFree"

Parameters:

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

    ({})

Options Hash (params):

  • :product_type (required, String) —

    The phone number product type.

Returns:

See Also:



2208
2209
2210
2211
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2208

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_email (String) —

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

  • :user_type (String) —

    The user type.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2273
2274
2275
2276
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2273

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



2300
2301
2302
2303
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2300

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:



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

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:



2401
2402
2403
2404
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2401

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



2432
2433
2434
2435
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2432

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

#redact_room_message(params = {}) ⇒ Struct

Redacts the specified message from the specified Amazon Chime channel.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

  • :message_id (required, String) —

    The message ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2462
2463
2464
2465
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2462

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:



2502
2503
2504
2505
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2502

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number.

Returns:

See Also:



2598
2599
2600
2601
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2598

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

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

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

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

Examples:

Request syntax with placeholder values


resp = client.search_available_phone_numbers({
  area_code: "String",
  city: "String",
  country: "Alpha2CountryCode",
  state: "String",
  toll_free_prefix: "TollFreePrefix",
  phone_number_type: "Local", # accepts Local, TollFree
  max_results: 1,
  next_token: "String",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :area_code (String) —

    The area code used to filter results. Only applies to the US.

  • :city (String) —

    The city used to filter results. Only applies to the US.

  • :country (String) —

    The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

  • :state (String) —

    The state used to filter results. Required only if you provide City. Only applies to the US.

  • :toll_free_prefix (String) —

    The toll-free prefix that you use to filter results. Only applies to the US.

  • :phone_number_type (String) —

    The phone number type used to filter results. Required for non-US numbers.

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token used to retrieve the next page of results.

Returns:

See Also:



2667
2668
2669
2670
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2667

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 and default license updates are supported for this action.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "NonEmptyString", # required
  name: "AccountName",
  default_license: "Basic", # accepts Basic, Plus, Pro, ProTrial
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :name (String) —

    The new name for the specified Amazon Chime account.

  • :default_license (String) —

    The default license applied when you add users to an Amazon Chime account.

Returns:

See Also:



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

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:



2752
2753
2754
2755
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2752

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:



2797
2798
2799
2800
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2797

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: {
    cdr_bucket: "String",
  },
  voice_connector: {
    cdr_bucket: "String",
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2829
2830
2831
2832
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2829

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number ID.

  • :product_type (String) —

    The product type.

  • :calling_name (String) —

    The outbound calling name associated with the phone number.

Returns:

See Also:



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

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:



2921
2922
2923
2924
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2921

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



2963
2964
2965
2966
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2963

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:



3014
3015
3016
3017
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3014

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.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
resp.user.personal_pin #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

  • :license_type (String) —

    The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

  • :user_type (String) —

    The user type.

  • :alexa_for_business_metadata (Types::AlexaForBusinessMetadata) —

    The Alexa for Business metadata.

Returns:

See Also:



3076
3077
3078
3079
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3076

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:



3113
3114
3115
3116
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3113

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