class Aws::PinpointSMSVoice::Client

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

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Attributes

identifier[R]

@api private

Public Class Methods

errors_module() click to toggle source

@api private

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 651
def errors_module
  Errors
end
new(*args) click to toggle source

@overload initialize(options)

@param [Hash] options
@option options [required, Aws::CredentialProvider] :credentials
  Your AWS credentials. This can be an instance of any one of the
  following classes:

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

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

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

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

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

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

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

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

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

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

  * `Aws.config[:credentials]`
  * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
  * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
  * `~/.aws/credentials`
  * `~/.aws/config`
  * EC2/ECS IMDS instance profile - When used by default, the timeouts
    are very aggressive. Construct and pass an instance of
    `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
    enable retries and extended timeouts.

@option options [required, String] :region
  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`

@option options [String] :access_key_id

@option options [Boolean] :active_endpoint_cache (false)
  When set to `true`, a thread polling for endpoints will be running in
  the background every 60 secs (default). Defaults to `false`.

@option options [Boolean] :adaptive_retry_wait_to_fill (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.

@option options [Boolean] :client_side_monitoring (false)
  When `true`, client-side metrics will be collected for all API requests from
  this client.

@option options [String] :client_side_monitoring_client_id ("")
  Allows you to provide an identifier for this client which will be attached to
  all generated client side metrics. Defaults to an empty string.

@option options [String] :client_side_monitoring_host ("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.

@option options [Integer] :client_side_monitoring_port (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.

@option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
  Allows you to provide a custom client-side monitoring publisher class. By default,
  will use the Client Side Monitoring Agent Publisher.

@option options [Boolean] :convert_params (true)
  When `true`, an attempt is made to coerce request parameters into
  the required types.

@option options [Boolean] :correct_clock_skew (true)
  Used only in `standard` and adaptive retry modes. Specifies whether to apply
  a clock skew correction and retry requests with skewed client clocks.

@option options [Boolean] :disable_host_prefix_injection (false)
  Set to true to disable SDK automatically adding host prefix
  to default service endpoint when available.

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

@option options [Integer] :endpoint_cache_max_entries (1000)
  Used for the maximum size limit of the LRU cache storing endpoints data
  for endpoint discovery enabled operations. Defaults to 1000.

@option options [Integer] :endpoint_cache_max_threads (10)
  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

@option options [Integer] :endpoint_cache_poll_interval (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.

@option options [Boolean] :endpoint_discovery (false)
  When set to `true`, endpoint discovery will be enabled for operations when available.

@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
  The log formatter.

@option options [Symbol] :log_level (:info)
  The log level to send messages to the `:logger` at.

@option options [Logger] :logger
  The Logger instance to send log messages to.  If this option
  is not set, logging will be disabled.

@option options [Integer] :max_attempts (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.

@option options [String] :profile ("default")
  Used when loading credentials from the shared credentials file
  at HOME/.aws/credentials.  When not specified, 'default' is used.

@option options [Proc] :retry_backoff
  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
  This option is only used in the `legacy` retry mode.

@option options [Float] :retry_base_delay (0.3)
  The base delay in seconds used by the default backoff function. This option
  is only used in the `legacy` retry mode.

@option options [Symbol] :retry_jitter (: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

@option options [Integer] :retry_limit (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.

@option options [Integer] :retry_max_delay (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.

@option options [String] :retry_mode ("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.

@option options [String] :secret_access_key

@option options [String] :session_token

@option options [Boolean] :stub_responses (false)
  Causes the client to return stubbed responses. By default
  fake responses are generated and returned. You can specify
  the response data to return or errors to raise by calling
  {ClientStubs#stub_responses}. See {ClientStubs} for more information.

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

@option options [Boolean] :validate_params (true)
  When `true`, request parameters are validated before
  sending the request.

@option options [URI::HTTP,String] :http_proxy A proxy to send
  requests through.  Formatted like 'http://proxy.com:123'.

@option options [Float] :http_open_timeout (15) The number of
  seconds to wait when opening a HTTP session before raising a
  `Timeout::Error`.

@option options [Integer] :http_read_timeout (60) The default
  number of seconds to wait for response data.  This value can
  safely be set per-request on the session.

@option options [Float] :http_idle_timeout (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.

@option options [Float] :http_continue_timeout (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.

@option options [Boolean] :http_wire_trace (false) When `true`,
  HTTP debug output will be sent to the `:logger`.

@option options [Boolean] :ssl_verify_peer (true) When `true`,
  SSL peer certificates are verified when establishing a
  connection.

@option options [String] :ssl_ca_bundle 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.

@option options [String] :ssl_ca_directory 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.
Calls superclass method
# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 324
def initialize(*args)
  super
end

Public Instance Methods

build_request(operation_name, params = {}) click to toggle source

@param params ({}) @api private

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 626
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-pinpointsmsvoice'
  context[:gem_version] = '1.26.0'
  Seahorse::Client::Request.new(handlers, context)
end
create_configuration_set(params = {}, options = {}) click to toggle source

Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

@option params [String] :configuration_set_name

The name that you want to give the configuration set.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.create_configuration_set({
  configuration_set_name: "WordCharactersWithDelimiters",
})

@see docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSet AWS API Documentation

@overload create_configuration_set(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 348
def create_configuration_set(params = {}, options = {})
  req = build_request(:create_configuration_set, params)
  req.send_request(options)
end
create_configuration_set_event_destination(params = {}, options = {}) click to toggle source

Create a new event destination in a configuration set.

@option params [required, String] :configuration_set_name

@option params [Types::EventDestinationDefinition] :event_destination

An object that defines a single event destination.

@option params [String] :event_destination_name

A name that identifies the event destination.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.create_configuration_set_event_destination({
  configuration_set_name: "__string", # required
  event_destination: {
    cloud_watch_logs_destination: {
      iam_role_arn: "String",
      log_group_arn: "String",
    },
    enabled: false,
    kinesis_firehose_destination: {
      delivery_stream_arn: "String",
      iam_role_arn: "String",
    },
    matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
    sns_destination: {
      topic_arn: "String",
    },
  },
  event_destination_name: "NonEmptyString",
})

@see docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetEventDestination AWS API Documentation

@overload create_configuration_set_event_destination(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 391
def create_configuration_set_event_destination(params = {}, options = {})
  req = build_request(:create_configuration_set_event_destination, params)
  req.send_request(options)
end
delete_configuration_set(params = {}, options = {}) click to toggle source

Deletes an existing configuration set.

@option params [required, String] :configuration_set_name

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.delete_configuration_set({
  configuration_set_name: "__string", # required
})

@see docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSet AWS API Documentation

@overload delete_configuration_set(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 412
def delete_configuration_set(params = {}, options = {})
  req = build_request(:delete_configuration_set, params)
  req.send_request(options)
end
delete_configuration_set_event_destination(params = {}, options = {}) click to toggle source

Deletes an event destination in a configuration set.

@option params [required, String] :configuration_set_name

@option params [required, String] :event_destination_name

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.delete_configuration_set_event_destination({
  configuration_set_name: "__string", # required
  event_destination_name: "__string", # required
})

@see docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetEventDestination AWS API Documentation

@overload delete_configuration_set_event_destination(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 436
def delete_configuration_set_event_destination(params = {}, options = {})
  req = build_request(:delete_configuration_set_event_destination, params)
  req.send_request(options)
end
get_configuration_set_event_destinations(params = {}, options = {}) click to toggle source

Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

@option params [required, String] :configuration_set_name

@return [Types::GetConfigurationSetEventDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetConfigurationSetEventDestinationsResponse#event_destinations #event_destinations} => Array<Types::EventDestination>

@example Request syntax with placeholder values

resp = client.get_configuration_set_event_destinations({
  configuration_set_name: "__string", # required
})

@example Response structure

resp.event_destinations #=> Array
resp.event_destinations[0].cloud_watch_logs_destination.iam_role_arn #=> String
resp.event_destinations[0].cloud_watch_logs_destination.log_group_arn #=> String
resp.event_destinations[0].enabled #=> Boolean
resp.event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
resp.event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
resp.event_destinations[0].matching_event_types #=> Array
resp.event_destinations[0].matching_event_types[0] #=> String, one of "INITIATED_CALL", "RINGING", "ANSWERED", "COMPLETED_CALL", "BUSY", "FAILED", "NO_ANSWER"
resp.event_destinations[0].name #=> String
resp.event_destinations[0].sns_destination.topic_arn #=> String

@see docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/GetConfigurationSetEventDestinations AWS API Documentation

@overload get_configuration_set_event_destinations(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 474
def get_configuration_set_event_destinations(params = {}, options = {})
  req = build_request(:get_configuration_set_event_destinations, params)
  req.send_request(options)
end
list_configuration_sets(params = {}, options = {}) click to toggle source

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

@option params [String] :next_token

@option params [String] :page_size

@return [Types::ListConfigurationSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListConfigurationSetsResponse#configuration_sets #configuration_sets} => Array<String>
* {Types::ListConfigurationSetsResponse#next_token #next_token} => String

@example Request syntax with placeholder values

resp = client.list_configuration_sets({
  next_token: "__string",
  page_size: "__string",
})

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/ListConfigurationSets AWS API Documentation

@overload list_configuration_sets(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 508
def list_configuration_sets(params = {}, options = {})
  req = build_request(:list_configuration_sets, params)
  req.send_request(options)
end
send_voice_message(params = {}, options = {}) click to toggle source

Create a new voice message and send it to a recipient's phone number.

@option params [String] :caller_id

The phone number that appears on recipients' devices when they
receive the message.

@option params [String] :configuration_set_name

The name of the configuration set that you want to use to send the
message.

@option params [Types::VoiceMessageContent] :content

An object that contains a voice message and information about the
recipient that you want to send it to.

@option params [String] :destination_phone_number

The phone number that you want to send the voice message to.

@option params [String] :origination_phone_number

The phone number that Amazon Pinpoint should use to send the voice
message. This isn't necessarily the phone number that appears on
recipients' devices when they receive the message, because you can
specify a CallerId parameter in the request.

@return [Types::SendVoiceMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::SendVoiceMessageResponse#message_id #message_id} => String

@example Request syntax with placeholder values

resp = client.send_voice_message({
  caller_id: "String",
  configuration_set_name: "WordCharactersWithDelimiters",
  content: {
    call_instructions_message: {
      text: "NonEmptyString",
    },
    plain_text_message: {
      language_code: "String",
      text: "NonEmptyString",
      voice_id: "String",
    },
    ssml_message: {
      language_code: "String",
      text: "NonEmptyString",
      voice_id: "String",
    },
  },
  destination_phone_number: "NonEmptyString",
  origination_phone_number: "NonEmptyString",
})

@example Response structure

resp.message_id #=> String

@see docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SendVoiceMessage AWS API Documentation

@overload send_voice_message(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 572
def send_voice_message(params = {}, options = {})
  req = build_request(:send_voice_message, params)
  req.send_request(options)
end
update_configuration_set_event_destination(params = {}, options = {}) click to toggle source

Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.

@option params [required, String] :configuration_set_name

@option params [Types::EventDestinationDefinition] :event_destination

An object that defines a single event destination.

@option params [required, String] :event_destination_name

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.update_configuration_set_event_destination({
  configuration_set_name: "__string", # required
  event_destination: {
    cloud_watch_logs_destination: {
      iam_role_arn: "String",
      log_group_arn: "String",
    },
    enabled: false,
    kinesis_firehose_destination: {
      delivery_stream_arn: "String",
      iam_role_arn: "String",
    },
    matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
    sns_destination: {
      topic_arn: "String",
    },
  },
  event_destination_name: "__string", # required
})

@see docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/UpdateConfigurationSetEventDestination AWS API Documentation

@overload update_configuration_set_event_destination(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 617
def update_configuration_set_event_destination(params = {}, options = {})
  req = build_request(:update_configuration_set_event_destination, params)
  req.send_request(options)
end
waiter_names() click to toggle source

@api private @deprecated

# File lib/aws-sdk-pinpointsmsvoice/client.rb, line 641
def waiter_names
  []
end