Class: Aws::Chime::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

    • Aws::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, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :endpoint (String) —

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

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

  • :retry_jitter (Symbol) — default: :none —

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

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

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

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

  • :validate_params (Boolean) — default: true —

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

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

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

  • :http_open_timeout (Float) — default: 15 —

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

  • :http_read_timeout (Integer) — default: 60 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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



324
325
326
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 324

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:



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

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

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

Associates phone numbers with the specified Amazon Chime Voice Connector.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

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

    List of phone numbers, in E.164 format.

  • :force_associate (Boolean) —

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

Returns:

See Also:



398
399
400
401
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 398

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Amazon Chime Voice Connector group ID.

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

    List of phone numbers, in E.164 format.

  • :force_associate (Boolean) —

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

Returns:

See Also:



441
442
443
444
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 441

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

#associate_signin_delegate_groups_with_account(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

    The sign-in delegate groups.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



472
473
474
475
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 472

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.attendees #=> Array
resp.attendees[0].external_user_id #=> String
resp.attendees[0].attendee_id #=> String
resp.attendees[0].join_token #=> String
resp.errors #=> Array
resp.errors[0].external_user_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

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

    The request containing the attendees to create.

Returns:

See Also:



528
529
530
531
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 528

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

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

Adds a specified number of users to a channel.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

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

  • :type (String) —

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

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

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

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The room ID.

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

    The list of membership items.

Returns:

See Also:



630
631
632
633
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 630

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:



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

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:



721
722
723
724
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 721

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:



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

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:



817
818
819
820
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 817

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:



864
865
866
867
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 864

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:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.app_instance_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the AppInstance.

  • :metadata (String) —

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

  • :client_request_token (required, String) —

    The ClientRequestToken of the AppInstance.

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

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

    Tags assigned to the AppInstanceUser.

Returns:

See Also:



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

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

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

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

  • ChannelModerator actions across all channels in the AppInstance.

  • DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_admin_arn (required, String) —

    The ARN of the administrator of the current AppInstance.

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



1004
1005
1006
1007
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1004

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.app_instance_user_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance request.

  • :app_instance_user_id (required, String) —

    The user ID of the AppInstance.

  • :name (required, String) —

    The user's name.

  • :metadata (String) —

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

  • :client_request_token (required, String) —

    The token assigned to the user requesting an AppInstance.

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

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

    Tags assigned to the AppInstanceUser.

Returns:

See Also:



1061
1062
1063
1064
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1061

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :external_user_id (required, String) —

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

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

    The tag key-value pairs.

Returns:

See Also:



1111
1112
1113
1114
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1111

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

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

Creates a bot for an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :display_name (required, String) —

    The bot display name.

  • :domain (String) —

    The domain of the Amazon Chime Enterprise account.

Returns:

See Also:



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

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.channel_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the channel request.

  • :name (required, String) —

    The name of the channel.

  • :mode (String) —

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

  • :privacy (String) —

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

  • :metadata (String) —

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

  • :client_request_token (required, String) —

    The client token for the request. An Idempotency token.

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

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

    The tags for the creation request.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



1232
1233
1234
1235
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1232

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the ban request.

  • :member_arn (required, String) —

    The ARN of the member being banned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



1283
1284
1285
1286
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1283

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

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

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

  • List messages

  • Send messages

  • Receive messages

  • Edit their own messages

  • Leave the channel

Privacy settings impact this action as follows:

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

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

  • :member_arn (required, String) —

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

  • :type (required, String) —

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

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



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

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

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

Creates a new ChannelModerator. A channel moderator can:

  • Add and remove other members of the channel.

  • Add and remove other moderators of the channel.

  • Add and remove user bans for the channel.

  • Redact messages in the channel.

  • List messages in the channel.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :channel_moderator_arn (required, String) —

    The ARN of the moderator.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



1409
1410
1411
1412
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1409

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

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

Creates a media capture pipeline.

Examples:

Request syntax with placeholder values


resp = client.create_media_capture_pipeline({
  source_type: "ChimeSdkMeeting", # required, accepts ChimeSdkMeeting
  source_arn: "Arn", # required
  sink_type: "S3Bucket", # required, accepts S3Bucket
  sink_arn: "Arn", # required
  client_request_token: "ClientRequestToken",
})

Response structure


resp.media_capture_pipeline.media_pipeline_id #=> String
resp.media_capture_pipeline.source_type #=> String, one of "ChimeSdkMeeting"
resp.media_capture_pipeline.source_arn #=> String
resp.media_capture_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
resp.media_capture_pipeline.sink_type #=> String, one of "S3Bucket"
resp.media_capture_pipeline.sink_arn #=> String
resp.media_capture_pipeline.created_timestamp #=> Time
resp.media_capture_pipeline.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :source_type (required, String) —

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

  • :source_arn (required, String) —

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

  • :sink_type (required, String) —

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

  • :sink_arn (required, String) —

    The ARN of the sink type.

  • :client_request_token (String) —

    The token assigned to the client making the pipeline request.

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

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.meeting.meeting_id #=> String
resp.meeting.external_meeting_id #=> String
resp.meeting.media_placement.audio_host_url #=> String
resp.meeting.media_placement.audio_fallback_url #=> String
resp.meeting.media_placement.screen_data_url #=> String
resp.meeting.media_placement.screen_sharing_url #=> String
resp.meeting.media_placement.screen_viewing_url #=> String
resp.meeting.media_placement.signaling_url #=> String
resp.meeting.media_placement.turn_control_url #=> String
resp.meeting.media_placement.event_ingestion_url #=> String
resp.meeting.media_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_request_token (required, String) —

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

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

  • :external_meeting_id (String) —

    The external meeting ID.

  • :meeting_host_id (String) —

    Reserved.

  • :media_region (String) —

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

    Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

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

    The tag key-value pairs.

  • :notifications_configuration (Types::MeetingNotificationConfiguration) —

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

Returns:

See Also:



1552
1553
1554
1555
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1552

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

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

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

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

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:



1605
1606
1607
1608
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1605

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.meeting.meeting_id #=> String
resp.meeting.external_meeting_id #=> String
resp.meeting.media_placement.audio_host_url #=> String
resp.meeting.media_placement.audio_fallback_url #=> String
resp.meeting.media_placement.screen_data_url #=> String
resp.meeting.media_placement.screen_sharing_url #=> String
resp.meeting.media_placement.screen_viewing_url #=> String
resp.meeting.media_placement.signaling_url #=> String
resp.meeting.media_placement.turn_control_url #=> String
resp.meeting.media_placement.event_ingestion_url #=> String
resp.meeting.media_region #=> String
resp.attendees #=> Array
resp.attendees[0].external_user_id #=> String
resp.attendees[0].attendee_id #=> String
resp.attendees[0].join_token #=> String
resp.errors #=> Array
resp.errors[0].external_user_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_request_token (required, String) —

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

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

  • :external_meeting_id (String) —

    The external meeting ID.

  • :meeting_host_id (String) —

    Reserved.

  • :media_region (String) —

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

    Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

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

    The tag key-value pairs.

  • :notifications_configuration (Types::MeetingNotificationConfiguration) —

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

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

    The request containing the attendees to create.

Returns:

See Also:



1717
1718
1719
1720
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1717

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :product_type (required, String) —

    The phone number product type.

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

    List of phone numbers, in E.164 format.

Returns:

See Also:



1759
1760
1761
1762
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1759

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

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

    The participant phone numbers.

  • :name (String) —

    The name of the proxy session.

  • :expiry_minutes (Integer) —

    The number of minutes allowed for the proxy session.

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

    The proxy session capabilities.

  • :number_selection_behavior (String) —

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

  • :geo_match_level (String) —

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

  • :geo_match_params (Types::GeoMatchParams) —

    The country and area code for the proxy phone number.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :name (required, String) —

    The room name.

  • :client_request_token (String) —

    The idempotency token for the request.

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

Returns:

See Also:



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

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:



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

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

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

Creates a SIP media application.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_region (required, String) —

    The AWS Region assigned to the SIP media application.

  • :name (required, String) —

    The SIP media application name.

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

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

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.sip_media_application_call.transaction_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :from_phone_number (required, String) —

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

  • :to_phone_number (required, String) —

    The phone number that the service should call.

  • :sip_media_application_id (required, String) —

    The ID of the SIP media application.

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

    The SIP headers added to an outbound call leg.

Returns:

See Also:



2024
2025
2026
2027
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2024

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the SIP rule.

  • :trigger_type (required, String) —

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

  • :trigger_value (required, String) —

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

  • :disabled (Boolean) —

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

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

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

Returns:

See Also:



2094
2095
2096
2097
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2094

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

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

Creates a user under the specified Amazon Chime account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :username (String) —

    The user name.

  • :email (String) —

    The user's email address.

  • :user_type (String) —

    The user type.

Returns:

See Also:



2147
2148
2149
2150
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2147

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Amazon Chime Voice Connector.

  • :aws_region (String) —

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

  • :require_encryption (required, Boolean) —

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

Returns:

See Also:



2198
2199
2200
2201
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2198

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Amazon Chime Voice Connector group.

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

    The Amazon Chime Voice Connectors to route inbound calls to.

Returns:

See Also:



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

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

#delete_account(params = {}) ⇒ Struct

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

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

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2283
2284
2285
2286
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2283

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

#delete_app_instance(params = {}) ⇒ Struct

Deletes an AppInstance and all associated data asynchronously.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2305
2306
2307
2308
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2305

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

#delete_app_instance_admin(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_admin_arn (required, String) —

    The ARN of the AppInstance's administrator.

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2332
2333
2334
2335
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2332

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

#delete_app_instance_streaming_configurations(params = {}) ⇒ Struct

Deletes the streaming configurations of an AppInstance.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the streaming configurations being deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2354
2355
2356
2357
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2354

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

#delete_app_instance_user(params = {}) ⇒ Struct

Deletes an AppInstanceUser.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_user_arn (required, String) —

    The ARN of the user request being deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2376
2377
2378
2379
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2376

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

#delete_attendee(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String) —

    The Amazon Chime SDK attendee ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_channel(params = {}) ⇒ Struct

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel being deleted.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_channel_ban(params = {}) ⇒ Struct

Removes a user from a channel's ban list.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

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

  • :member_arn (required, String) —

    The ARN of the AppInstanceUser that you want to reinstate.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_channel_membership(params = {}) ⇒ Struct

Removes a member from a channel.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

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

  • :member_arn (required, String) —

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

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_channel_message(params = {}) ⇒ Struct

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :message_id (required, String) —

    The ID of the message being deleted.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2553
2554
2555
2556
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2553

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

#delete_channel_moderator(params = {}) ⇒ Struct

Deletes a channel moderator.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :channel_moderator_arn (required, String) —

    The ARN of the moderator being deleted.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2589
2590
2591
2592
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2589

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

#delete_events_configuration(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :bot_id (required, String) —

    The bot ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_media_capture_pipeline(params = {}) ⇒ Struct

Deletes the media capture pipeline.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :media_pipeline_id (required, String) —

    The ID of the media capture pipeline being deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2638
2639
2640
2641
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2638

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

#delete_meeting(params = {}) ⇒ Struct

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_phone_number(params = {}) ⇒ Struct

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2695
2696
2697
2698
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2695

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

#delete_proxy_session(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

  • :proxy_session_id (required, String) —

    The proxy session ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2722
2723
2724
2725
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2722

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

#delete_room(params = {}) ⇒ Struct

Deletes a chat room in an Amazon Chime Enterprise account.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :room_id (required, String) —

    The chat room ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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:



2779
2780
2781
2782
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2779

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

#delete_sip_media_application(params = {}) ⇒ Struct

Deletes a SIP media application.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2801
2802
2803
2804
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2801

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

#delete_sip_rule(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :sip_rule_id (required, String) —

    The SIP rule ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2824
2825
2826
2827
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2824

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

#delete_voice_connector(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_voice_connector_emergency_calling_configuration(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2871
2872
2873
2874
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2871

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

#delete_voice_connector_group(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Amazon Chime Voice Connector group ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_voice_connector_origination(params = {}) ⇒ Struct

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2924
2925
2926
2927
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2924

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

#delete_voice_connector_proxy(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2947
2948
2949
2950
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2947

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

#delete_voice_connector_streaming_configuration(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2970
2971
2972
2973
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2970

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

#delete_voice_connector_termination(params = {}) ⇒ Struct

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2999
3000
3001
3002
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2999

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

#delete_voice_connector_termination_credentials(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3027
3028
3029
3030
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3027

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

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

Returns the full details of an AppInstance.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



3059
3060
3061
3062
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3059

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

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

Returns the full details of an AppInstanceAdmin.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_admin_arn (required, String) —

    The ARN of the AppInstanceAdmin.

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



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

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

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

Returns the full details of an AppInstanceUser.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_user_arn (required, String) —

    The ARN of the AppInstanceUser.

Returns:

See Also:



3126
3127
3128
3129
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3126

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



3174
3175
3176
3177
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3174

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

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

Returns the full details of a channel ban.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

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

  • :member_arn (required, String) —

    The ARN of the member being banned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



3221
3222
3223
3224
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3221

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :member_arn (required, String) —

    The ARN of the member.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel to which the user belongs.

  • :app_instance_user_arn (required, String) —

    The ARN of the user in a channel.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



3320
3321
3322
3323
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3320

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the moderated channel.

  • :app_instance_user_arn (required, String) —

    The ARN of the AppInstanceUser in the moderated channel.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



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

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

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

Returns the full details of a single ChannelModerator.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :channel_moderator_arn (required, String) —

    The ARN of the channel moderator.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



3415
3416
3417
3418
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3415

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

#disassociate_phone_number_from_user(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3442
3443
3444
3445
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3442

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

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

    List of phone numbers, in E.164 format.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Amazon Chime Voice Connector group ID.

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

    List of phone numbers, in E.164 format.

Returns:

See Also:



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

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

#disassociate_signin_delegate_groups_from_account(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

    The sign-in delegate group names.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3541
3542
3543
3544
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3541

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:



3580
3581
3582
3583
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3580

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:



3616
3617
3618
3619
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3616

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

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

Gets the retention settings for an AppInstance.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



3646
3647
3648
3649
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3646

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

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

Gets the streaming settings for an AppInstance.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

Returns:

See Also:



3676
3677
3678
3679
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3676

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String) —

    The Amazon Chime SDK attendee ID.

Returns:

See Also:



3717
3718
3719
3720
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3717

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :bot_id (required, String) —

    The bot ID.

Returns:

See Also:



3758
3759
3760
3761
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3758

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

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

Gets the full details of a channel message.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :message_id (required, String) —

    The ID of the message.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



3811
3812
3813
3814
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3811

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :bot_id (required, String) —

    The bot ID.

Returns:

See Also:



3846
3847
3848
3849
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3846

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:



3869
3870
3871
3872
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3869

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

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

Gets an existing media capture pipeline.

Examples:

Request syntax with placeholder values


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

Response structure


resp.media_capture_pipeline.media_pipeline_id #=> String
resp.media_capture_pipeline.source_type #=> String, one of "ChimeSdkMeeting"
resp.media_capture_pipeline.source_arn #=> String
resp.media_capture_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
resp.media_capture_pipeline.sink_type #=> String, one of "S3Bucket"
resp.media_capture_pipeline.sink_arn #=> String
resp.media_capture_pipeline.created_timestamp #=> Time
resp.media_capture_pipeline.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :media_pipeline_id (required, String) —

    The ID of the pipeline that you want to get.

Returns:

See Also:



3904
3905
3906
3907
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3904

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.meeting.meeting_id #=> String
resp.meeting.external_meeting_id #=> String
resp.meeting.media_placement.audio_host_url #=> String
resp.meeting.media_placement.audio_fallback_url #=> String
resp.meeting.media_placement.screen_data_url #=> String
resp.meeting.media_placement.screen_sharing_url #=> String
resp.meeting.media_placement.screen_viewing_url #=> String
resp.meeting.media_placement.signaling_url #=> String
resp.meeting.media_placement.turn_control_url #=> String
resp.meeting.media_placement.event_ingestion_url #=> String
resp.meeting.media_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

Returns:

See Also:



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

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

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

The details of the endpoint for the messaging session.

Examples:

Response structure


resp.endpoint.url #=> String

Parameters:

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

    ({})

Returns:

See Also:



3967
3968
3969
3970
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3967

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number ID.

Returns:

See Also:



4016
4017
4018
4019
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4016

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:



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

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:



4075
4076
4077
4078
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4075

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

  • :proxy_session_id (required, String) —

    The proxy session ID.

Returns:

See Also:



4124
4125
4126
4127
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4124

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

Returns:

See Also:



4162
4163
4164
4165
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4162

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:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

Returns:

See Also:



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

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

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

Returns the logging configuration for the specified SIP media application.

Examples:

Request syntax with placeholder values


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

Response structure


resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

Returns:

See Also:



4264
4265
4266
4267
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4264

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :sip_rule_id (required, String) —

    The SIP rule ID.

Returns:

See Also:



4303
4304
4305
4306
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4303

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :user_id (required, String) —

    The user ID.

Returns:

See Also:



4352
4353
4354
4355
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4352

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:



4387
4388
4389
4390
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4387

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



4422
4423
4424
4425
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4422

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.emergency_calling_configuration.dnis #=> Array
resp.emergency_calling_configuration.dnis[0].emergency_phone_number #=> String
resp.emergency_calling_configuration.dnis[0].test_phone_number #=> String
resp.emergency_calling_configuration.dnis[0].calling_country #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



4454
4455
4456
4457
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4454

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Amazon Chime Voice Connector group ID.

Returns:

See Also:



4489
4490
4491
4492
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4489

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.logging_configuration.enable_sip_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



4519
4520
4521
4522
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4519

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



4554
4555
4556
4557
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4554

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime voice connector ID.

Returns:

See Also:



4587
4588
4589
4590
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4587

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



4656
4657
4658
4659
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4656

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

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

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

  • :user_type (String) —

    The user type.

Returns:

See Also:



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

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:



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

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

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

Returns a list of the administrators in the AppInstance.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.app_instance_arn #=> String
resp.app_instance_admins #=> Array
resp.app_instance_admins[0].admin.arn #=> String
resp.app_instance_admins[0].admin.name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

  • :max_results (Integer) —

    The maximum number of administrators that you want to return.

  • :next_token (String) —

    The token returned from previous API requests until the number of administrators is reached.

Returns:

See Also:



4833
4834
4835
4836
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4833

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

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

List all AppInstanceUsers created under a single AppInstance.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.app_instance_arn #=> String
resp.app_instance_users #=> Array
resp.app_instance_users[0].app_instance_user_arn #=> String
resp.app_instance_users[0].name #=> String
resp.app_instance_users[0].metadata #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String) —

    The ARN of the AppInstance.

  • :max_results (Integer) —

    The maximum number of requests that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested users are returned.

Returns:

See Also:



4879
4880
4881
4882
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4879

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

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

Lists all Amazon Chime AppInstances created under a single AWS account.

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

Examples:

Request syntax with placeholder values


resp = client.list_app_instances({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.app_instances #=> Array
resp.app_instances[0].app_instance_arn #=> String
resp.app_instances[0].name #=> String
resp.app_instances[0].metadata #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of AppInstances that you want to return.

  • :next_token (String) —

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

Returns:

See Also:



4920
4921
4922
4923
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4920

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :attendee_id (required, String) —

    The Amazon Chime SDK attendee ID.

Returns:

See Also:



4954
4955
4956
4957
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4954

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String) —

    The Amazon Chime SDK meeting ID.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



5003
5004
5005
5006
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5003

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Chime account ID.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



5054
5055
5056
5057
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5054

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

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

Lists all the users banned from a particular channel.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.channel_arn #=> String
resp.next_token #=> String
resp.channel_bans #=> Array
resp.channel_bans[0].member.arn #=> String
resp.channel_bans[0].member.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :max_results (Integer) —

    The maximum number of bans that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested bans are returned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



5109
5110
5111
5112
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5109

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

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

Lists all channel memberships in a channel.

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

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

Examples:

Request syntax with placeholder values


resp = client.list_channel_memberships({
  channel_arn: "ChimeArn", # required
  type: "DEFAULT", # accepts DEFAULT, HIDDEN
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.channel_memberships #=> Array
resp.channel_memberships[0].member.arn #=> String
resp.channel_memberships[0].member.name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The maximum number of channel memberships that you want returned.

  • :type (String) —

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

  • :max_results (Integer) —

    The maximum number of channel memberships that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested channel memberships are returned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



5172
5173
5174
5175
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5172

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

#list_channel_memberships_for_app_instance_user(params = {}) ⇒ Types::ListChannelMembershipsForAppInstanceUserResponse

Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

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

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

Examples:

Request syntax with placeholder values


resp = client.list_channel_memberships_for_app_instance_user({
  app_instance_user_arn: "ChimeArn",
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_memberships #=> Array
resp.channel_memberships[0].channel_summary.name #=> String
resp.channel_memberships[0].channel_summary.channel_arn #=> String
resp.channel_memberships[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
resp.channel_memberships[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
resp.channel_memberships[0].channel_summary.metadata #=> String
resp.channel_memberships[0].channel_summary.last_message_timestamp #=> Time
resp.channel_memberships[0].app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
resp.channel_memberships[0].app_instance_user_membership_summary.read_marker_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_user_arn (String) —

    The ARN of the AppInstanceUsers

  • :max_results (Integer) —

    The maximum number of users that you want returned.

  • :next_token (String) —

    The token returned from previous API requests until the number of channel memberships is reached.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



5233
5234
5235
5236
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5233

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

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

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

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

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

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

Examples:

Request syntax with placeholder values


resp = client.list_channel_messages({
  channel_arn: "ChimeArn", # required
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  not_before: Time.now,
  not_after: Time.now,
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
})

Response structure


resp.channel_arn #=> String
resp.next_token #=> String
resp.channel_messages #=> Array
resp.channel_messages[0].message_id #=> String
resp.channel_messages[0].content #=> String
resp.channel_messages[0].metadata #=> String
resp.channel_messages[0].type #=> String, one of "STANDARD", "CONTROL"
resp.channel_messages[0].created_timestamp #=> Time
resp.channel_messages[0].last_updated_timestamp #=> Time
resp.channel_messages[0].last_edited_timestamp #=> Time
resp.channel_messages[0].sender.arn #=> String
resp.channel_messages[0].sender.name #=> String
resp.channel_messages[0].redacted #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :sort_order (String) —

    The order in which you want messages sorted. Default is Descending, based on time created.

  • :not_before (Time, DateTime, Date, Integer, String) —

    The initial or starting time stamp for your requested messages.

  • :not_after (Time, DateTime, Date, Integer, String) —

    The final or ending time stamp for your requested messages.

  • :max_results (Integer) —

    The maximum number of messages that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested messages are returned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also:



5315
5316
5317
5318
 
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5315

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

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

Lists all the moderators for a channel.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.channel_arn #=> String
resp.next_token #=> String
resp.channel_moderators #=> Array
resp.channel_moderators[0].moderator.arn #=> String
resp.channel_moderators[0].moderator.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    The ARN of the channel.

  • :max_results (Integer) —

    The maximum number of moderators that you want returned.

  • :next_token (String) —

    The token passed by previous API calls until all requested moderators are returned.

  • :chime_bearer (String) —

    The AppInstanceUserArn of the user that makes the API call.

Returns:

See Also: