Class: Aws::ChimeSDKVoice::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

  • :sdk_ua_app_id (String) —

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

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

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

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

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

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

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

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

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

    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::ChimeSDKVoice::EndpointProvider) —

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



444
445
446
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 444

def initialize(*args)
  super
end

Instance Method Details

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The 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 SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

Returns:

See Also:



488
489
490
491
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 488

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 SDK Voice Connector group.

Examples:

Request syntax with placeholder values


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

Response structure


resp.phone_number_errors #=> Array
resp.phone_number_errors[0].phone_number_id #=> String
resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist", "Gone"
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 SDK 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 SDK 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:



531
532
533
534
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 531

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

#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 SDK 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", "Gone"
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:



567
568
569
570
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 567

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

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

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

You cannot have a duplicate phoneNumberId in a request.

Examples:

Request syntax with placeholder values


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

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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



612
613
614
615
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 612

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

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

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

Examples:

Request syntax with placeholder values


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

Response structure


resp.phone_number_order.phone_number_order_id #=> String
resp.phone_number_order.product_type #=> String, one of "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number_order.status #=> String, one of "Processing", "Successful", "Failed", "Partial", "PendingDocuments", "Submitted", "FOC", "ChangeRequested", "Exception", "CancelRequested", "Cancelled"
resp.phone_number_order.order_type #=> String, one of "New", "Porting"
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.

  • :name (String) —

    Specifies the name assigned to one or more phone numbers.

Returns:

See Also:



658
659
660
661
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 658

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 for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The 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's 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:



736
737
738
739
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 736

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

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

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_sip_media_application({
  aws_region: "String", # required
  name: "SipMediaApplicationName", # required
  endpoints: [ # required
    {
      lambda_arn: "FunctionArn",
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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
resp.sip_media_application.sip_media_application_arn #=> String

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's name.

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

    List of endpoints (Lambda ARNs) specified for the SIP media application.

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

    The tags assigned to the SIP media application.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.create_sip_media_application_call({
  from_phone_number: "E164PhoneNumber", # required
  to_phone_number: "E164PhoneNumber", # required
  sip_media_application_id: "NonEmptyString", # required
  sip_headers: {
    "SensitiveString" => "SensitiveString",
  },
  arguments_map: {
    "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 SDK 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.

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

    Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: "FirstName": "John", "LastName": "Doe"

Returns:

See Also:



852
853
854
855
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 852

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. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

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: [
    {
      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 a 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) —

    Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

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



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

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

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

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

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, ca-central-1, eu-central-1, eu-west-1, eu-west-2, ap-northeast-2, ap-northeast-1, ap-southeast-1, ap-southeast-2
  require_encryption: false, # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  integration_type: "CONNECT_CALL_TRANSFER_CONNECTOR", # accepts CONNECT_CALL_TRANSFER_CONNECTOR, CONNECT_ANALYTICS_CONNECTOR
})

Response structure


resp.voice_connector.voice_connector_id #=> String
resp.voice_connector.aws_region #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-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
resp.voice_connector.integration_type #=> String, one of "CONNECT_CALL_TRANSFER_CONNECTOR", "CONNECT_ANALYTICS_CONNECTOR"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Voice Connector.

  • :aws_region (String) —

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

  • :require_encryption (required, Boolean) —

    Enables or disables encryption for the Voice Connector.

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

    The tags assigned to the Voice Connector.

  • :integration_type (String) —

    The connectors for use with Amazon Connect.

    The following options are available:

    • CONNECT_CALL_TRANSFER_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems to directly transfer voice calls and metadata without using the public telephone network. They can use Amazon Connect telephony and Interactive Voice Response (IVR) with their existing voice systems to modernize the IVR experience of their existing contact center and their enterprise and branch voice systems. Additionally, enterprises migrating their contact center to Amazon Connect can start with Connect telephony and IVR for immediate modernization ahead of agent migration.

    • CONNECT_ANALYTICS_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems for real-time and post-call analytics. They can use Amazon Connect Contact Lens with their existing voice systems to provides call recordings, conversational analytics (including contact transcript, sensitive data redaction, content categorization, theme detection, sentiment analysis, real-time alerts, and post-contact summary), and agent performance evaluations (including evaluation forms, automated evaluation, supervisor review) with a rich user experience to display, search and filter customer interactions, and programmatic access to data streams and the data lake. Additionally, enterprises migrating their contact center to Amazon Connect can start with Contact Lens analytics and performance insights ahead of agent migration.

Returns:

See Also:



1018
1019
1020
1021
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1018

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 SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Voice Connector group.

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

    Lists the Voice Connectors that inbound calls are routed to.

Returns:

See Also:



1069
1070
1071
1072
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1069

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

#create_voice_profile(params = {}) ⇒ Types::CreateVoiceProfileResponse

Creates a voice profile, which consists of an enrolled user and their latest voice print.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_voice_profile({
  speaker_search_task_id: "NonEmptyString256", # required
})

Response structure


resp.voice_profile.voice_profile_id #=> String
resp.voice_profile.voice_profile_arn #=> String
resp.voice_profile.voice_profile_domain_id #=> String
resp.voice_profile.created_timestamp #=> Time
resp.voice_profile.updated_timestamp #=> Time
resp.voice_profile.expiration_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :speaker_search_task_id (required, String) —

    The ID of the speaker search task.

Returns:

See Also:



1117
1118
1119
1120
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1117

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

#create_voice_profile_domain(params = {}) ⇒ Types::CreateVoiceProfileDomainResponse

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_voice_profile_domain({
  name: "VoiceProfileDomainName", # required
  description: "VoiceProfileDomainDescription",
  server_side_encryption_configuration: { # required
    kms_key_arn: "Arn", # required
  },
  client_request_token: "ClientRequestId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.voice_profile_domain.voice_profile_domain_id #=> String
resp.voice_profile_domain.voice_profile_domain_arn #=> String
resp.voice_profile_domain.name #=> String
resp.voice_profile_domain.description #=> String
resp.voice_profile_domain.server_side_encryption_configuration.kms_key_arn #=> String
resp.voice_profile_domain.created_timestamp #=> Time
resp.voice_profile_domain.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the voice profile domain.

  • :description (String) —

    A description of the voice profile domain.

  • :server_side_encryption_configuration (required, Types::ServerSideEncryptionConfiguration) —

    The server-side encryption configuration for the request.

  • :client_request_token (String) —

    The unique identifier for the client request. Use a different token for different domain creation requests.

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

    The tags assigned to the domain.

Returns:

See Also:



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

def create_voice_profile_domain(params = {}, options = {})
  req = build_request(:create_voice_profile_domain, 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 SDK Voice Connectors before it can be deleted.

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

Examples:

Request syntax with placeholder values


resp = client.delete_phone_number({
  phone_number_id: "SensitiveNonEmptyString", # 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:



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

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 SDK Voice Connector.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :proxy_session_id (required, String) —

    The proxy session ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_sip_media_application(params = {}) ⇒ Struct

Deletes a SIP media application.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1266
1267
1268
1269
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1266

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.

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:



1288
1289
1290
1291
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1288

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

#delete_voice_connector(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1312
1313
1314
1315
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1312

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 details from the specified Amazon Chime SDK Voice Connector.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1335
1336
1337
1338
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1335

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_external_systems_configuration(params = {}) ⇒ Struct

Deletes the external systems configuration for a Voice Connector.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The ID of the Voice Connector for which to delete the external system configuration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1358
1359
1360
1361
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1358

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

#delete_voice_connector_group(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Voice Connector Group ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1382
1383
1384
1385
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1382

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 SDK Voice Connector.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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 SDK Voice Connector.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1433
1434
1435
1436
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1433

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 a Voice Connector's streaming configuration.

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 Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1455
1456
1457
1458
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1455

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 SDK Voice Connector.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1483
1484
1485
1486
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1483

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

#delete_voice_connector_termination_credentials(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

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



1511
1512
1513
1514
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1511

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

#delete_voice_profile(params = {}) ⇒ Struct

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_profile({
  voice_profile_id: "NonEmptyString256", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_profile_id (required, String) —

    The voice profile ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1534
1535
1536
1537
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1534

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

#delete_voice_profile_domain(params = {}) ⇒ Struct

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

Examples:

Request syntax with placeholder values


resp = client.delete_voice_profile_domain({
  voice_profile_domain_id: "NonEmptyString256", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_profile_domain_id (required, String) —

    The voice profile domain ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

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

    List of phone numbers, in E.164 format.

Returns:

See Also:



1593
1594
1595
1596
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1593

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 SDK Voice Connector group.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Voice Connector group ID.

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

    The list of phone numbers, in E.164 format.

Returns:

See Also:



1629
1630
1631
1632
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1629

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

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

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Examples:

Response structure


resp.voice_connector.cdr_bucket #=> String

Parameters:

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

    ({})

Returns:

See Also:



1649
1650
1651
1652
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1649

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

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

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

Examples:

Request syntax with placeholder values


resp = client.get_phone_number({
  phone_number_id: "SensitiveNonEmptyString", # 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 "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number.status #=> String, one of "Cancelled", "PortinCancelRequested", "PortinInProgress", "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 "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
resp.phone_number.order_id #=> String
resp.phone_number.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number ID.

Returns:

See Also:



1700
1701
1702
1703
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1700

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 "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number_order.status #=> String, one of "Processing", "Successful", "Failed", "Partial", "PendingDocuments", "Submitted", "FOC", "ChangeRequested", "Exception", "CancelRequested", "Cancelled"
resp.phone_number_order.order_type #=> String, one of "New", "Porting"
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 of the phone number order .

Returns:

See Also:



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

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:



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

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

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :proxy_session_id (required, String) —

    The proxy session ID.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID .

Returns:

See Also:



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

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

#get_sip_media_application_alexa_skill_configuration(params = {}) ⇒ Types::GetSipMediaApplicationAlexaSkillConfigurationResponse

Gets the Alexa Skill configuration for the SIP media application.

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.

Examples:

Request syntax with placeholder values


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

Response structure


resp.sip_media_application_alexa_skill_configuration.alexa_skill_status #=> String, one of "ACTIVE", "INACTIVE"
resp.sip_media_application_alexa_skill_configuration.alexa_skill_ids #=> Array
resp.sip_media_application_alexa_skill_configuration.alexa_skill_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

Returns:

See Also:



1883
1884
1885
1886
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1883

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

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

Retrieves the logging configuration for the specified SIP media application.

Examples:

Request syntax with placeholder values


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

Response structure


resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

Returns:

See Also:



1912
1913
1914
1915
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 1912

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :sip_rule_id (required, String) —

    The SIP rule ID.

Returns:

See Also:



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

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

#get_speaker_search_task(params = {}) ⇒ Types::GetSpeakerSearchTaskResponse

Retrieves the details of the specified speaker search task.

Examples:

Request syntax with placeholder values


resp = client.get_speaker_search_task({
  voice_connector_id: "NonEmptyString128", # required
  speaker_search_task_id: "NonEmptyString256", # required
})

Response structure


resp.speaker_search_task.speaker_search_task_id #=> String
resp.speaker_search_task.speaker_search_task_status #=> String
resp.speaker_search_task.call_details.voice_connector_id #=> String
resp.speaker_search_task.call_details.transaction_id #=> String
resp.speaker_search_task.call_details.is_caller #=> Boolean
resp.speaker_search_task.speaker_search_details.results #=> Array
resp.speaker_search_task.speaker_search_details.results[0].confidence_score #=> Float
resp.speaker_search_task.speaker_search_details.results[0].voice_profile_id #=> String
resp.speaker_search_task.speaker_search_details.voiceprint_generation_status #=> String
resp.speaker_search_task.created_timestamp #=> Time
resp.speaker_search_task.updated_timestamp #=> Time
resp.speaker_search_task.started_timestamp #=> Time
resp.speaker_search_task.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :speaker_search_task_id (required, String) —

    The ID of the speaker search task.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.voice_connector.voice_connector_id #=> String
resp.voice_connector.aws_region #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-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
resp.voice_connector.integration_type #=> String, one of "CONNECT_CALL_TRANSFER_CONNECTOR", "CONNECT_ANALYTICS_CONNECTOR"

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

See Also:



2032
2033
2034
2035
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2032

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

Retrieves the emergency calling configuration details for the specified Voice Connector.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

See Also:



2064
2065
2066
2067
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2064

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_external_systems_configuration(params = {}) ⇒ Types::GetVoiceConnectorExternalSystemsConfigurationResponse

Gets information about an external systems configuration for a Voice Connector.

Examples:

Request syntax with placeholder values


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

Response structure


resp.external_systems_configuration.session_border_controller_types #=> Array
resp.external_systems_configuration.session_border_controller_types[0] #=> String, one of "RIBBON_SBC", "ORACLE_ACME_PACKET_SBC", "AVAYA_SBCE", "CISCO_UNIFIED_BORDER_ELEMENT", "AUDIOCODES_MEDIANT_SBC"
resp.external_systems_configuration.contact_center_system_types #=> Array
resp.external_systems_configuration.contact_center_system_types[0] #=> String, one of "GENESYS_ENGAGE_ON_PREMISES", "AVAYA_AURA_CALL_CENTER_ELITE", "AVAYA_AURA_CONTACT_CENTER", "CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE"

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The ID of the Voice Connector for which to return information about the external system configuration.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Voice Connector group ID.

Returns:

See Also:



2133
2134
2135
2136
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2133

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 settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Examples:

Request syntax with placeholder values


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

Response structure


resp.logging_configuration.enable_sip_logs #=> Boolean
resp.logging_configuration.enable_media_metric_logs #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

See Also:



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

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 the origination settings for the specified Voice Connector.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

See Also:



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

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

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

See Also:



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

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 SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

See Also:



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

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 the termination setting details for the specified Voice Connector.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

See Also:



2302
2303
2304
2305
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2302

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

See Also:



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

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

#get_voice_profile(params = {}) ⇒ Types::GetVoiceProfileResponse

Retrieves the details of the specified voice profile.

Examples:

Request syntax with placeholder values


resp = client.get_voice_profile({
  voice_profile_id: "NonEmptyString256", # required
})

Response structure


resp.voice_profile.voice_profile_id #=> String
resp.voice_profile.voice_profile_arn #=> String
resp.voice_profile.voice_profile_domain_id #=> String
resp.voice_profile.created_timestamp #=> Time
resp.voice_profile.updated_timestamp #=> Time
resp.voice_profile.expiration_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :voice_profile_id (required, String) —

    The voice profile ID.

Returns:

See Also:



2366
2367
2368
2369
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2366

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

#get_voice_profile_domain(params = {}) ⇒ Types::GetVoiceProfileDomainResponse

Retrieves the details of the specified voice profile domain.

Examples:

Request syntax with placeholder values


resp = client.get_voice_profile_domain({
  voice_profile_domain_id: "NonEmptyString256", # required
})

Response structure


resp.voice_profile_domain.voice_profile_domain_id #=> String
resp.voice_profile_domain.voice_profile_domain_arn #=> String
resp.voice_profile_domain.name #=> String
resp.voice_profile_domain.description #=> String
resp.voice_profile_domain.server_side_encryption_configuration.kms_key_arn #=> String
resp.voice_profile_domain.created_timestamp #=> Time
resp.voice_profile_domain.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :voice_profile_domain_id (required, String) —

    The voice profile domain ID.

Returns:

See Also:



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

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

#get_voice_tone_analysis_task(params = {}) ⇒ Types::GetVoiceToneAnalysisTaskResponse

Retrieves the details of a voice tone analysis task.

Examples:

Request syntax with placeholder values


resp = client.get_voice_tone_analysis_task({
  voice_connector_id: "NonEmptyString128", # required
  voice_tone_analysis_task_id: "NonEmptyString256", # required
  is_caller: false, # required
})

Response structure


resp.voice_tone_analysis_task.voice_tone_analysis_task_id #=> String
resp.voice_tone_analysis_task.voice_tone_analysis_task_status #=> String
resp.voice_tone_analysis_task.call_details.voice_connector_id #=> String
resp.voice_tone_analysis_task.call_details.transaction_id #=> String
resp.voice_tone_analysis_task.call_details.is_caller #=> Boolean
resp.voice_tone_analysis_task.created_timestamp #=> Time
resp.voice_tone_analysis_task.updated_timestamp #=> Time
resp.voice_tone_analysis_task.started_timestamp #=> Time
resp.voice_tone_analysis_task.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :voice_tone_analysis_task_id (required, String) —

    The ID of the voice tone analysis task.

  • :is_caller (required, Boolean) —

    Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

Returns:

See Also:



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

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

#list_available_voice_connector_regions(params = {}) ⇒ Types::ListAvailableVoiceConnectorRegionsResponse

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

Examples:

Response structure


resp.voice_connector_regions #=> Array
resp.voice_connector_regions[0] #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2"

Parameters:

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

    ({})

Returns:

See Also:



2466
2467
2468
2469
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2466

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

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

Lists the phone numbers for an administrator's Amazon Chime SDK account.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.phone_number_orders #=> Array
resp.phone_number_orders[0].phone_number_order_id #=> String
resp.phone_number_orders[0].product_type #=> String, one of "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number_orders[0].status #=> String, one of "Processing", "Successful", "Failed", "Partial", "PendingDocuments", "Submitted", "FOC", "ChangeRequested", "Exception", "CancelRequested", "Cancelled"
resp.phone_number_orders[0].order_type #=> String, one of "New", "Porting"
resp.phone_number_orders[0].ordered_phone_numbers #=> Array
resp.phone_number_orders[0].ordered_phone_numbers[0].e164_phone_number #=> String
resp.phone_number_orders[0].ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
resp.phone_number_orders[0].created_timestamp #=> Time
resp.phone_number_orders[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token used to retrieve the next page of results.

  • :max_results (Integer) —

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

Returns:

See Also:



2512
2513
2514
2515
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2512

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_phone_numbers({
  status: "String",
  product_type: "VoiceConnector", # accepts VoiceConnector, SipMediaApplicationDialIn
  filter_name: "VoiceConnectorId", # accepts VoiceConnectorId, VoiceConnectorGroupId, SipRuleId
  filter_value: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :status (String) —

    The status of your organization's phone numbers.

  • :product_type (String) —

    The phone number product types.

  • :filter_name (String) —

    The filter to limit the number of results.

  • :filter_value (String) —

    The filter value.

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token used to return the next page of results.

Returns:

See Also:



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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :status (String) —

    The proxy session status.

  • :next_token (String) —

    The token used to retrieve the next page of results.

  • :max_results (Integer) —

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

Returns:

See Also:



2651
2652
2653
2654
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2651

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

#list_sip_media_applications(params = {}) ⇒ Types::ListSipMediaApplicationsResponse

Lists the SIP media applications under the administrator's AWS account.

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

Examples:

Request syntax with placeholder values


resp = client.list_sip_media_applications({
  max_results: 1,
  next_token: "NextTokenString",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token used to return the next page of results.

Returns:

See Also:



2697
2698
2699
2700
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2697

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

#list_sip_rules(params = {}) ⇒ Types::ListSipRulesResponse

Lists the SIP rules under the administrator's AWS account.

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

Examples:

Request syntax with placeholder values


resp = client.list_sip_rules({
  sip_media_application_id: "NonEmptyString",
  max_results: 1,
  next_token: "NextTokenString",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (String) —

    The SIP media application ID.

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token used to return the next page of results.

Returns:

See Also:



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

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

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

Lists the countries that you can order phone numbers from.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :product_type (required, String) —

    The phone number product type.

Returns:

See Also:



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

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of the tags in a given resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource ARN.

Returns:

See Also:



2810
2811
2812
2813
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2810

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token used to return the next page of results.

  • :max_results (Integer) —

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

Returns:

See Also:



2855
2856
2857
2858
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2855

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

Returns:

See Also:



2885
2886
2887
2888
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2885

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

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

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.voice_connectors #=> Array
resp.voice_connectors[0].voice_connector_id #=> String
resp.voice_connectors[0].aws_region #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2"
resp.voice_connectors[0].name #=> String
resp.voice_connectors[0].outbound_host_name #=> String
resp.voice_connectors[0].require_encryption #=> Boolean
resp.voice_connectors[0].created_timestamp #=> Time
resp.voice_connectors[0].updated_timestamp #=> Time
resp.voice_connectors[0].voice_connector_arn #=> String
resp.voice_connectors[0].integration_type #=> String, one of "CONNECT_CALL_TRANSFER_CONNECTOR", "CONNECT_ANALYTICS_CONNECTOR"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token used to return the next page of results.

  • :max_results (Integer) —

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

Returns:

See Also:



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

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

#list_voice_profile_domains(params = {}) ⇒ Types::ListVoiceProfileDomainsResponse

Lists the specified voice profile domains in the administrator's AWS account.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.voice_profile_domains #=> Array
resp.voice_profile_domains[0].voice_profile_domain_id #=> String
resp.voice_profile_domains[0].voice_profile_domain_arn #=> String
resp.voice_profile_domains[0].name #=> String
resp.voice_profile_domains[0].description #=> String
resp.voice_profile_domains[0].created_timestamp #=> Time
resp.voice_profile_domains[0].updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token used to return the next page of results.

  • :max_results (Integer) —

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

Returns:

See Also:



2974
2975
2976
2977
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 2974

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

#list_voice_profiles(params = {}) ⇒ Types::ListVoiceProfilesResponse

Lists the voice profiles in a voice profile domain.

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

Examples:

Request syntax with placeholder values


resp = client.list_voice_profiles({
  voice_profile_domain_id: "NonEmptyString256", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.voice_profiles #=> Array
resp.voice_profiles[0].voice_profile_id #=> String
resp.voice_profiles[0].voice_profile_arn #=> String
resp.voice_profiles[0].voice_profile_domain_id #=> String
resp.voice_profiles[0].created_timestamp #=> Time
resp.voice_profiles[0].updated_timestamp #=> Time
resp.voice_profiles[0].expiration_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_profile_domain_id (required, String) —

    The ID of the voice profile domain.

  • :next_token (String) —

    The token used to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of results in the request.

Returns:

See Also:



3020
3021
3022
3023
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3020

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

#put_sip_media_application_alexa_skill_configuration(params = {}) ⇒ Types::PutSipMediaApplicationAlexaSkillConfigurationResponse

Updates the Alexa Skill configuration for the SIP media application.

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.

Examples:

Request syntax with placeholder values


resp = client.put_sip_media_application_alexa_skill_configuration({
  sip_media_application_id: "NonEmptyString", # required
  sip_media_application_alexa_skill_configuration: {
    alexa_skill_status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
    alexa_skill_ids: ["AlexaSkillId"], # required
  },
})

Response structure


resp.sip_media_application_alexa_skill_configuration.alexa_skill_status #=> String, one of "ACTIVE", "INACTIVE"
resp.sip_media_application_alexa_skill_configuration.alexa_skill_ids #=> Array
resp.sip_media_application_alexa_skill_configuration.alexa_skill_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



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

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

#put_sip_media_application_logging_configuration(params = {}) ⇒ Types::PutSipMediaApplicationLoggingConfigurationResponse

Updates the logging configuration for the specified SIP media application.

Examples:

Request syntax with placeholder values


resp = client.put_sip_media_application_logging_configuration({
  sip_media_application_id: "NonEmptyString", # required
  sip_media_application_logging_configuration: {
    enable_sip_media_application_message_logs: false,
  },
})

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.

  • :sip_media_application_logging_configuration (Types::SipMediaApplicationLoggingConfiguration) —

    The logging configuration for the specified SIP media application.

Returns:

See Also:



3100
3101
3102
3103
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3100

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

#put_voice_connector_emergency_calling_configuration(params = {}) ⇒ Types::PutVoiceConnectorEmergencyCallingConfigurationResponse

Updates a Voice Connector's emergency calling configuration.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_emergency_calling_configuration({
  voice_connector_id: "NonEmptyString", # required
  emergency_calling_configuration: { # required
    dnis: [
      {
        emergency_phone_number: "E164PhoneNumber", # required
        test_phone_number: "E164PhoneNumber",
        calling_country: "Alpha2CountryCode", # 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 Voice Connector ID.

  • :emergency_calling_configuration (required, Types::EmergencyCallingConfiguration) —

    The configuration being updated.

Returns:

See Also:



3143
3144
3145
3146
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3143

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

#put_voice_connector_external_systems_configuration(params = {}) ⇒ Types::PutVoiceConnectorExternalSystemsConfigurationResponse

Adds an external systems configuration to a Voice Connector.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_external_systems_configuration({
  voice_connector_id: "NonEmptyString128", # required
  session_border_controller_types: ["RIBBON_SBC"], # accepts RIBBON_SBC, ORACLE_ACME_PACKET_SBC, AVAYA_SBCE, CISCO_UNIFIED_BORDER_ELEMENT, AUDIOCODES_MEDIANT_SBC
  contact_center_system_types: ["GENESYS_ENGAGE_ON_PREMISES"], # accepts GENESYS_ENGAGE_ON_PREMISES, AVAYA_AURA_CALL_CENTER_ELITE, AVAYA_AURA_CONTACT_CENTER, CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE
})

Response structure


resp.external_systems_configuration.session_border_controller_types #=> Array
resp.external_systems_configuration.session_border_controller_types[0] #=> String, one of "RIBBON_SBC", "ORACLE_ACME_PACKET_SBC", "AVAYA_SBCE", "CISCO_UNIFIED_BORDER_ELEMENT", "AUDIOCODES_MEDIANT_SBC"
resp.external_systems_configuration.contact_center_system_types #=> Array
resp.external_systems_configuration.contact_center_system_types[0] #=> String, one of "GENESYS_ENGAGE_ON_PREMISES", "AVAYA_AURA_CALL_CENTER_ELITE", "AVAYA_AURA_CONTACT_CENTER", "CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE"

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The ID of the Voice Connector for which to add the external system configuration.

  • :session_border_controller_types (Array<String>) —

    The session border controllers to use.

  • :contact_center_system_types (Array<String>) —

    The contact center system to use.

Returns:

See Also:



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

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

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

Updates a Voice Connector's logging configuration.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_logging_configuration({
  voice_connector_id: "NonEmptyString", # required
  logging_configuration: { # required
    enable_sip_logs: false,
    enable_media_metric_logs: false,
  },
})

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 Voice Connector ID.

  • :logging_configuration (required, Types::LoggingConfiguration) —

    The logging configuration being updated.

Returns:

See Also:



3219
3220
3221
3222
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3219

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

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

Updates a Voice Connector's origination settings.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :origination (required, Types::Origination) —

    The origination settings being updated.

Returns:

See Also:



3268
3269
3270
3271
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3268

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :default_session_expiry_minutes (required, Integer) —

    The default number of minutes allowed for proxy session.

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

    The countries for proxy phone numbers to be selected from.

  • :fall_back_phone_number (String) —

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

  • :disabled (Boolean) —

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

Returns:

See Also:



3318
3319
3320
3321
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3318

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

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

Updates a Voice Connector's streaming configuration settings.

Examples:

Request syntax with placeholder values


resp = client.put_voice_connector_streaming_configuration({
  voice_connector_id: "NonEmptyString", # required
  streaming_configuration: { # required
    data_retention_in_hours: 1, # required
    disabled: false, # required
    streaming_notification_targets: [
      {
        notification_target: "EventBridge", # accepts EventBridge, SNS, SQS
      },
    ],
    media_insights_configuration: {
      disabled: false,
      configuration_arn: "Arn",
    },
  },
})

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"
resp.streaming_configuration.media_insights_configuration.disabled #=> Boolean
resp.streaming_configuration.media_insights_configuration.configuration_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :streaming_configuration (required, Types::StreamingConfiguration) —

    The streaming settings being updated.

Returns:

See Also:



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

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

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

Updates a Voice Connector's termination settings.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :termination (required, Types::Termination) —

    The termination settings to be updated.

Returns:

See Also:



3411
3412
3413
3414
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3411

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

#put_voice_connector_termination_credentials(params = {}) ⇒ Struct

Updates a Voice Connector's termination credentials.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

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

    The termination credentials being updated.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

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

Restores a deleted phone number.

Examples:

Request syntax with placeholder values


resp = client.restore_phone_number({
  phone_number_id: "SensitiveNonEmptyString", # 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 "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number.status #=> String, one of "Cancelled", "PortinCancelRequested", "PortinInProgress", "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 "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
resp.phone_number.order_id #=> String
resp.phone_number.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The ID of the phone number being restored.

Returns:

See Also:



3492
3493
3494
3495
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3492

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

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

Searches the provisioned phone numbers in an organization.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :area_code (String) —

    Confines a search to just the phone numbers associated with the specified area code.

  • :city (String) —

    Confines a search to just the phone numbers associated with the specified city.

  • :country (String) —

    Confines a search to just the phone numbers associated with the specified country.

  • :state (String) —

    Confines a search to just the phone numbers associated with the specified state.

  • :toll_free_prefix (String) —

    Confines a search to just the phone numbers associated with the specified toll-free prefix.

  • :phone_number_type (String) —

    Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token used to return the next page of results.

Returns:

See Also:



3559
3560
3561
3562
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3559

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

#start_speaker_search_task(params = {}) ⇒ Types::StartSpeakerSearchTaskResponse

Starts a speaker search task.

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

Examples:

Request syntax with placeholder values


resp = client.start_speaker_search_task({
  voice_connector_id: "NonEmptyString128", # required
  transaction_id: "NonEmptyString256", # required
  voice_profile_domain_id: "NonEmptyString256", # required
  client_request_token: "ClientRequestId",
  call_leg: "Caller", # accepts Caller, Callee
})

Response structure


resp.speaker_search_task.speaker_search_task_id #=> String
resp.speaker_search_task.speaker_search_task_status #=> String
resp.speaker_search_task.call_details.voice_connector_id #=> String
resp.speaker_search_task.call_details.transaction_id #=> String
resp.speaker_search_task.call_details.is_caller #=> Boolean
resp.speaker_search_task.speaker_search_details.results #=> Array
resp.speaker_search_task.speaker_search_details.results[0].confidence_score #=> Float
resp.speaker_search_task.speaker_search_details.results[0].voice_profile_id #=> String
resp.speaker_search_task.speaker_search_details.voiceprint_generation_status #=> String
resp.speaker_search_task.created_timestamp #=> Time
resp.speaker_search_task.updated_timestamp #=> Time
resp.speaker_search_task.started_timestamp #=> Time
resp.speaker_search_task.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :transaction_id (required, String) —

    The transaction ID of the call being analyzed.

  • :voice_profile_domain_id (required, String) —

    The ID of the voice profile domain that will store the voice profile.

  • :client_request_token (String) —

    The unique identifier for the client request. Use a different token for different speaker search tasks.

  • :call_leg (String) —

    Specifies which call leg to stream for speaker search.

Returns:

See Also:



3625
3626
3627
3628
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3625

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

#start_voice_tone_analysis_task(params = {}) ⇒ Types::StartVoiceToneAnalysisTaskResponse

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

Examples:

Request syntax with placeholder values


resp = client.start_voice_tone_analysis_task({
  voice_connector_id: "NonEmptyString128", # required
  transaction_id: "NonEmptyString256", # required
  language_code: "en-US", # required, accepts en-US
  client_request_token: "ClientRequestId",
})

Response structure


resp.voice_tone_analysis_task.voice_tone_analysis_task_id #=> String
resp.voice_tone_analysis_task.voice_tone_analysis_task_status #=> String
resp.voice_tone_analysis_task.call_details.voice_connector_id #=> String
resp.voice_tone_analysis_task.call_details.transaction_id #=> String
resp.voice_tone_analysis_task.call_details.is_caller #=> Boolean
resp.voice_tone_analysis_task.created_timestamp #=> Time
resp.voice_tone_analysis_task.updated_timestamp #=> Time
resp.voice_tone_analysis_task.started_timestamp #=> Time
resp.voice_tone_analysis_task.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :transaction_id (required, String) —

    The transaction ID.

  • :language_code (required, String) —

    The language code.

  • :client_request_token (String) —

    The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

Returns:

See Also:



3686
3687
3688
3689
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3686

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

#stop_speaker_search_task(params = {}) ⇒ Struct

Stops a speaker search task.

Examples:

Request syntax with placeholder values


resp = client.stop_speaker_search_task({
  voice_connector_id: "NonEmptyString128", # required
  speaker_search_task_id: "NonEmptyString256", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :speaker_search_task_id (required, String) —

    The speaker search task ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3712
3713
3714
3715
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3712

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

#stop_voice_tone_analysis_task(params = {}) ⇒ Struct

Stops a voice tone analysis task.

Examples:

Request syntax with placeholder values


resp = client.stop_voice_tone_analysis_task({
  voice_connector_id: "NonEmptyString128", # required
  voice_tone_analysis_task_id: "NonEmptyString256", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :voice_tone_analysis_task_id (required, String) —

    The ID of the voice tone analysis task.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3738
3739
3740
3741
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3738

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

#tag_resource(params = {}) ⇒ Struct

Adds a tag to the specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource being tagged.

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

    A list of the tags being added to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3769
3770
3771
3772
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3769

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource having its tags removed.

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

    The keys of the tags being removed from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3795
3796
3797
3798
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3795

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

#update_global_settings(params = {}) ⇒ Struct

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3820
3821
3822
3823
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3820

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

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

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

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

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

Examples:

Request syntax with placeholder values


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

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 "VoiceConnector", "SipMediaApplicationDialIn"
resp.phone_number.status #=> String, one of "Cancelled", "PortinCancelRequested", "PortinInProgress", "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 "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
resp.phone_number.order_id #=> String
resp.phone_number.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The phone number ID.

  • :product_type (String) —

    The product type.

  • :calling_name (String) —

    The outbound calling name associated with the phone number.

  • :name (String) —

    Specifies the updated name assigned to one or more phone numbers.

Returns:

See Also:



3892
3893
3894
3895
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3892

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

#update_phone_number_settings(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :calling_name (required, String) —

    The default outbound calling name for the account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3917
3918
3919
3920
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3917

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :proxy_session_id (required, String) —

    The proxy session ID.

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

    The proxy session capabilities.

  • :expiry_minutes (Integer) —

    The number of minutes allowed for the proxy session.

Returns:

See Also:



3974
3975
3976
3977
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 3974

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

#update_sip_media_application(params = {}) ⇒ Types::UpdateSipMediaApplicationResponse

Updates the details of the specified SIP media application.

Examples:

Request syntax with placeholder values


resp = client.update_sip_media_application({
  sip_media_application_id: "NonEmptyString", # required
  name: "SipMediaApplicationName",
  endpoints: [
    {
      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
resp.sip_media_application.sip_media_application_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The SIP media application ID.

  • :name (String) —

    The new name for the specified SIP media application.

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

    The new set of endpoints for the specified SIP media application.

Returns:

See Also:



4021
4022
4023
4024
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 4021

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

#update_sip_media_application_call(params = {}) ⇒ Types::UpdateSipMediaApplicationCallResponse

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

Examples:

Request syntax with placeholder values


resp = client.update_sip_media_application_call({
  sip_media_application_id: "NonEmptyString", # required
  transaction_id: "NonEmptyString", # required
  arguments: { # required
    "SensitiveString" => "SensitiveString",
  },
})

Response structure


resp.sip_media_application_call.transaction_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :sip_media_application_id (required, String) —

    The ID of the SIP media application handling the call.

  • :transaction_id (required, String) —

    The ID of the call transaction.

  • :arguments (required, Hash<String,String>) —

    Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

Returns:

See Also:



4062
4063
4064
4065
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 4062

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

#update_sip_rule(params = {}) ⇒ Types::UpdateSipRuleResponse

Updates the details of the specified SIP rule.

Examples:

Request syntax with placeholder values


resp = client.update_sip_rule({
  sip_rule_id: "NonEmptyString", # required
  name: "SipRuleName", # required
  disabled: false,
  target_applications: [
    {
      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):

  • :sip_rule_id (required, String) —

    The SIP rule ID.

  • :name (required, String) —

    The new name for the specified SIP rule.

  • :disabled (Boolean) —

    The new value that indicates whether the rule is disabled.

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

    The new list of target applications.

Returns:

See Also:



4118
4119
4120
4121
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 4118

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

#update_voice_connector(params = {}) ⇒ Types::UpdateVoiceConnectorResponse

Updates the details for the specified Amazon Chime SDK Voice Connector.

Examples:

Request syntax with placeholder values


resp = client.update_voice_connector({
  voice_connector_id: "NonEmptyString", # required
  name: "VoiceConnectorName", # required
  require_encryption: false, # required
})

Response structure


resp.voice_connector.voice_connector_id #=> String
resp.voice_connector.aws_region #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-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
resp.voice_connector.integration_type #=> String, one of "CONNECT_CALL_TRANSFER_CONNECTOR", "CONNECT_ANALYTICS_CONNECTOR"

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_id (required, String) —

    The Voice Connector ID.

  • :name (required, String) —

    The name of the Voice Connector.

  • :require_encryption (required, Boolean) —

    When enabled, requires encryption for the Voice Connector.

Returns:

See Also:



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

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

#update_voice_connector_group(params = {}) ⇒ Types::UpdateVoiceConnectorGroupResponse

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :voice_connector_group_id (required, String) —

    The Voice Connector ID.

  • :name (required, String) —

    The name of the Voice Connector group.

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

    The VoiceConnectorItems to associate with the Voice Connector group.

Returns:

See Also:



4212
4213
4214
4215
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 4212

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

#update_voice_profile(params = {}) ⇒ Types::UpdateVoiceProfileResponse

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.

You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

Examples:

Request syntax with placeholder values


resp = client.update_voice_profile({
  voice_profile_id: "NonEmptyString256", # required
  speaker_search_task_id: "NonEmptyString256", # required
})

Response structure


resp.voice_profile.voice_profile_id #=> String
resp.voice_profile.voice_profile_arn #=> String
resp.voice_profile.voice_profile_domain_id #=> String
resp.voice_profile.created_timestamp #=> Time
resp.voice_profile.updated_timestamp #=> Time
resp.voice_profile.expiration_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :voice_profile_id (required, String) —

    The profile ID.

  • :speaker_search_task_id (required, String) —

    The ID of the speaker search task.

Returns:

See Also:



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

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

#update_voice_profile_domain(params = {}) ⇒ Types::UpdateVoiceProfileDomainResponse

Updates the settings for the specified voice profile domain.

Examples:

Request syntax with placeholder values


resp = client.update_voice_profile_domain({
  voice_profile_domain_id: "NonEmptyString256", # required
  name: "VoiceProfileDomainName",
  description: "VoiceProfileDomainDescription",
})

Response structure


resp.voice_profile_domain.voice_profile_domain_id #=> String
resp.voice_profile_domain.voice_profile_domain_arn #=> String
resp.voice_profile_domain.name #=> String
resp.voice_profile_domain.description #=> String
resp.voice_profile_domain.server_side_encryption_configuration.kms_key_arn #=> String
resp.voice_profile_domain.created_timestamp #=> Time
resp.voice_profile_domain.updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :voice_profile_domain_id (required, String) —

    The domain ID.

  • :name (String) —

    The name of the voice profile domain.

  • :description (String) —

    The description of the voice profile domain.

Returns:

See Also:



4305
4306
4307
4308
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 4305

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

#validate_e911_address(params = {}) ⇒ Types::ValidateE911AddressResponse

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

Examples:

Request syntax with placeholder values


resp = client.validate_e911_address({
  aws_account_id: "NonEmptyString", # required
  street_number: "SensitiveNonEmptyString", # required
  street_info: "SensitiveNonEmptyString", # required
  city: "SensitiveNonEmptyString", # required
  state: "SensitiveNonEmptyString", # required
  country: "SensitiveNonEmptyString", # required
  postal_code: "SensitiveNonEmptyString", # required
})

Response structure


resp.validation_result #=> Integer
resp.address_external_id #=> String
resp.address.street_name #=> String
resp.address.street_suffix #=> String
resp.address.post_directional #=> String
resp.address.pre_directional #=> String
resp.address.street_number #=> String
resp.address.city #=> String
resp.address.state #=> String
resp.address.postal_code #=> String
resp.address.postal_code_plus_4 #=> String
resp.address.country #=> String
resp.candidate_address_list #=> Array
resp.candidate_address_list[0].street_info #=> String
resp.candidate_address_list[0].street_number #=> String
resp.candidate_address_list[0].city #=> String
resp.candidate_address_list[0].state #=> String
resp.candidate_address_list[0].postal_code #=> String
resp.candidate_address_list[0].postal_code_plus_4 #=> String
resp.candidate_address_list[0].country #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The AWS account ID.

  • :street_number (required, String) —

    The address street number, such as 200 or 2121.

  • :street_info (required, String) —

    The address street information, such as 8th Avenue.

  • :city (required, String) —

    The address city, such as Portland.

  • :state (required, String) —

    The address state, such as ME.

  • :country (required, String) —

    The country in the address being validated as two-letter country code in ISO 3166-1 alpha-2 format, such as US. For more information, see ISO 3166-1 alpha-2 in Wikipedia.

  • :postal_code (required, String) —

    The dress postal code, such 04352.

Returns:

See Also:



4389
4390
4391
4392
 
# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/client.rb', line 4389

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