Class: Aws::Chime::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. 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`

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

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

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

  • :region (required, String)

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

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

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

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :disable_request_compression (Boolean) — default: false

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

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

  • :endpoint_discovery (Boolean) — default: false

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

  • :ignore_configured_endpoint_urls (Boolean)

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info

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

  • :logger (Logger)

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

  • :max_attempts (Integer) — default: 3

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

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

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

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

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

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240

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

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

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

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc)

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

  • :retry_base_delay (Float) — default: 0.3

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

  • :retry_jitter (Symbol) — default: :none

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

    @see 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.

  • :sdk_ua_app_id (String)

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

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

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

  • :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 ClientStubs#stub_responses. See ClientStubs for more information.

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

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

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

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

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

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

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

  • :use_dualstack_endpoint (Boolean)

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

  • :use_fips_endpoint (Boolean)

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

  • :validate_params (Boolean) — default: true

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

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

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_open_timeout (Float) — default: 15

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

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60

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

  • :http_wire_trace (Boolean) — default: false

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

  • :on_chunk_received (Proc)

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

  • :on_chunk_sent (Proc)

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

  • :raise_response_errors (Boolean) — default: true

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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

  • :ssl_ca_store (String)

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey)

    Sets a client key when creating http connections.

  • :ssl_timeout (Float)

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true

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



467
468
469
# File 'lib/aws-sdk-chime/client.rb', line 467

def initialize(*args)
  super
end

Class Attribute Details

.identifierObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



10387
10388
10389
# File 'lib/aws-sdk-chime/client.rb', line 10387

def identifier
  @identifier
end

Class Method Details

.errors_moduleObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



10390
10391
10392
# File 'lib/aws-sdk-chime/client.rb', line 10390

def errors_module
  Errors
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:



498
499
500
501
# File 'lib/aws-sdk-chime/client.rb', line 498

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [AssociatePhoneNumbersWithVoiceConnector], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnector.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



554
555
556
557
# File 'lib/aws-sdk-chime/client.rb', line 554

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [AssociatePhoneNumbersWithVoiceConnectorGroup], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



611
612
613
614
# File 'lib/aws-sdk-chime/client.rb', line 611

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:



642
643
644
645
# File 'lib/aws-sdk-chime/client.rb', line 642

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [BatchCreateAttendee], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_BatchCreateAttendee.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html [3]: docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html

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:



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

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [BatchCreateChannelMembership], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_BatchCreateChannelMembership.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



778
779
780
781
# File 'lib/aws-sdk-chime/client.rb', line 778

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:



825
826
827
828
# File 'lib/aws-sdk-chime/client.rb', line 825

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:



861
862
863
864
# File 'lib/aws-sdk-chime/client.rb', line 861

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][1

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.

[1]: docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html

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:



916
917
918
919
# File 'lib/aws-sdk-chime/client.rb', line 916

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 ][1] 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.

[1]: docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html

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:



964
965
966
967
# File 'lib/aws-sdk-chime/client.rb', line 964

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:



1012
1013
1014
1015
# File 'lib/aws-sdk-chime/client.rb', line 1012

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:



1059
1060
1061
1062
# File 'lib/aws-sdk-chime/client.rb', line 1059

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
# File 'lib/aws-sdk-chime/client.rb', line 10360

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Chime')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-chime'
  context[:gem_version] = '1.98.0'
  Seahorse::Client::Request.new(handlers, context)
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][1

in the *Amazon Chime

Administration Guide*.

[1]: docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html

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:



1105
1106
1107
1108
# File 'lib/aws-sdk-chime/client.rb', line 1105

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateAppInstance], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstance.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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 ‘AppInstance`.

Returns:

See Also:



1169
1170
1171
1172
# File 'lib/aws-sdk-chime/client.rb', line 1169

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateAppInstanceAdmin], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

  • ‘ChannelModerator` actions across all channels in the `AppInstance`.

  • ‘DeleteChannelMessage` actions.

Only an ‘AppInstanceUser` can be promoted to an `AppInstanceAdmin` role.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceAdmin.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



1225
1226
1227
1228
# File 'lib/aws-sdk-chime/client.rb', line 1225

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateAppInstanceUser], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceUser.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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 SDK Developer Guide*.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateAttendee], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html [2]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateAttendee.html [3]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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:



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

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateChannel], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannel.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



1489
1490
1491
1492
# File 'lib/aws-sdk-chime/client.rb', line 1489

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateChannelBan], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelBan.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateChannelMembership], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelMembership.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateChannelModerator], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelModerator.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



1705
1706
1707
1708
# File 'lib/aws-sdk-chime/client.rb', line 1705

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateMediaCapturePipeline], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_CreateMediaCapturePipeline [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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",
  chime_sdk_meeting_configuration: {
    source_configuration: {
      selected_video_streams: {
        attendee_ids: ["GuidString"],
        external_user_ids: ["ExternalUserIdType"],
      },
    },
    artifacts_configuration: {
      audio: { # required
        mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo
      },
      video: { # required
        state: "Enabled", # required, accepts Enabled, Disabled
        mux_type: "VideoOnly", # accepts VideoOnly
      },
      content: { # required
        state: "Enabled", # required, accepts Enabled, Disabled
        mux_type: "ContentOnly", # accepts ContentOnly
      },
    },
  },
})

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
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"

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 unique identifier for the client request. The token makes the API request idempotent. Use a different token for different media pipeline requests.

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

  • :chime_sdk_meeting_configuration (Types::ChimeSdkMeetingConfiguration)

    The configuration for a specified media capture pipeline. ‘SourceType` must be `ChimeSdkMeeting`.

Returns:

See Also:



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

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 SDK Developer Guide* . For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK] in the *Amazon Chime SDK Developer Guide*.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateMeeting], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html [3]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html [4]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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.

**This API is is not available in a dedicated namespace.**

Examples:

Request syntax with placeholder values


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

Response structure


resp.transaction_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :meeting_id (required, String)

    The Amazon Chime SDK meeting ID.

  • :from_phone_number (required, String)

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

  • :to_phone_number (required, String)

    Phone number called when inviting someone to a meeting.

  • :join_token (required, String)

    Token used by the Amazon Chime SDK attendee. Call the

    CreateAttendee][1

    action to get a join token.

    [1]: docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html

Returns:

See Also:



1962
1963
1964
1965
# File 'lib/aws-sdk-chime/client.rb', line 1962

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 SDK Developer Guide* . For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK] in the *Amazon Chime SDK Developer Guide* .

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateMeetingWithAttendees], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html [3]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeetingWithAttendees.html [4]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



2085
2086
2087
2088
# File 'lib/aws-sdk-chime/client.rb', line 2085

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:



2127
2128
2129
2130
# File 'lib/aws-sdk-chime/client.rb', line 2127

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateProxySession], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateProxySession.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



2218
2219
2220
2221
# File 'lib/aws-sdk-chime/client.rb', line 2218

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:



2262
2263
2264
2265
# File 'lib/aws-sdk-chime/client.rb', line 2262

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:



2313
2314
2315
2316
# File 'lib/aws-sdk-chime/client.rb', line 2313

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateSipMediaApplication], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipMediaApplication.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



2373
2374
2375
2376
# File 'lib/aws-sdk-chime/client.rb', line 2373

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateSipMediaApplicationCall], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipMediaApplicationCall.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateSipRule], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipRule.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :username (String)

    The user name.

  • :email (String)

    The user’s email address.

  • :user_type (String)

    The user type.

Returns:

See Also:



2567
2568
2569
2570
# File 'lib/aws-sdk-chime/client.rb', line 2567

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateVoiceConnector], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateVoiceConnector.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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

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:



2632
2633
2634
2635
# File 'lib/aws-sdk-chime/client.rb', line 2632

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [CreateVoiceConnectorGroup], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateVoiceConnectorGroup.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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
resp.voice_connector_group.voice_connector_group_arn #=> String

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:



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

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:



2731
2732
2733
2734
# File 'lib/aws-sdk-chime/client.rb', line 2731

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteAppInstance], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstance.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



2766
2767
2768
2769
# File 'lib/aws-sdk-chime/client.rb', line 2766

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteAppInstanceAdmin], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceAdmin.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



2806
2807
2808
2809
# File 'lib/aws-sdk-chime/client.rb', line 2806

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteAppInstanceStreamingConfigurations], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceStreamingConfigurations.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



2842
2843
2844
2845
# File 'lib/aws-sdk-chime/client.rb', line 2842

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteAppInstanceUser], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceUser.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



2877
2878
2879
2880
# File 'lib/aws-sdk-chime/client.rb', line 2877

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 SDK Developer Guide*.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteAttendee], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html [2]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_DeleteAttendee.html [3]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteChannel], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannel.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



2967
2968
2969
2970
# File 'lib/aws-sdk-chime/client.rb', line 2967

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteChannelBan], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelBan.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3016
3017
3018
3019
# File 'lib/aws-sdk-chime/client.rb', line 3016

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteChannelMembership], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelMembership.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3065
3066
3067
3068
# File 'lib/aws-sdk-chime/client.rb', line 3065

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

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteChannelMessage], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelMessage.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3116
3117
3118
3119
# File 'lib/aws-sdk-chime/client.rb', line 3116

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteChannelModerator], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelModerator.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3165
3166
3167
3168
# File 'lib/aws-sdk-chime/client.rb', line 3165

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:



3192
3193
3194
3195
# File 'lib/aws-sdk-chime/client.rb', line 3192

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteMediaCapturePipeline], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_DeleteMediaCapturePipeline.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3227
3228
3229
3230
# File 'lib/aws-sdk-chime/client.rb', line 3227

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 SDK Developer Guide*.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteMeeting], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html [2]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_DeleteMeeting.html [3]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3267
3268
3269
3270
# File 'lib/aws-sdk-chime/client.rb', line 3267

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:



3294
3295
3296
3297
# File 'lib/aws-sdk-chime/client.rb', line 3294

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteProxySession], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteProxySession.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3334
3335
3336
3337
# File 'lib/aws-sdk-chime/client.rb', line 3334

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:



3360
3361
3362
3363
# File 'lib/aws-sdk-chime/client.rb', line 3360

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:



3391
3392
3393
3394
# File 'lib/aws-sdk-chime/client.rb', line 3391

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteSipMediaApplication], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteSipMediaApplication.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3426
3427
3428
3429
# File 'lib/aws-sdk-chime/client.rb', line 3426

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteSipRule], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteSipRule.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3462
3463
3464
3465
# File 'lib/aws-sdk-chime/client.rb', line 3462

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteVoiceConnector], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnector.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3499
3500
3501
3502
# File 'lib/aws-sdk-chime/client.rb', line 3499

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteVoiceConnectorEmergencyCallingConfiguration], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3536
3537
3538
3539
# File 'lib/aws-sdk-chime/client.rb', line 3536

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteVoiceConnectorGroup], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorGroup.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3573
3574
3575
3576
# File 'lib/aws-sdk-chime/client.rb', line 3573

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.

<note markdown=“1”> If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteVoiceConnectorOrigination], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorOrigination.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteVoiceProxy], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorProxy.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3651
3652
3653
3654
# File 'lib/aws-sdk-chime/client.rb', line 3651

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteVoiceConnectorStreamingConfiguration], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorStreamingConfiguration.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3688
3689
3690
3691
# File 'lib/aws-sdk-chime/client.rb', line 3688

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.

<note markdown=“1”> If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteVoiceConnectorTermination], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorTermination.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3730
3731
3732
3733
# File 'lib/aws-sdk-chime/client.rb', line 3730

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DeleteVoiceConnectorTerminationCredentials], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorTerminationCredentials.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3772
3773
3774
3775
# File 'lib/aws-sdk-chime/client.rb', line 3772

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DescribeAppInstance], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstance.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_arn (required, String)

    The ARN of the ‘AppInstance`.

Returns:

See Also:



3817
3818
3819
3820
# File 'lib/aws-sdk-chime/client.rb', line 3817

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DescribeAppInstanceAdmin], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstanceAdmin.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



3865
3866
3867
3868
# File 'lib/aws-sdk-chime/client.rb', line 3865

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DescribeAppInstanceUser], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstanceUser.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :app_instance_user_arn (required, String)

    The ARN of the ‘AppInstanceUser`.

Returns:

See Also:



3910
3911
3912
3913
# File 'lib/aws-sdk-chime/client.rb', line 3910

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

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DescribeChannel], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannel.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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



3971
3972
3973
3974
# File 'lib/aws-sdk-chime/client.rb', line 3971

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DescribeChannelBan], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelBan.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



4031
4032
4033
4034
# File 'lib/aws-sdk-chime/client.rb', line 4031

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DescribeChannelMembership], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelMembership.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



4093
4094
4095
4096
# File 'lib/aws-sdk-chime/client.rb', line 4093

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

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DescribeChannelMembershipForAppInstanceUser], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelMembershipForAppInstanceUser.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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



4157
4158
4159
4160
# File 'lib/aws-sdk-chime/client.rb', line 4157

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

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DescribeChannelModeratedByAppInstanceUser], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelModeratedByAppInstanceUser.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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



4219
4220
4221
4222
# File 'lib/aws-sdk-chime/client.rb', line 4219

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DescribeChannelModerator], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelModerator.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



4279
4280
4281
4282
# File 'lib/aws-sdk-chime/client.rb', line 4279

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:



4306
4307
4308
4309
# File 'lib/aws-sdk-chime/client.rb', line 4306

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DisassociatePhoneNumbersFromVoiceConnector], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



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

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [DisassociatePhoneNumbersFromVoiceConnectorGroup], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



4406
4407
4408
4409
# File 'lib/aws-sdk-chime/client.rb', line 4406

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:



4433
4434
4435
4436
# File 'lib/aws-sdk-chime/client.rb', line 4433

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:



4472
4473
4474
4475
# File 'lib/aws-sdk-chime/client.rb', line 4472

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

[1]: docs.aws.amazon.com/chime/latest/ag/policies.html

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:



4508
4509
4510
4511
# File 'lib/aws-sdk-chime/client.rb', line 4508

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetMessagingRetentionSettings], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_GetAppInstanceRetentionSettings.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



4551
4552
4553
4554
# File 'lib/aws-sdk-chime/client.rb', line 4551

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetMessagingStreamingConfigurations], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetMessagingStreamingConfigurations.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



4594
4595
4596
4597
# File 'lib/aws-sdk-chime/client.rb', line 4594

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][1

in the *Amazon Chime SDK Developer

Guide*.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetAttendee], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html [2]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetAttendee.html [3]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



4645
4646
4647
4648
# File 'lib/aws-sdk-chime/client.rb', line 4645

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:



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

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.

<note markdown=“1”> 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.

</note>

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetChannelMessage], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetChannelMessage.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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



4752
4753
4754
4755
# File 'lib/aws-sdk-chime/client.rb', line 4752

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:



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

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:



4810
4811
4812
4813
# File 'lib/aws-sdk-chime/client.rb', line 4810

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetMediaCapturePipeline], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_GetMediaCapturePipeline.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"

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:



4867
4868
4869
4870
# File 'lib/aws-sdk-chime/client.rb', line 4867

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetMeeting], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

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 SDK Developer Guide* .

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetMeeting.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html [3]: docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html

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:



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

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetMessagingSessionEndpoint], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetMessagingSessionEndpoint.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

Examples:

Response structure


resp.endpoint.url #=> String

Parameters:

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

    ({})

Returns:

See Also:



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

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:



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

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:



5039
5040
5041
5042
# File 'lib/aws-sdk-chime/client.rb', line 5039

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:



5061
5062
5063
5064
# File 'lib/aws-sdk-chime/client.rb', line 5061

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetProxySession], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetProxySession.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



5123
5124
5125
5126
# File 'lib/aws-sdk-chime/client.rb', line 5123

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

[1]: docs.aws.amazon.com/chime/latest/ag/chat-retention.html

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:



5161
5162
5163
5164
# File 'lib/aws-sdk-chime/client.rb', line 5161

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:



5199
5200
5201
5202
# File 'lib/aws-sdk-chime/client.rb', line 5199

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetSipMediaApplication], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipMediaApplication.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



5247
5248
5249
5250
# File 'lib/aws-sdk-chime/client.rb', line 5247

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetSipMediaApplicationLoggingConfiguration], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipMediaApplicationLoggingConfiguration.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



5290
5291
5292
5293
# File 'lib/aws-sdk-chime/client.rb', line 5290

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetSipRule], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipRule.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



5342
5343
5344
5345
# File 'lib/aws-sdk-chime/client.rb', line 5342

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

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Chime account ID.

  • :user_id (required, String)

    The user ID.

Returns:

See Also:



5391
5392
5393
5394
# File 'lib/aws-sdk-chime/client.rb', line 5391

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:



5426
5427
5428
5429
# File 'lib/aws-sdk-chime/client.rb', line 5426

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetVoiceConnector], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnector.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



5475
5476
5477
5478
# File 'lib/aws-sdk-chime/client.rb', line 5475

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetVoiceConnectorEmergencyCallingConfiguration], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



5521
5522
5523
5524
# File 'lib/aws-sdk-chime/client.rb', line 5521

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetVoiceConnectorGroup], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorGroup.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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
resp.voice_connector_group.voice_connector_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String)

    The Amazon Chime Voice Connector group ID.

Returns:

See Also:



5570
5571
5572
5573
# File 'lib/aws-sdk-chime/client.rb', line 5570

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetVoiceConnectorLoggingConfiguration], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorLoggingConfiguration.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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
resp.logging_configuration.enable_media_metric_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String)

    The Amazon Chime Voice Connector ID.

Returns:

See Also:



5614
5615
5616
5617
# File 'lib/aws-sdk-chime/client.rb', line 5614

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetVoiceConnectorOrigination], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorOrigination.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



5662
5663
5664
5665
# File 'lib/aws-sdk-chime/client.rb', line 5662

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetVoiceConnectorProxy], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorProxy.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



5708
5709
5710
5711
# File 'lib/aws-sdk-chime/client.rb', line 5708

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetVoiceConnectorStreamingConfiguration], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorStreamingConfiguration.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



5755
5756
5757
5758
# File 'lib/aws-sdk-chime/client.rb', line 5755

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.

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetVoiceConnectorTermination], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorTermination.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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:



5803
5804
5805
5806
# File 'lib/aws-sdk-chime/client.rb', line 5803

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

**This API is is no longer supported and will not be updated.** We recommend using the latest version, [GetVoiceConnectorTerminationHealth], in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace.

For more information, refer to [Migrating from the Amazon Chime namespace] in the *Amazon Chime SDK Developer Guide*.

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

[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorTerminationHealth.html [2]: docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html

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