Class: Aws::PinpointSMSVoiceV2::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-pinpointsmsvoicev2/client.rb,
sig/client.rbs

Overview

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

client = Aws::PinpointSMSVoiceV2::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.

Defined Under Namespace

Modules: _AssociateOriginationIdentityResponseSuccess, _AssociateProtectConfigurationResponseSuccess, _CarrierLookupResponseSuccess, _CreateConfigurationSetResponseSuccess, _CreateEventDestinationResponseSuccess, _CreateNotifyConfigurationResponseSuccess, _CreateOptOutListResponseSuccess, _CreatePoolResponseSuccess, _CreateProtectConfigurationResponseSuccess, _CreateRcsAgentResponseSuccess, _CreateRegistrationAssociationResponseSuccess, _CreateRegistrationAttachmentResponseSuccess, _CreateRegistrationResponseSuccess, _CreateRegistrationVersionResponseSuccess, _CreateVerifiedDestinationNumberResponseSuccess, _DeleteAccountDefaultProtectConfigurationResponseSuccess, _DeleteConfigurationSetResponseSuccess, _DeleteDefaultMessageTypeResponseSuccess, _DeleteDefaultSenderIdResponseSuccess, _DeleteEventDestinationResponseSuccess, _DeleteKeywordResponseSuccess, _DeleteMediaMessageSpendLimitOverrideResponseSuccess, _DeleteNotifyConfigurationResponseSuccess, _DeleteNotifyMessageSpendLimitOverrideResponseSuccess, _DeleteOptOutListResponseSuccess, _DeleteOptedOutNumberResponseSuccess, _DeletePoolResponseSuccess, _DeleteProtectConfigurationResponseSuccess, _DeleteProtectConfigurationRuleSetNumberOverrideResponseSuccess, _DeleteRcsAgentResponseSuccess, _DeleteRcsMessageSpendLimitOverrideResponseSuccess, _DeleteRegistrationAttachmentResponseSuccess, _DeleteRegistrationFieldValueResponseSuccess, _DeleteRegistrationResponseSuccess, _DeleteResourcePolicyResponseSuccess, _DeleteTextMessageSpendLimitOverrideResponseSuccess, _DeleteVerifiedDestinationNumberResponseSuccess, _DeleteVoiceMessageSpendLimitOverrideResponseSuccess, _DescribeAccountAttributesResponseSuccess, _DescribeAccountLimitsResponseSuccess, _DescribeConfigurationSetsResponseSuccess, _DescribeKeywordsResponseSuccess, _DescribeNotifyConfigurationsResponseSuccess, _DescribeNotifyTemplatesResponseSuccess, _DescribeOptOutListsResponseSuccess, _DescribeOptedOutNumbersResponseSuccess, _DescribePhoneNumbersResponseSuccess, _DescribePoolsResponseSuccess, _DescribeProtectConfigurationsResponseSuccess, _DescribeRcsAgentCountryLaunchStatusResponseSuccess, _DescribeRcsAgentsResponseSuccess, _DescribeRegistrationAttachmentsResponseSuccess, _DescribeRegistrationFieldDefinitionsResponseSuccess, _DescribeRegistrationFieldValuesResponseSuccess, _DescribeRegistrationSectionDefinitionsResponseSuccess, _DescribeRegistrationTypeDefinitionsResponseSuccess, _DescribeRegistrationVersionsResponseSuccess, _DescribeRegistrationsResponseSuccess, _DescribeSenderIdsResponseSuccess, _DescribeSpendLimitsResponseSuccess, _DescribeVerifiedDestinationNumbersResponseSuccess, _DisassociateOriginationIdentityResponseSuccess, _DisassociateProtectConfigurationResponseSuccess, _DiscardRegistrationVersionResponseSuccess, _GetProtectConfigurationCountryRuleSetResponseSuccess, _GetResourcePolicyResponseSuccess, _ListNotifyCountriesResponseSuccess, _ListPoolOriginationIdentitiesResponseSuccess, _ListProtectConfigurationRuleSetNumberOverridesResponseSuccess, _ListRegistrationAssociationsResponseSuccess, _ListTagsForResourceResponseSuccess, _PutKeywordResponseSuccess, _PutMessageFeedbackResponseSuccess, _PutOptedOutNumberResponseSuccess, _PutProtectConfigurationRuleSetNumberOverrideResponseSuccess, _PutRegistrationFieldValueResponseSuccess, _PutResourcePolicyResponseSuccess, _ReleasePhoneNumberResponseSuccess, _ReleaseSenderIdResponseSuccess, _RequestPhoneNumberResponseSuccess, _RequestSenderIdResponseSuccess, _SendDestinationNumberVerificationCodeResponseSuccess, _SendMediaMessageResponseSuccess, _SendNotifyTextMessageResponseSuccess, _SendNotifyVoiceMessageResponseSuccess, _SendRcsMessageResponseSuccess, _SendTextMessageResponseSuccess, _SendVoiceMessageResponseSuccess, _SetAccountDefaultProtectConfigurationResponseSuccess, _SetDefaultMessageFeedbackEnabledResponseSuccess, _SetDefaultMessageTypeResponseSuccess, _SetDefaultSenderIdResponseSuccess, _SetMediaMessageSpendLimitOverrideResponseSuccess, _SetNotifyMessageSpendLimitOverrideResponseSuccess, _SetRcsMessageSpendLimitOverrideResponseSuccess, _SetTextMessageSpendLimitOverrideResponseSuccess, _SetVoiceMessageSpendLimitOverrideResponseSuccess, _SubmitRegistrationVersionResponseSuccess, _TagResourceResponseSuccess, _UntagResourceResponseSuccess, _UpdateEventDestinationResponseSuccess, _UpdateNotifyConfigurationResponseSuccess, _UpdatePhoneNumberResponseSuccess, _UpdatePoolResponseSuccess, _UpdateProtectConfigurationCountryRuleSetResponseSuccess, _UpdateProtectConfigurationResponseSuccess, _UpdateRcsAgentResponseSuccess, _UpdateSenderIdResponseSuccess, _VerifyDestinationNumberResponseSuccess

Constant Summary collapse

Params =

Returns:

  • (:rcs_suggested_action) 

      
    

  




  
Class Attribute Summary collapse

  




  
    

      API Operations
      collapse
    


    
    
  
    

      Class Method Summary
      collapse
    


    
    
  
    

      Instance Method Summary
      collapse
    


    
    
  


  
  

  
Constructor Details

  
    

  

  
    #initialize(options)  ⇒ Client 
  

  

  


  

    
Returns a new instance of Client.


  





  
  

  

    

  





  
Parameters:


    
  
    
  • 
      
        options
      
      
        (Hash)
      
      
      
    
    • 
  



  
    
    
    
Options Hash (options):

    
    
      
        
  • 
          :plugins
          (Array<Seahorse::Client::Plugin>)
          
            
              — default:
              []]
            
          
          
            — 
    A list of plugins to apply to the client. Each plugin is either a
class name or an instance of a plugin class.
    
          
        
    • 
      
        
  • 
          :credentials
          (required, Aws::CredentialProvider)
          
            
          
          
            — 
    Your AWS credentials used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or instance of any one of the following classes:
    

      

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    

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

      

    • 

      Aws.config[:credentials]
      

      • 

    • 

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

      • 

    • 

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

      • 

    • 

      ~/.aws/credentials
      

      • 

    • 

      ~/.aws/config
      

      • 

    • 

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

      • 

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

      

    • Aws.config[:region]
      • 

    • ENV['AWS_REGION']
      • 

    • ENV['AMAZON_REGION']
      • 

    • ENV['AWS_DEFAULT_REGION']
      • 

    • ~/.aws/credentials
      • 

    • ~/.aws/config
      • 

    
          
        
    • 
      
        
  • 
          :access_key_id
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :account_id
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :active_endpoint_cache
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to true, a thread polling for endpoints will be running in
the background every 60 secs (default). Defaults to false.
    
          
        
    • 
      
        
  • 
          :adaptive_retry_wait_to_fill
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    Used only in adaptive retry mode.  When true, the request will sleep
until there is sufficent client side capacity to retry the request.
When false, the request will raise a RetryCapacityNotAvailableError and will
not retry instead of sleeping.
    
          
        
    • 
      
        
  • 
          :auth_scheme_preference
          (Array<String>)
          
            
          
          
            — 
    A list of preferred authentication schemes to use when making a request. Supported values are:
sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in
shared config as auth_scheme_preference, the value should be a comma-separated list.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true, client-side metrics will be collected for all API requests from
this client.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_client_id
          (String)
          
            
              — default:
              ""
            
          
          
            — 
    Allows you to provide an identifier for this client which will be attached to
all generated client side metrics. Defaults to an empty string.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_host
          (String)
          
            
              — default:
              "127.0.0.1"
            
          
          
            — 
    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
side monitoring agent is running on, where client metrics will be published via UDP.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_port
          (Integer)
          
            
              — default:
              31000
            
          
          
            — 
    Required for publishing client metrics. The port that the client side monitoring
agent is running on, where client metrics will be published via UDP.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_publisher
          (Aws::ClientSideMonitoring::Publisher)
          
            
              — default:
              Aws::ClientSideMonitoring::Publisher
            
          
          
            — 
    Allows you to provide a custom client-side monitoring publisher class. By default,
will use the Client Side Monitoring Agent Publisher.
    
          
        
    • 
      
        
  • 
          :convert_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, an attempt is made to coerce request parameters into
the required types.
    
          
        
    • 
      
        
  • 
          :correct_clock_skew
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    Used only in standard and adaptive retry modes. Specifies whether to apply
a clock skew correction and retry requests with skewed client clocks.
    
          
        
    • 
      
        
  • 
          :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
            
          
          
            — 
    When true, the SDK will not prepend the modeled host prefix to the endpoint.
    
          
        
    • 
      
        
  • 
          :disable_request_compression
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to 'true' the request body will not be compressed
for supported operations.
    
          
        
    • 
      
        
  • 
          :endpoint
          (String, URI::HTTPS, URI::HTTP)
          
            
          
          
            — 
    Normally you should not configure the :endpoint option
directly. This is normally constructed from the :region
option. Configuring :endpoint is normally reserved for
connecting to test or custom endpoints. The endpoint should
be a URI formatted like:
    

    'http://example.com'
'https://example.com'
'http://example.com:123'
    
          
        
    • 
      
        
  • 
          :endpoint_cache_max_entries
          (Integer)
          
            
              — default:
              1000
            
          
          
            — 
    Used for the maximum size limit of the LRU cache storing endpoints data
for endpoint discovery enabled operations. Defaults to 1000.
    
          
        
    • 
      
        
  • 
          :endpoint_cache_max_threads
          (Integer)
          
            
              — default:
              10
            
          
          
            — 
    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
    
          
        
    • 
      
        
  • 
          :endpoint_cache_poll_interval
          (Integer)
          
            
              — default:
              60
            
          
          
            — 
    When :endpoint_discovery and :active_endpoint_cache is enabled,
Use this option to config the time interval in seconds for making
requests fetching endpoints information. Defaults to 60 sec.
    
          
        
    • 
      
        
  • 
          :endpoint_discovery
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to true, endpoint discovery will be enabled for operations when available.
    
          
        
    • 
      
        
  • 
          :ignore_configured_endpoint_urls
          (Boolean)
          
            
          
          
            — 
    Setting to true disables use of endpoint URLs provided via environment
variables and the shared configuration file.
    
          
        
    • 
      
        
  • 
          :log_formatter
          (Aws::Log::Formatter)
          
            
              — default:
              Aws::Log::Formatter.default
            
          
          
            — 
    The log formatter.
    
          
        
    • 
      
        
  • 
          :log_level
          (Symbol)
          
            
              — default:
              :info
            
          
          
            — 
    The log level to send messages to the :logger at.
    
          
        
    • 
      
        
  • 
          :logger
          (Logger)
          
            
          
          
            — 
    The Logger instance to send log messages to.  If this option
is not set, logging will be disabled.
    
          
        
    • 
      
        
  • 
          :max_attempts
          (Integer)
          
            
              — default:
              3
            
          
          
            — 
    An integer representing the maximum number attempts that will be made for
a single request, including the initial attempt.  For example,
setting this value to 5 will result in a request being retried up to
4 times. Used in standard and adaptive retry modes.
    
          
        
    • 
      
        
  • 
          :profile
          (String)
          
            
              — default:
              "default"
            
          
          
            — 
    Used when loading credentials from the shared credentials file at HOME/.aws/credentials.
When not specified, 'default' is used.
    
          
        
    • 
      
        
  • 
          :request_checksum_calculation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when a checksum will be calculated for request payloads. Values are:
    

      

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

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

    
          
        
    • 
      
        
  • 
          :request_min_compression_size_bytes
          (Integer)
          
            
              — default:
              10240
            
          
          
            — 
    The minimum size in bytes that triggers compression for request
bodies. The value must be non-negative integer value between 0
and 10485780 bytes inclusive.
    
          
        
    • 
      
        
  • 
          :response_checksum_validation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when checksum validation will be performed on response payloads. Values are:
    

      

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

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

    
          
        
    • 
      
        
  • 
          :retry_backoff
          (Proc)
          
            
          
          
            — 
    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
This option is only used in the legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_base_delay
          (Float)
          
            
              — default:
              0.3
            
          
          
            — 
    The base delay in seconds used by the default backoff function. This option
is only used in the legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_jitter
          (Symbol)
          
            
              — default:
              :none
            
          
          
            — 
    A delay randomiser function used by the default backoff function.
Some predefined functions can be referenced by name - :none, :equal, :full,
otherwise a Proc that takes and returns a number. This option is only used
in the legacy retry mode.
    

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html
    
          
        
    • 
      
        
  • 
          :retry_limit
          (Integer)
          
            
              — default:
              3
            
          
          
            — 
    The maximum number of times to retry failed requests.  Only
~ 500 level server errors and certain ~ 400 level client errors
are retried.  Generally, these are throttling errors, data
checksum errors, networking errors, timeout errors, auth errors,
endpoint discovery, and errors from expired credentials.
This option is only used in the legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_max_delay
          (Integer)
          
            
              — default:
              0
            
          
          
            — 
    The maximum number of seconds to delay between retries (0 for no limit)
used by the default backoff function. This option is only used in the
legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_mode
          (String)
          
            
              — default:
              "legacy"
            
          
          
            — 
    Specifies which retry algorithm to use. Values are:
    

      

    • 

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

      • 

    • 

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

      • 

    • 

      adaptive - A retry mode that includes all the functionality of
standard mode along with automatic client side throttling.
      

      • 

    
          
        
    • 
      
        
  • 
          :sdk_ua_app_id
          (String)
          
            
          
          
            — 
    A unique and opaque application ID that is appended to the
User-Agent header as app/sdk_ua_app_id. It should have a
maximum length of 50. This variable is sourced from environment
variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
    
          
        
    • 
      
        
  • 
          :secret_access_key
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :session_token
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :sigv4a_signing_region_set
          (Array)
          
            
          
          
            — 
    A list of regions that should be signed with SigV4a signing. When
not passed, a default :sigv4a_signing_region_set is searched for
in the following locations:
    

      

    • Aws.config[:sigv4a_signing_region_set]
      • 

    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
      • 

    • ~/.aws/config
      • 

    
          
        
    • 
      
        
  • 
          :simple_json
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    Disables request parameter conversion, validation, and formatting.
Also disables response data type conversions. The request parameters
hash must be formatted exactly as the API expects.This option is useful
when you want to ensure the highest level of performance by avoiding
overhead of walking request parameters and response data structures.
    
          
        
    • 
      
        
  • 
          :stub_responses
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    Causes the client to return stubbed responses. By default
fake responses are generated and returned. You can specify
the response data to return or errors to raise by calling
ClientStubs#stub_responses. See ClientStubs for more information.
    

    ** Please note ** When response stubbing is enabled, no HTTP
requests are made, and retries are disabled.
    
          
        
    • 
      
        
  • 
          :telemetry_provider
          (Aws::Telemetry::TelemetryProviderBase)
          
            
              — default:
              Aws::Telemetry::NoOpTelemetryProvider
            
          
          
            — 
    Allows you to provide a telemetry provider, which is used to
emit telemetry data. By default, uses NoOpTelemetryProvider which
will not record or emit any telemetry data. The SDK supports the
following telemetry providers:
    

      

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

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

      

    • 

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

      • 

    • 

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

      • 

    

    When :token_provider is not configured directly, the Aws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files.
    
          
        
    • 
      
        
  • 
          :use_dualstack_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, dualstack enabled endpoints (with .aws TLD)
will be used if available.
    
          
        
    • 
      
        
  • 
          :use_fips_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, fips compatible endpoints will be used if available.
When a fips region is used, the region is normalized and this config
is set to true.
    
          
        
    • 
      
        
  • 
          :validate_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, request parameters are validated before
sending the request.
    
          
        
    • 
      
        
  • 
          :endpoint_provider
          (Aws::PinpointSMSVoiceV2::EndpointProvider)
          
            
          
          
            — 
    The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters) where parameters is a Struct similar to
Aws::PinpointSMSVoiceV2::EndpointParameters.
    
          
        
    • 
      
        
  • 
          :http_continue_timeout
          (Float)
          
            
              — default:
              1
            
          
          
            — 
    The number of seconds to wait for a 100-continue response before sending the
request body.  This option has no effect unless the request has "Expect"
header set to "100-continue".  Defaults to nil which  disables this
behaviour.  This value can safely be set per request on the session.
    
          
        
    • 
      
        
  • 
          :http_idle_timeout
          (Float)
          
            
              — default:
              5
            
          
          
            — 
    The number of seconds a connection is allowed to sit idle before it
is considered stale.  Stale connections are closed and removed from the
pool before making a request.
    
          
        
    • 
      
        
  • 
          :http_open_timeout
          (Float)
          
            
              — default:
              15
            
          
          
            — 
    The default number of seconds to wait for response data.
This value can safely be set per-request on the session.
    
          
        
    • 
      
        
  • 
          :http_proxy
          (URI::HTTP, String)
          
            
          
          
            — 
    A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
    
          
        
    • 
      
        
  • 
          :http_read_timeout
          (Float)
          
            
              — default:
              60
            
          
          
            — 
    The default number of seconds to wait for response data.
This value can safely be set per-request on the session.
    
          
        
    • 
      
        
  • 
          :http_wire_trace
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true,  HTTP debug output will be sent to the :logger.
    
          
        
    • 
      
        
  • 
          :on_chunk_received
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the response body is received. It provides three arguments: the chunk,
the number of bytes received, and the total number of
bytes in the response (or nil if the server did not send a content-length).
    
          
        
    • 
      
        
  • 
          :on_chunk_sent
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the request body is sent. It provides three arguments: the chunk,
the number of bytes read from the body, and the total number of
bytes in the body.
    
          
        
    • 
      
        
  • 
          :raise_response_errors
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, response errors are raised.
    
          
        
    • 
      
        
  • 
          :ssl_ca_bundle
          (String)
          
            
          
          
            — 
    Full path to the SSL certificate authority bundle file that should be used when
verifying peer certificates.  If you do not pass :ssl_ca_bundle or
:ssl_ca_directory the the system default will be used if available.
    
          
        
    • 
      
        
  • 
          :ssl_ca_directory
          (String)
          
            
          
          
            — 
    Full path of the directory that contains the unbundled SSL certificate
authority files for verifying peer certificates.  If you do
not pass :ssl_ca_bundle or :ssl_ca_directory the the system
default will be used if available.
    
          
        
    • 
      
        
  • 
          :ssl_ca_store
          (String)
          
            
          
          
            — 
    Sets the X509::Store to verify peer certificate.
    
          
        
    • 
      
        
  • 
          :ssl_cert
          (OpenSSL::X509::Certificate)
          
            
          
          
            — 
    Sets a client certificate when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_key
          (OpenSSL::PKey)
          
            
          
          
            — 
    Sets a client key when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_timeout
          (Float)
          
            
          
          
            — 
    Sets the SSL timeout in seconds
    
          
        
    • 
      
        
  • 
          :ssl_verify_peer
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, SSL peer certificates are verified when establishing a connection.
    
          
        
    • 
      
    

  








  

    
      


478
479
480

    		
    
      
# File 'lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 478

def initialize(*args)
  super
end

    		
  





  



  

    
Class Attribute Details

    
      
      
      

  

  
    .identifier  ⇒ Object  (readonly)
  

  

  


  

    

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




  





  



  

    
      


7689
7690
7691

    		
    
      
# File 'lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 7689

def identifier
  @identifier
end

    		
  





    
  



  

    
Class Method Details


    
      

  

  
    .errors_module  ⇒ Object 
  

  

  


  

    

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




  





  



  

    
      


7692
7693
7694

    		
    
      
# File 'lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 7692

def errors_module
  Errors
end

    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  


  

    
https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#initialize-instance_method


  





  



  

    
      


14

    		
    
      
# File 'sig/client.rbs', line 14

def self.new: (

    		
  





    
  


  

    
Instance Method Details


    
      

  

  
    #associate_origination_identity(params = {})  ⇒ Types::AssociateOriginationIdentityResult 
  

  

  


  

    
Associates the specified origination identity with a pool.


If the origination identity is a phone number and is already
associated with another pool, an error is returned. A sender ID can be
associated with multiple pools.


If the origination identity configuration doesn't match the pool's
configuration, an error is returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.associate_origination_identity({
  pool_id: "PoolIdOrArn", # required
  origination_identity: "PhoneOrSenderIdOrArn", # required
  iso_country_code: "IsoCountryCode",
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.pool_arn #=> String
resp.pool_id #=> String
resp.origination_identity_arn #=> String
resp.origination_identity #=> String
resp.iso_country_code #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :pool_id
          (required, String)
          
            
          
          
            — 
    The pool to update with the new Identity. This value can be either the
PoolId or PoolArn, and you can find these values using
DescribePools.
    

    If you are using a shared End User Messaging SMS; resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :origination_identity
          (required, String)
          
            
          
          
            — 
    The origination identity to use, such as PhoneNumberId,
PhoneNumberArn, SenderId, or SenderIdArn. You can use
DescribePhoneNumbers to find the values for PhoneNumberId and
PhoneNumberArn, while DescribeSenderIds can be used to get the values
for SenderId and SenderIdArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :iso_country_code
          (String)
          
            
          
          
            — 
    The new two-character code, in ISO 3166-1 alpha-2 format, for the
country or region of the origination identity. This field is optional
and is not required for origination identity types that are not
country-specific, such as RCS agents.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


91

    		
    
      
# File 'sig/client.rbs', line 91

def associate_origination_identity: (

    		
  





    
      

  

  
    #associate_protect_configuration(params = {})  ⇒ Types::AssociateProtectConfigurationResult 
  

  

  


  

    
Associate a protect configuration with a configuration set. This
replaces the configuration sets current protect configuration. A
configuration set can only be associated with one protect
configuration at a time. A protect configuration can be associated
with multiple configuration sets.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.associate_protect_configuration({
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
  configuration_set_name: "ConfigurationSetNameOrArn", # required
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The name of the ConfigurationSet.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


107

    		
    
      
# File 'sig/client.rbs', line 107

def associate_protect_configuration: (

    		
  





    
      

  

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

  

  


  

    

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




  





  
Parameters:


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






  

    
      


7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678

    		
    
      
# File 'lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 7662

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::PinpointSMSVoiceV2')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-pinpointsmsvoicev2'
  context[:gem_version] = '1.61.0'
  Seahorse::Client::Request.new(handlers, context)
end

    		
  





    
      

  

  
    #carrier_lookup(params = {})  ⇒ Types::CarrierLookupResult 
  

  

  


  

    
Returns information about a destination phone number, including
whether the number type and whether it is valid, the carrier, and
more.


  





  
  

    
Examples:

    
      
        
Example: Use CarrierLookup

      
      

# Call the CarrierLookup operation to get information about a customer provided phone number, including if the number is
# valid. The service accepts phone numbers with various formatting characters and returns the number in E164 format.

resp = client.carrier_lookup({
  phone_number: "+1 (555) 555-5333", 
})

resp.to_h outputs the following:
{
  carrier: "ExampleCorp Mobile", 
  country: "United States", 
  dialing_country_code: "1", 
  e164_phone_number: "+15555555333", 
  iso_country_code: "US", 
  mcc: "310", 
  mnc: "260", 
  phone_number_type: "MOBILE", 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.carrier_lookup({
  phone_number: "CarrierLookupInputPhoneNumberType", # required
})

    
      
        
Response structure

      
      

resp.e164_phone_number #=> String
resp.dialing_country_code #=> String
resp.iso_country_code #=> String
resp.country #=> String
resp.mcc #=> String
resp.mnc #=> String
resp.carrier #=> String
resp.phone_number_type #=> String, one of "MOBILE", "LANDLINE", "OTHER", "INVALID"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :phone_number
          (required, String)
          
            
          
          
            — 
    The phone number that you want to retrieve information about. You can
provide the phone number in various formats including special
characters such as parentheses, brackets, spaces, hyphens, periods,
and commas. The service automatically converts the input to E164
format for processing.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


125

    		
    
      
# File 'sig/client.rbs', line 125

def carrier_lookup: (

    		
  





    
      

  

  
    #create_configuration_set(params = {})  ⇒ Types::CreateConfigurationSetResult 
  

  

  


  

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


A configuration set is a set of rules that you apply to the SMS and
voice messages that you send.


When you send a message, you can optionally specify a single
configuration set.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_configuration_set({
  configuration_set_name: "ConfigurationSetName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The name to use for the new configuration set.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of key and value pair tags that's associated with the new
configuration set.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


138

    		
    
      
# File 'sig/client.rbs', line 138

def create_configuration_set: (

    		
  





    
      

  

  
    #create_event_destination(params = {})  ⇒ Types::CreateEventDestinationResult 
  

  

  


  

    
Creates a new event destination in a configuration set.


An event destination is a location where you send message events. The
event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon
SNS. For example, when a message is delivered successfully, you can
send information about that event to an event destination, or send
notifications to endpoints that are subscribed to an Amazon SNS topic.


You can only create one event destination at a time. You must provide
a value for a single event destination using either
CloudWatchLogsDestination, KinesisFirehoseDestination or
SnsDestination. If an event destination isn't provided then an
exception is returned.


Each configuration set can contain between 0 and 5 event destinations.
Each event destination can contain a reference to a single
destination, such as a CloudWatch or Firehose destination.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_event_destination({
  configuration_set_name: "ConfigurationSetNameOrArn", # required
  event_destination_name: "EventDestinationName", # required
  matching_event_types: ["ALL"], # required, accepts ALL, TEXT_ALL, TEXT_SENT, TEXT_PENDING, TEXT_QUEUED, TEXT_SUCCESSFUL, TEXT_DELIVERED, TEXT_INVALID, TEXT_INVALID_MESSAGE, TEXT_UNREACHABLE, TEXT_CARRIER_UNREACHABLE, TEXT_BLOCKED, TEXT_CARRIER_BLOCKED, TEXT_SPAM, TEXT_UNKNOWN, TEXT_TTL_EXPIRED, TEXT_PROTECT_BLOCKED, VOICE_ALL, VOICE_INITIATED, VOICE_RINGING, VOICE_ANSWERED, VOICE_COMPLETED, VOICE_BUSY, VOICE_NO_ANSWER, VOICE_FAILED, VOICE_TTL_EXPIRED, MEDIA_ALL, MEDIA_PENDING, MEDIA_QUEUED, MEDIA_SUCCESSFUL, MEDIA_DELIVERED, MEDIA_INVALID, MEDIA_INVALID_MESSAGE, MEDIA_UNREACHABLE, MEDIA_CARRIER_UNREACHABLE, MEDIA_BLOCKED, MEDIA_CARRIER_BLOCKED, MEDIA_SPAM, MEDIA_UNKNOWN, MEDIA_TTL_EXPIRED, MEDIA_FILE_INACCESSIBLE, MEDIA_FILE_TYPE_UNSUPPORTED, MEDIA_FILE_SIZE_EXCEEDED, RCS_ALL, RCS_QUEUED, RCS_SENT, RCS_DELIVERED, RCS_READ, RCS_FAILED, RCS_TTL_EXPIRED, RCS_PROTECT_BLOCKED, RCS_FALLEN_BACK_TO_SMS
  cloud_watch_logs_destination: {
    iam_role_arn: "IamRoleArn", # required
    log_group_arn: "LogGroupArn", # required
  },
  kinesis_firehose_destination: {
    iam_role_arn: "IamRoleArn", # required
    delivery_stream_arn: "DeliveryStreamArn", # required
  },
  sns_destination: {
    topic_arn: "SnsTopicArn", # required
  },
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.event_destination.event_destination_name #=> String
resp.event_destination.enabled #=> Boolean
resp.event_destination.matching_event_types #=> Array
resp.event_destination.matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "TEXT_PROTECT_BLOCKED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED", "RCS_ALL", "RCS_QUEUED", "RCS_SENT", "RCS_DELIVERED", "RCS_READ", "RCS_FAILED", "RCS_TTL_EXPIRED", "RCS_PROTECT_BLOCKED", "RCS_FALLEN_BACK_TO_SMS"
resp.event_destination.cloud_watch_logs_destination.iam_role_arn #=> String
resp.event_destination.cloud_watch_logs_destination.log_group_arn #=> String
resp.event_destination.kinesis_firehose_destination.iam_role_arn #=> String
resp.event_destination.kinesis_firehose_destination.delivery_stream_arn #=> String
resp.event_destination.sns_destination.topic_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    Either the name of the configuration set or the configuration set ARN
to apply event logging to. The ConfigurateSetName and
ConfigurationSetArn can be found using the DescribeConfigurationSets
action.
    
          
        
    • 
      
        
  • 
          :event_destination_name
          (required, String)
          
            
          
          
            — 
    The name that identifies the event destination.
    
          
        
    • 
      
        
  • 
          :matching_event_types
          (required, Array<String>)
          
            
          
          
            — 
    An array of event types that determine which events to log. If "ALL"
is used, then End User Messaging SMS logs every event type.
    

     The TEXT_SENT event type is not supported.
    
 
    
          
        
    • 
      
        
  • 
          :cloud_watch_logs_destination
          (Types::CloudWatchLogsDestination)
          
            
          
          
            — 
    An object that contains information about an event destination for
logging to Amazon CloudWatch Logs.
    
          
        
    • 
      
        
  • 
          :kinesis_firehose_destination
          (Types::KinesisFirehoseDestination)
          
            
          
          
            — 
    An object that contains information about an event destination for
logging to Amazon Data Firehose.
    
          
        
    • 
      
        
  • 
          :sns_destination
          (Types::SnsDestination)
          
            
          
          
            — 
    An object that contains information about an event destination for
logging to Amazon SNS.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


157

    		
    
      
# File 'sig/client.rbs', line 157

def create_event_destination: (

    		
  





    
      

  

  
    #create_notify_configuration(params = {})  ⇒ Types::CreateNotifyConfigurationResult 
  

  

  


  

    
Creates a new notify configuration for managed messaging. A notify
configuration defines the settings for sending templated messages,
including the display name, use case, enabled channels, and enabled
countries.


  





  
  

    
Examples:

    
      
        
Example: CreateNotifyConfiguration

      
      

# Create a notify configuration for OTP code verification over SMS.

resp = client.create_notify_configuration({
  deletion_protection_enabled: false, 
  display_name: "MyOTPConfig", 
  enabled_channels: [
    "SMS", 
  ], 
  enabled_countries: [
    "US", 
    "CA", 
  ], 
  tags: [
    {
      key: "Environment", 
      value: "Production", 
    }, 
  ], 
  use_case: "CODE_VERIFICATION", 
})

resp.to_h outputs the following:
{
  created_timestamp: Time.parse(1704067200), 
  deletion_protection_enabled: false, 
  display_name: "MyOTPConfig", 
  enabled_channels: [
    "SMS", 
  ], 
  enabled_countries: [
    "US", 
    "CA", 
  ], 
  notify_configuration_arn: "arn:aws:sms-voice:us-east-1:111122223333:notify-configuration/nc-1234567890abcdef0", 
  notify_configuration_id: "nc-1234567890abcdef0", 
  status: "ACTIVE", 
  tags: [
    {
      key: "Environment", 
      value: "Production", 
    }, 
  ], 
  tier: "BASIC", 
  tier_upgrade_status: "BASIC", 
  use_case: "CODE_VERIFICATION", 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_notify_configuration({
  display_name: "NotifyConfigurationDisplayName", # required
  use_case: "CODE_VERIFICATION", # required, accepts CODE_VERIFICATION
  default_template_id: "NotifyTemplateId",
  pool_id: "PoolIdOrArn",
  enabled_countries: ["IsoCountryCode"],
  enabled_channels: ["SMS"], # required, accepts SMS, VOICE, MMS, RCS
  deletion_protection_enabled: false,
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.notify_configuration_arn #=> String
resp.notify_configuration_id #=> String
resp.display_name #=> String
resp.use_case #=> String, one of "CODE_VERIFICATION"
resp.default_template_id #=> String
resp.pool_id #=> String
resp.enabled_countries #=> Array
resp.enabled_countries[0] #=> String
resp.enabled_channels #=> Array
resp.enabled_channels[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.tier #=> String, one of "BASIC", "ADVANCED"
resp.tier_upgrade_status #=> String, one of "BASIC", "PENDING_UPGRADE", "ADVANCED", "REJECTED"
resp.status #=> String, one of "PENDING", "ACTIVE", "REJECTED", "REQUIRES_VERIFICATION"
resp.rejection_reason #=> String
resp.deletion_protection_enabled #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :display_name
          (required, String)
          
            
          
          
            — 
    The display name to associate with the notify configuration.
    
          
        
    • 
      
        
  • 
          :use_case
          (required, String)
          
            
          
          
            — 
    The use case for the notify configuration.
    
          
        
    • 
      
        
  • 
          :default_template_id
          (String)
          
            
          
          
            — 
    The default template identifier to associate with the notify
configuration. If specified, this template is used when sending
messages without an explicit template identifier.
    
          
        
    • 
      
        
  • 
          :pool_id
          (String)
          
            
          
          
            — 
    The identifier of the pool to associate with the notify configuration.
    
          
        
    • 
      
        
  • 
          :enabled_countries
          (Array<String>)
          
            
          
          
            — 
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2
format, that are enabled for the notify configuration.
    
          
        
    • 
      
        
  • 
          :enabled_channels
          (required, Array<String>)
          
            
          
          
            — 
    An array of channels to enable for the notify configuration. Supported
values include SMS and VOICE.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the notify
configuration can't be deleted. You can change this value using the
UpdateNotifyConfiguration action.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

    A suitable default value is auto-generated. You should normally
not need to pass this option.**
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of tags (key and value pairs) associated with the notify
configuration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


195

    		
    
      
# File 'sig/client.rbs', line 195

def create_notify_configuration: (

    		
  





    
      

  

  
    #create_opt_out_list(params = {})  ⇒ Types::CreateOptOutListResult 
  

  

  


  

    
Creates a new opt-out list.


If the opt-out list name already exists, an error is returned.


An opt-out list is a list of phone numbers that are opted out, meaning
you can't send SMS or voice messages to them. If end user replies
with the keyword "STOP," an entry for the phone number is added to
the opt-out list. In addition to STOP, your recipients can use any
supported opt-out keyword, such as CANCEL or OPTOUT. For a list of
supported opt-out keywords, see  SMS opt out  in the End User
Messaging SMS User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_opt_out_list({
  opt_out_list_name: "OptOutListName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.opt_out_list_arn #=> String
resp.opt_out_list_name #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :opt_out_list_name
          (required, String)
          
            
          
          
            — 
    The name of the new OptOutList.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of tags (key and value pairs) to associate with the new
OptOutList.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


221

    		
    
      
# File 'sig/client.rbs', line 221

def create_opt_out_list: (

    		
  





    
      

  

  
    #create_pool(params = {})  ⇒ Types::CreatePoolResult 
  

  

  


  

    
Creates a new pool and associates the specified origination identity
to the pool. A pool can include one or more phone numbers and
SenderIds that are associated with your Amazon Web Services account.


The new pool inherits its configuration from the specified origination
identity. This includes keywords, message type, opt-out list, two-way
configuration, and self-managed opt-out configuration. Deletion
protection isn't inherited from the origination identity and defaults
to false.


If the origination identity is a phone number and is already
associated with another pool, an error is returned. A sender ID can be
associated with multiple pools.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_pool({
  origination_identity: "PhoneOrSenderIdOrArn", # required
  iso_country_code: "IsoCountryCode",
  message_type: "TRANSACTIONAL", # required, accepts TRANSACTIONAL, PROMOTIONAL
  deletion_protection_enabled: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.pool_arn #=> String
resp.pool_id #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING"
resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.two_way_enabled #=> Boolean
resp.two_way_channel_arn #=> String
resp.two_way_channel_role #=> String
resp.self_managed_opt_outs_enabled #=> Boolean
resp.opt_out_list_name #=> String
resp.shared_routes_enabled #=> Boolean
resp.deletion_protection_enabled #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :origination_identity
          (required, String)
          
            
          
          
            — 
    The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, SenderId or SenderIdArn. You can use
DescribePhoneNumbers to find the values for PhoneNumberId and
PhoneNumberArn, and use DescribeSenderIds can be used to get the
values for SenderId and SenderIdArn.
    

    After the pool is created you can add more origination identities to
the pool by using AssociateOriginationIdentity.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :iso_country_code
          (String)
          
            
          
          
            — 
    The new two-character code, in ISO 3166-1 alpha-2 format, for the
country or region of the new pool. This field is optional and is not
required for origination identity types that are not country-specific,
such as RCS agents.
    
          
        
    • 
      
        
  • 
          :message_type
          (required, String)
          
            
          
          
            — 
    The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that
aren't critical or time-sensitive. After the pool is created the
MessageType can't be changed.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the pool can't be
deleted. You can change this value using the UpdatePool action.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of tags (key and value pairs) associated with the pool.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


250

    		
    
      
# File 'sig/client.rbs', line 250

def create_pool: (

    		
  





    
      

  

  
    #create_protect_configuration(params = {})  ⇒ Types::CreateProtectConfigurationResult 
  

  

  


  

    
Create a new protect configuration. By default all country rule sets
for each capability are set to ALLOW. Update the country rule sets
using UpdateProtectConfigurationCountryRuleSet. A protect
configurations name is stored as a Tag with the key set to Name and
value as the name of the protect configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_protect_configuration({
  client_token: "ClientToken",
  deletion_protection_enabled: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String
resp.created_timestamp #=> Time
resp. #=> Boolean
resp.deletion_protection_enabled #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

    A suitable default value is auto-generated. You should normally
not need to pass this option.**
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    When set to true deletion protection is enabled. By default this is
set to false.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of key and value pair tags that are associated with the
resource.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


275

    		
    
      
# File 'sig/client.rbs', line 275

def create_protect_configuration: (

    		
  





    
      

  

  
    #create_rcs_agent(params = {})  ⇒ Types::CreateRcsAgentResult 
  

  

  


  

    
Creates a new RCS agent for sending rich messages through the RCS
channel. The RCS agent serves as an origination identity for sending
RCS messages to your recipients.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_rcs_agent({
  deletion_protection_enabled: false,
  opt_out_list_name: "OptOutListNameOrArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.rcs_agent_arn #=> String
resp.rcs_agent_id #=> String
resp.status #=> String, one of "CREATED", "PENDING", "TESTING", "PARTIAL", "ACTIVE", "DELETED"
resp.deletion_protection_enabled #=> Boolean
resp.opt_out_list_name #=> String
resp.created_timestamp #=> Time
resp.self_managed_opt_outs_enabled #=> Boolean
resp.two_way_channel_arn #=> String
resp.two_way_channel_role #=> String
resp.two_way_enabled #=> Boolean
resp.two_way_media_s3_bucket_name #=> String
resp.two_way_media_s3_key_prefix #=> String
resp.two_way_media_s3_role #=> String
resp.two_way_rcs_events_enabled #=> Array
resp.two_way_rcs_events_enabled[0] #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the RCS agent can't
be deleted. You can change this value using the UpdateRcsAgent action.
    
          
        
    • 
      
        
  • 
          :opt_out_list_name
          (String)
          
            
          
          
            — 
    The OptOutList to associate with the RCS agent. Valid values are
either OptOutListName or OptOutListArn.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of tags (key and value pairs) associated with the RCS agent.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


306

    		
    
      
# File 'sig/client.rbs', line 306

def create_rcs_agent: (

    		
  





    
      

  

  
    #create_registration(params = {})  ⇒ Types::CreateRegistrationResult 
  

  

  


  

    
Creates a new registration based on the RegistrationType field.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_registration({
  registration_type: "RegistrationType", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.registration_type #=> String
resp.registration_status #=> String, one of "CREATED", "SUBMITTED", "AWS_REVIEWING", "REVIEWING", "REQUIRES_AUTHENTICATION", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
resp.current_version_number #=> Integer
resp.additional_attributes #=> Hash
resp.additional_attributes["String"] #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_type
          (required, String)
          
            
          
          
            — 
    The type of registration form to create. The list of
RegistrationTypes can be found using the
DescribeRegistrationTypeDefinitions action.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of tags (key and value pairs) to associate with the
registration.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


331

    		
    
      
# File 'sig/client.rbs', line 331

def create_registration: (

    		
  





    
      

  

  
    #create_registration_association(params = {})  ⇒ Types::CreateRegistrationAssociationResult 
  

  

  


  

    
Associate the registration with an origination identity such as a
phone number or sender ID.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_registration_association({
  registration_id: "RegistrationIdOrArn", # required
  resource_id: "ResourceIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.registration_type #=> String
resp.resource_arn #=> String
resp.resource_id #=> String
resp.resource_type #=> String
resp.iso_country_code #=> String
resp.phone_number #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
        
  • 
          :resource_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the origination identity. For example this
could be a PhoneNumberId or SenderId.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


355

    		
    
      
# File 'sig/client.rbs', line 355

def create_registration_association: (

    		
  





    
      

  

  
    #create_registration_attachment(params = {})  ⇒ Types::CreateRegistrationAttachmentResult 
  

  

  


  

    
Create a new registration attachment to use for uploading a file or a
URL to a file. The maximum file size is 5MB and valid file extensions
are PDF, JPEG and PNG. For example, many sender ID registrations
require a signed “letter of authorization” (LOA) to be submitted.


Use either AttachmentUrl or AttachmentBody to upload your
attachment. If both are specified then an exception is returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_registration_attachment({
  attachment_body: "data",
  attachment_url: "AttachmentUrl",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.registration_attachment_arn #=> String
resp.registration_attachment_id #=> String
resp.attachment_status #=> String, one of "UPLOAD_IN_PROGRESS", "UPLOAD_COMPLETE", "UPLOAD_FAILED", "DELETED"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :attachment_body
          (String, StringIO, File)
          
            
          
          
            — 
    The registration file to upload. The maximum file size is 5MB and
valid file extensions are PDF, JPEG and PNG.
    
          
        
    • 
      
        
  • 
          :attachment_url
          (String)
          
            
          
          
            — 
    Registration files have to be stored in an Amazon S3 bucket. The URI
to use when sending is in the format s3://BucketName/FileName.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of tags (key and value pairs) to associate with the
registration attachment.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


370

    		
    
      
# File 'sig/client.rbs', line 370

def create_registration_attachment: (

    		
  





    
      

  

  
    #create_registration_version(params = {})  ⇒ Types::CreateRegistrationVersionResult 
  

  

  


  

    
Create a new version of the registration and increase the
VersionNumber. The previous version of the registration becomes
read-only.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_registration_version({
  registration_id: "RegistrationIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.version_number #=> Integer
resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "AWS_REVIEWING", "REVIEWING", "REQUIRES_AUTHENTICATION", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED", "REQUIRES_OFFLINE_REVIEW"
resp.registration_version_status_history.draft_timestamp #=> Time
resp.registration_version_status_history.submitted_timestamp #=> Time
resp.registration_version_status_history.aws_reviewing_timestamp #=> Time
resp.registration_version_status_history.reviewing_timestamp #=> Time
resp.registration_version_status_history.requires_authentication_timestamp #=> Time
resp.registration_version_status_history.approved_timestamp #=> Time
resp.registration_version_status_history.discarded_timestamp #=> Time
resp.registration_version_status_history.denied_timestamp #=> Time
resp.registration_version_status_history.revoked_timestamp #=> Time
resp.registration_version_status_history.archived_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


392

    		
    
      
# File 'sig/client.rbs', line 392

def create_registration_version: (

    		
  





    
      

  

  
    #create_verified_destination_number(params = {})  ⇒ Types::CreateVerifiedDestinationNumberResult 
  

  

  


  

    
You can only send messages to verified destination numbers when your
account is in the sandbox. You can add up to 10 verified destination
numbers.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_verified_destination_number({
  destination_phone_number: "PhoneNumber", # required
  rcs_agent_id: "RcsAgentIdOrArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.verified_destination_number_arn #=> String
resp.verified_destination_number_id #=> String
resp.destination_phone_number #=> String
resp.status #=> String, one of "PENDING", "VERIFIED", "UNSUPPORTED"
resp.rcs_agent_id #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :destination_phone_number
          (required, String)
          
            
          
          
            — 
    The verified destination phone number, in E.164 format.
    
          
        
    • 
      
        
  • 
          :rcs_agent_id
          (String)
          
            
          
          
            — 
    The unique identifier of the RCS agent to associate with the verified
destination number. You can use either the RcsAgentId or RcsAgentArn.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of tags (key and value pairs) to associate with the
destination number.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


408

    		
    
      
# File 'sig/client.rbs', line 408

def create_verified_destination_number: (

    		
  





    
      

  

  
    #delete_account_default_protect_configuration(params = {})  ⇒ Types::DeleteAccountDefaultProtectConfigurationResult 
  

  

  


  

    
Removes the current account default protect configuration.


  





  
  

    
Examples:

    
      
        
Response structure

      
      

resp.default_protect_configuration_arn #=> String
resp.default_protect_configuration_id #=> String

    
  


  

Parameters:


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




Returns:



  
See Also:

  



  

    
      


427

    		
    
      
# File 'sig/client.rbs', line 427

def delete_account_default_protect_configuration: (

    		
  





    
      

  

  
    #delete_configuration_set(params = {})  ⇒ Types::DeleteConfigurationSetResult 
  

  

  


  

    
Deletes an existing configuration set.


A configuration set is a set of rules that you apply to voice and SMS
messages that you send. In a configuration set, you can specify a
destination for specific types of events related to voice and SMS
messages.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.event_destinations #=> Array
resp.event_destinations[0].event_destination_name #=> String
resp.event_destinations[0].enabled #=> Boolean
resp.event_destinations[0].matching_event_types #=> Array
resp.event_destinations[0].matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "TEXT_PROTECT_BLOCKED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED", "RCS_ALL", "RCS_QUEUED", "RCS_SENT", "RCS_DELIVERED", "RCS_READ", "RCS_FAILED", "RCS_TTL_EXPIRED", "RCS_PROTECT_BLOCKED", "RCS_FALLEN_BACK_TO_SMS"
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].kinesis_firehose_destination.iam_role_arn #=> String
resp.event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
resp.event_destinations[0].sns_destination.topic_arn #=> String
resp.default_message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.default_sender_id #=> String
resp.default_message_feedback_enabled #=> Boolean
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The name of the configuration set or the configuration set ARN that
you want to delete. The ConfigurationSetName and ConfigurationSetArn
can be found using the DescribeConfigurationSets action.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


442

    		
    
      
# File 'sig/client.rbs', line 442

def delete_configuration_set: (

    		
  





    
      

  

  
    #delete_default_message_type(params = {})  ⇒ Types::DeleteDefaultMessageTypeResult 
  

  

  


  

    
Deletes an existing default message type on a configuration set.


A message type is a type of messages that you plan to send. If you
send account-related messages or time-sensitive messages such as
one-time passcodes, choose Transactional. If you plan to send
messages that contain marketing material or other promotional content,
choose Promotional. This setting applies to your entire Amazon Web
Services account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_default_message_type({
  configuration_set_name: "ConfigurationSetNameOrArn", # required
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The name of the configuration set or the configuration set Amazon
Resource Name (ARN) to delete the default message type from. The
ConfigurationSetName and ConfigurationSetArn can be found using the
DescribeConfigurationSets action.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


454

    		
    
      
# File 'sig/client.rbs', line 454

def delete_default_message_type: (

    		
  





    
      

  

  
    #delete_default_sender_id(params = {})  ⇒ Types::DeleteDefaultSenderIdResult 
  

  

  


  

    
Deletes an existing default sender ID on a configuration set.


A default sender ID is the identity that appears on recipients'
devices when they receive SMS messages. Support for sender ID
capabilities varies by country or region.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_default_sender_id({
  configuration_set_name: "ConfigurationSetNameOrArn", # required
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.sender_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The name of the configuration set or the configuration set Amazon
Resource Name (ARN) to delete the default sender ID from. The
ConfigurationSetName and ConfigurationSetArn can be found using the
DescribeConfigurationSets action.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


466

    		
    
      
# File 'sig/client.rbs', line 466

def delete_default_sender_id: (

    		
  





    
      

  

  
    #delete_event_destination(params = {})  ⇒ Types::DeleteEventDestinationResult 
  

  

  


  

    
Deletes an existing event destination.


An event destination is a location where you send response information
about the messages that you send. For example, when a message is
delivered successfully, you can send information about that event to
an Amazon CloudWatch destination, or send notifications to endpoints
that are subscribed to an Amazon SNS topic.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_event_destination({
  configuration_set_name: "ConfigurationSetNameOrArn", # required
  event_destination_name: "EventDestinationName", # required
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.event_destination.event_destination_name #=> String
resp.event_destination.enabled #=> Boolean
resp.event_destination.matching_event_types #=> Array
resp.event_destination.matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "TEXT_PROTECT_BLOCKED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED", "RCS_ALL", "RCS_QUEUED", "RCS_SENT", "RCS_DELIVERED", "RCS_READ", "RCS_FAILED", "RCS_TTL_EXPIRED", "RCS_PROTECT_BLOCKED", "RCS_FALLEN_BACK_TO_SMS"
resp.event_destination.cloud_watch_logs_destination.iam_role_arn #=> String
resp.event_destination.cloud_watch_logs_destination.log_group_arn #=> String
resp.event_destination.kinesis_firehose_destination.iam_role_arn #=> String
resp.event_destination.kinesis_firehose_destination.delivery_stream_arn #=> String
resp.event_destination.sns_destination.topic_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The name of the configuration set or the configuration set's Amazon
Resource Name (ARN) to remove the event destination from. The
ConfigurateSetName and ConfigurationSetArn can be found using the
DescribeConfigurationSets action.
    
          
        
    • 
      
        
  • 
          :event_destination_name
          (required, String)
          
            
          
          
            — 
    The name of the event destination to delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


478

    		
    
      
# File 'sig/client.rbs', line 478

def delete_event_destination: (

    		
  





    
      

  

  
    #delete_keyword(params = {})  ⇒ Types::DeleteKeywordResult 
  

  

  


  

    
Deletes an existing keyword from an origination phone number or pool.


A keyword is a word that you can search for on a particular phone
number or pool. It is also a specific word or phrase that an end user
can send to your number to elicit a response, such as an informational
message or a special offer. When your number receives a message that
begins with a keyword, End User Messaging SMS responds with a
customizable message.


Keywords "HELP" and "STOP" can't be deleted or modified.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_keyword({
  origination_identity: "PhoneOrPoolIdOrArn", # required
  keyword: "Keyword", # required
})

    
      
        
Response structure

      
      

resp.origination_identity_arn #=> String
resp.origination_identity #=> String
resp.keyword #=> String
resp.keyword_message #=> String
resp.keyword_action #=> String, one of "AUTOMATIC_RESPONSE", "OPT_OUT", "OPT_IN"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :origination_identity
          (required, String)
          
            
          
          
            — 
    The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to
find the values for PhoneNumberId and PhoneNumberArn and DescribePools
to find the values of PoolId and PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :keyword
          (required, String)
          
            
          
          
            — 
    The keyword to delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


493

    		
    
      
# File 'sig/client.rbs', line 493

def delete_keyword: (

    		
  





    
      

  

  
    #delete_media_message_spend_limit_override(params = {})  ⇒ Types::DeleteMediaMessageSpendLimitOverrideResult 
  

  

  


  

    
Deletes an account-level monthly spending limit override for sending
multimedia messages (MMS). Deleting a spend limit override will set
the EnforcedLimit to equal the MaxLimit, which is controlled by
Amazon Web Services. For more information on spend limits (quotas) see
Quotas for Server Migration Service in the Server Migration
Service User Guide.


  





  
  

    
Examples:

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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




Returns:



  
See Also:

  



  

    
      


504

    		
    
      
# File 'sig/client.rbs', line 504

def delete_media_message_spend_limit_override: (

    		
  





    
      

  

  
    #delete_notify_configuration(params = {})  ⇒ Types::DeleteNotifyConfigurationResult 
  

  

  


  

    
Deletes an existing notify configuration.


If deletion protection is enabled, an error is returned.


  





  
  

    
Examples:

    
      
        
Example: DeleteNotifyConfiguration

      
      

# Delete an existing notify configuration.

resp = client.delete_notify_configuration({
  notify_configuration_id: "nc-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
  created_timestamp: Time.parse(1704067200), 
  deletion_protection_enabled: false, 
  display_name: "MyOTPConfig", 
  enabled_channels: [
    "SMS", 
  ], 
  enabled_countries: [
    "US", 
    "CA", 
  ], 
  notify_configuration_arn: "arn:aws:sms-voice:us-east-1:111122223333:notify-configuration/nc-1234567890abcdef0", 
  notify_configuration_id: "nc-1234567890abcdef0", 
  status: "ACTIVE", 
  tier: "BASIC", 
  tier_upgrade_status: "BASIC", 
  use_case: "CODE_VERIFICATION", 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_notify_configuration({
  notify_configuration_id: "NotifyConfigurationIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.notify_configuration_arn #=> String
resp.notify_configuration_id #=> String
resp.display_name #=> String
resp.use_case #=> String, one of "CODE_VERIFICATION"
resp.default_template_id #=> String
resp.pool_id #=> String
resp.enabled_countries #=> Array
resp.enabled_countries[0] #=> String
resp.enabled_channels #=> Array
resp.enabled_channels[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.tier #=> String, one of "BASIC", "ADVANCED"
resp.tier_upgrade_status #=> String, one of "BASIC", "PENDING_UPGRADE", "ADVANCED", "REJECTED"
resp.status #=> String, one of "PENDING", "ACTIVE", "REJECTED", "REQUIRES_VERIFICATION"
resp.rejection_reason #=> String
resp.deletion_protection_enabled #=> Boolean
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :notify_configuration_id
          (required, String)
          
            
          
          
            — 
    The identifier of the notify configuration to delete. The
NotifyConfigurationId can be found using the
DescribeNotifyConfigurations operation.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


526

    		
    
      
# File 'sig/client.rbs', line 526

def delete_notify_configuration: (

    		
  





    
      

  

  
    #delete_notify_message_spend_limit_override(params = {})  ⇒ Types::DeleteNotifyMessageSpendLimitOverrideResult 
  

  

  


  

    
Deletes an account-level monthly spending limit override for sending
notify messages. Deleting a spend limit override will set the
EnforcedLimit to equal the MaxLimit, which is controlled by Amazon
Web Services. For more information on spend limits (quotas) see
Quotas  in the End User Messaging SMS User Guide.


  





  
  

    
Examples:

    
      
        
Example: DeleteNotifyMessageSpendLimitOverride

      
      

# Delete the monthly spend limit override for notify messages, reverting to the default limit.

resp = client.delete_notify_message_spend_limit_override({
})

resp.to_h outputs the following:
{
  monthly_limit: 1000, 
}

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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




Returns:



  
See Also:

  



  

    
      


536

    		
    
      
# File 'sig/client.rbs', line 536

def delete_notify_message_spend_limit_override: (

    		
  





    
      

  

  
    #delete_opt_out_list(params = {})  ⇒ Types::DeleteOptOutListResult 
  

  

  


  

    
Deletes an existing opt-out list. All opted out phone numbers in the
opt-out list are deleted.


If the specified opt-out list name doesn't exist or is in-use by an
origination phone number or pool, an error is returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_opt_out_list({
  opt_out_list_name: "OptOutListNameOrArn", # required
})

    
      
        
Response structure

      
      

resp.opt_out_list_arn #=> String
resp.opt_out_list_name #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :opt_out_list_name
          (required, String)
          
            
          
          
            — 
    The OptOutListName or OptOutListArn of the OptOutList to delete. You
can use DescribeOptOutLists to find the values for OptOutListName and
OptOutListArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


547

    		
    
      
# File 'sig/client.rbs', line 547

def delete_opt_out_list: (

    		
  





    
      

  

  
    #delete_opted_out_number(params = {})  ⇒ Types::DeleteOptedOutNumberResult 
  

  

  


  

    
Deletes an existing opted out destination phone number from the
specified opt-out list.


Each destination phone number can only be deleted once every 30 days.


If the specified destination phone number doesn't exist or if the
opt-out list doesn't exist, an error is returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_opted_out_number({
  opt_out_list_name: "OptOutListNameOrArn", # required
  opted_out_number: "PhoneNumber", # required
})

    
      
        
Response structure

      
      

resp.opt_out_list_arn #=> String
resp.opt_out_list_name #=> String
resp.opted_out_number #=> String
resp.opted_out_timestamp #=> Time
resp.end_user_opted_out #=> Boolean

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :opt_out_list_name
          (required, String)
          
            
          
          
            — 
    The OptOutListName or OptOutListArn to remove the phone number from.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :opted_out_number
          (required, String)
          
            
          
          
            — 
    The phone number, in E.164 format, to remove from the OptOutList.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


561

    		
    
      
# File 'sig/client.rbs', line 561

def delete_opted_out_number: (

    		
  





    
      

  

  
    #delete_pool(params = {})  ⇒ Types::DeletePoolResult 
  

  

  


  

    
Deletes an existing pool. Deleting a pool disassociates all
origination identities from that pool.


If the pool status isn't active or if deletion protection is enabled,
an error is returned.


A pool is a collection of phone numbers and SenderIds. A pool can
include one or more phone numbers and SenderIds that are associated
with your Amazon Web Services account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_pool({
  pool_id: "PoolIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.pool_arn #=> String
resp.pool_id #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING"
resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.two_way_enabled #=> Boolean
resp.two_way_channel_arn #=> String
resp.two_way_channel_role #=> String
resp.self_managed_opt_outs_enabled #=> Boolean
resp.opt_out_list_name #=> String
resp.shared_routes_enabled #=> Boolean
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :pool_id
          (required, String)
          
            
          
          
            — 
    The PoolId or PoolArn of the pool to delete. You can use DescribePools
to find the values for PoolId and PoolArn .
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


582

    		
    
      
# File 'sig/client.rbs', line 582

def delete_pool: (

    		
  





    
      

  

  
    #delete_protect_configuration(params = {})  ⇒ Types::DeleteProtectConfigurationResult 
  

  

  


  

    
Permanently delete the protect configuration. The protect
configuration must have deletion protection disabled and must not be
associated as the account default protect configuration or associated
with a configuration set.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_protect_configuration({
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String
resp.created_timestamp #=> Time
resp. #=> Boolean
resp.deletion_protection_enabled #=> Boolean

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


596

    		
    
      
# File 'sig/client.rbs', line 596

def delete_protect_configuration: (

    		
  





    
      

  

  
    #delete_protect_configuration_rule_set_number_override(params = {})  ⇒ Types::DeleteProtectConfigurationRuleSetNumberOverrideResult 
  

  

  


  

    
Permanently delete the protect configuration rule set number override.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_protect_configuration_rule_set_number_override({
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
  destination_phone_number: "PhoneNumber", # required
})

    
      
        
Response structure

      
      

resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String
resp.destination_phone_number #=> String
resp.created_timestamp #=> Time
resp.action #=> String, one of "ALLOW", "BLOCK"
resp.iso_country_code #=> String
resp.expiration_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :destination_phone_number
          (required, String)
          
            
          
          
            — 
    The destination phone number in E.164 format.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


612

    		
    
      
# File 'sig/client.rbs', line 612

def delete_protect_configuration_rule_set_number_override: (

    		
  





    
      

  

  
    #delete_rcs_agent(params = {})  ⇒ Types::DeleteRcsAgentResult 
  

  

  


  

    
Deletes an existing RCS agent. If deletion protection is enabled, an
error is returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_rcs_agent({
  rcs_agent_id: "RcsAgentIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.rcs_agent_arn #=> String
resp.rcs_agent_id #=> String
resp.status #=> String, one of "CREATED", "PENDING", "TESTING", "PARTIAL", "ACTIVE", "DELETED"
resp.created_timestamp #=> Time
resp.deletion_protection_enabled #=> Boolean
resp.opt_out_list_name #=> String
resp.self_managed_opt_outs_enabled #=> Boolean
resp.two_way_channel_arn #=> String
resp.two_way_channel_role #=> String
resp.two_way_enabled #=> Boolean
resp.two_way_rcs_events_enabled #=> Array
resp.two_way_rcs_events_enabled[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :rcs_agent_id
          (required, String)
          
            
          
          
            — 
    The unique identifier of the RCS agent to delete. You can use either
the RcsAgentId or RcsAgentArn.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


633

    		
    
      
# File 'sig/client.rbs', line 633

def delete_rcs_agent: (

    		
  





    
      

  

  
    #delete_rcs_message_spend_limit_override(params = {})  ⇒ Types::DeleteRcsMessageSpendLimitOverrideResult 
  

  

  


  

    
Deletes an account-level monthly spending limit override for sending
RCS messages. Deleting a spend limit override sets the EnforcedLimit
to equal the MaxLimit, which is set by Amazon Web Services.


  





  
  

    
Examples:

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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




Returns:



  
See Also:

  



  

    
      


643

    		
    
      
# File 'sig/client.rbs', line 643

def delete_rcs_message_spend_limit_override: (

    		
  





    
      

  

  
    #delete_registration(params = {})  ⇒ Types::DeleteRegistrationResult 
  

  

  


  

    
Permanently delete an existing registration from your account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_registration({
  registration_id: "RegistrationIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.registration_type #=> String
resp.registration_status #=> String, one of "CREATED", "SUBMITTED", "AWS_REVIEWING", "REVIEWING", "REQUIRES_AUTHENTICATION", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
resp.current_version_number #=> Integer
resp.approved_version_number #=> Integer
resp.latest_denied_version_number #=> Integer
resp.additional_attributes #=> Hash
resp.additional_attributes["String"] #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


660

    		
    
      
# File 'sig/client.rbs', line 660

def delete_registration: (

    		
  





    
      

  

  
    #delete_registration_attachment(params = {})  ⇒ Types::DeleteRegistrationAttachmentResult 
  

  

  


  

    
Permanently delete the specified registration attachment.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_registration_attachment({
  registration_attachment_id: "RegistrationAttachmentIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.registration_attachment_arn #=> String
resp.registration_attachment_id #=> String
resp.attachment_status #=> String, one of "UPLOAD_IN_PROGRESS", "UPLOAD_COMPLETE", "UPLOAD_FAILED", "DELETED"
resp.attachment_upload_error_reason #=> String, one of "INTERNAL_ERROR"
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_attachment_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration attachment.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


674

    		
    
      
# File 'sig/client.rbs', line 674

def delete_registration_attachment: (

    		
  





    
      

  

  
    #delete_registration_field_value(params = {})  ⇒ Types::DeleteRegistrationFieldValueResult 
  

  

  


  

    
Delete the value in a registration form field.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_registration_field_value({
  registration_id: "RegistrationIdOrArn", # required
  field_path: "FieldPath", # required
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.version_number #=> Integer
resp.field_path #=> String
resp.select_choices #=> Array
resp.select_choices[0] #=> String
resp.text_value #=> String
resp.registration_attachment_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
        
  • 
          :field_path
          (required, String)
          
            
          
          
            — 
    The path to the registration form field. You can use
DescribeRegistrationFieldDefinitions for a list of FieldPaths.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


690

    		
    
      
# File 'sig/client.rbs', line 690

def delete_registration_field_value: (

    		
  





    
      

  

  
    #delete_resource_policy(params = {})  ⇒ Types::DeleteResourcePolicyResult 
  

  

  


  

    
Deletes the resource-based policy document attached to the End User
Messaging SMS resource. A shared resource can be a Pool, Opt-out list,
Sender Id, or Phone number.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_resource_policy({
  resource_arn: "AmazonResourceName", # required
})

    
      
        
Response structure

      
      

resp.resource_arn #=> String
resp.policy #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the End User Messaging SMS resource
you're deleting the resource-based policy from.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


703

    		
    
      
# File 'sig/client.rbs', line 703

def delete_resource_policy: (

    		
  





    
      

  

  
    #delete_text_message_spend_limit_override(params = {})  ⇒ Types::DeleteTextMessageSpendLimitOverrideResult 
  

  

  


  

    
Deletes an account-level monthly spending limit override for sending
text messages. Deleting a spend limit override will set the
EnforcedLimit to equal the MaxLimit, which is controlled by Amazon
Web Services. For more information on spend limits (quotas) see
Quotas  in the End User Messaging SMS User Guide.


  





  
  

    
Examples:

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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




Returns:



  
See Also:

  



  

    
      


713

    		
    
      
# File 'sig/client.rbs', line 713

def delete_text_message_spend_limit_override: (

    		
  





    
      

  

  
    #delete_verified_destination_number(params = {})  ⇒ Types::DeleteVerifiedDestinationNumberResult 
  

  

  


  

    
Delete a verified destination phone number.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_verified_destination_number({
  verified_destination_number_id: "VerifiedDestinationNumberIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.verified_destination_number_arn #=> String
resp.verified_destination_number_id #=> String
resp.destination_phone_number #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :verified_destination_number_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the verified destination phone number.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


725

    		
    
      
# File 'sig/client.rbs', line 725

def delete_verified_destination_number: (

    		
  





    
      

  

  
    #delete_voice_message_spend_limit_override(params = {})  ⇒ Types::DeleteVoiceMessageSpendLimitOverrideResult 
  

  

  


  

    
Deletes an account level monthly spend limit override for sending
voice messages. Deleting a spend limit override sets the
EnforcedLimit equal to the MaxLimit, which is controlled by Amazon
Web Services. For more information on spending limits (quotas) see
Quotas  in the End User Messaging SMS User Guide.


  





  
  

    
Examples:

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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




Returns:



  
See Also:

  



  

    
      


735

    		
    
      
# File 'sig/client.rbs', line 735

def delete_voice_message_spend_limit_override: (

    		
  





    
      

  

  
    #describe_account_attributes(params = {})  ⇒ Types::DescribeAccountAttributesResult 
  

  

  


  

    
Describes attributes of your Amazon Web Services account. The
supported account attributes include account tier, which indicates
whether your account is in the sandbox or production environment. When
you're ready to move your account out of the sandbox, create an
Amazon Web Services Support case for a service limit increase request.


New accounts are placed into an SMS or voice sandbox. The sandbox
protects both Amazon Web Services end recipients and SMS or voice
recipients from fraud and abuse.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp. #=> Array
resp.[0].name #=> String, one of "ACCOUNT_TIER", "DEFAULT_PROTECT_CONFIGURATION_ID"
resp.[0].value #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


745

    		
    
      
# File 'sig/client.rbs', line 745

def describe_account_attributes: (

    		
  





    
      

  

  
    #describe_account_limits(params = {})  ⇒ Types::DescribeAccountLimitsResult 
  

  

  


  

    
Describes the current End User Messaging SMS SMS Voice V2 resource
quotas for your account. The description for a quota includes the
quota name, current usage toward that quota, and the quota's maximum
value.


When you establish an Amazon Web Services account, the account has
initial quotas on the maximum number of configuration sets, opt-out
lists, phone numbers, and pools that you can create in a given Region.
For more information see Quotas  in the End User Messaging SMS
User Guide.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp. #=> Array
resp.[0].name #=> String, one of "PHONE_NUMBERS", "POOLS", "CONFIGURATION_SETS", "OPT_OUT_LISTS", "SENDER_IDS", "REGISTRATIONS", "REGISTRATION_ATTACHMENTS", "VERIFIED_DESTINATION_NUMBERS"
resp.[0].used #=> Integer
resp.[0].max #=> Integer
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


757

    		
    
      
# File 'sig/client.rbs', line 757

def describe_account_limits: (

    		
  





    
      

  

  
    #describe_configuration_sets(params = {})  ⇒ Types::DescribeConfigurationSetsResult 
  

  

  


  

    
Describes the specified configuration sets or all in your account.


If you specify configuration set names, the output includes
information for only the specified configuration sets. If you specify
filters, the output includes information for only those configuration
sets that meet the filter criteria. If you don't specify
configuration set names or filters, the output includes information
for all configuration sets.


If you specify a configuration set name that isn't valid, an error is
returned.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_configuration_sets({
  configuration_set_names: ["ConfigurationSetNameOrArn"],
  filters: [
    {
      name: "event-destination-name", # required, accepts event-destination-name, matching-event-types, default-message-type, default-sender-id, default-message-feedback-enabled, protect-configuration-id
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.configuration_sets #=> Array
resp.configuration_sets[0].configuration_set_arn #=> String
resp.configuration_sets[0].configuration_set_name #=> String
resp.configuration_sets[0].event_destinations #=> Array
resp.configuration_sets[0].event_destinations[0].event_destination_name #=> String
resp.configuration_sets[0].event_destinations[0].enabled #=> Boolean
resp.configuration_sets[0].event_destinations[0].matching_event_types #=> Array
resp.configuration_sets[0].event_destinations[0].matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "TEXT_PROTECT_BLOCKED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED", "RCS_ALL", "RCS_QUEUED", "RCS_SENT", "RCS_DELIVERED", "RCS_READ", "RCS_FAILED", "RCS_TTL_EXPIRED", "RCS_PROTECT_BLOCKED", "RCS_FALLEN_BACK_TO_SMS"
resp.configuration_sets[0].event_destinations[0].cloud_watch_logs_destination.iam_role_arn #=> String
resp.configuration_sets[0].event_destinations[0].cloud_watch_logs_destination.log_group_arn #=> String
resp.configuration_sets[0].event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
resp.configuration_sets[0].event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
resp.configuration_sets[0].event_destinations[0].sns_destination.topic_arn #=> String
resp.configuration_sets[0].default_message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.configuration_sets[0].default_sender_id #=> String
resp.configuration_sets[0].default_message_feedback_enabled #=> Boolean
resp.configuration_sets[0].created_timestamp #=> Time
resp.configuration_sets[0].protect_configuration_id #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_names
          (Array<String>)
          
            
          
          
            — 
    An array of strings. Each element can be either a ConfigurationSetName
or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::ConfigurationSetFilter>)
          
            
          
          
            — 
    An array of filters to apply to the results that are returned.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


769

    		
    
      
# File 'sig/client.rbs', line 769

def describe_configuration_sets: (

    		
  





    
      

  

  
    #describe_keywords(params = {})  ⇒ Types::DescribeKeywordsResult 
  

  

  


  

    
Describes the specified keywords or all keywords on your origination
phone number or pool.


A keyword is a word that you can search for on a particular phone
number or pool. It is also a specific word or phrase that an end user
can send to your number to elicit a response, such as an informational
message or a special offer. When your number receives a message that
begins with a keyword, End User Messaging SMS responds with a
customizable message.


If you specify a keyword that isn't valid, an error is returned.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_keywords({
  origination_identity: "PhoneOrPoolIdOrArn", # required
  keywords: ["Keyword"],
  filters: [
    {
      name: "keyword-action", # required, accepts keyword-action
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.origination_identity_arn #=> String
resp.origination_identity #=> String
resp.keywords #=> Array
resp.keywords[0].keyword #=> String
resp.keywords[0].keyword_message #=> String
resp.keywords[0].keyword_action #=> String, one of "AUTOMATIC_RESPONSE", "OPT_OUT", "OPT_IN"
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :origination_identity
          (required, String)
          
            
          
          
            — 
    The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, SenderId or SenderIdArn. You can use
DescribePhoneNumbers to find the values for PhoneNumberId and
PhoneNumberArn while DescribeSenderIds can be used to get the values
for SenderId and SenderIdArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :keywords
          (Array<String>)
          
            
          
          
            — 
    An array of keywords to search for.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::KeywordFilter>)
          
            
          
          
            — 
    An array of keyword filters to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


790

    		
    
      
# File 'sig/client.rbs', line 790

def describe_keywords: (

    		
  





    
      

  

  
    #describe_notify_configurations(params = {})  ⇒ Types::DescribeNotifyConfigurationsResult 
  

  

  


  

    
Describes the specified notify configurations or all notify
configurations in your account.


If you specify notify configuration IDs, the output includes
information for only the specified notify configurations. If you
specify filters, the output includes information for only those notify
configurations that meet the filter criteria. If you don't specify
notify configuration IDs or filters, the output includes information
for all notify configurations.


If you specify a notify configuration ID that isn't valid, an error
is returned.


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


  





  
  

    
Examples:

    
      
        
Example: DescribeNotifyConfigurations

      
      

# Describe notify configurations filtered by status.

resp = client.describe_notify_configurations({
  filters: [
    {
      name: "status", 
      values: [
        "ACTIVE", 
      ], 
    }, 
  ], 
  max_results: 10, 
})

resp.to_h outputs the following:
{
  notify_configurations: [
    {
      created_timestamp: Time.parse(1704067200), 
      deletion_protection_enabled: false, 
      display_name: "MyOTPConfig", 
      enabled_channels: [
        "SMS", 
      ], 
      enabled_countries: [
        "US", 
        "CA", 
      ], 
      notify_configuration_arn: "arn:aws:sms-voice:us-east-1:111122223333:notify-configuration/nc-1234567890abcdef0", 
      notify_configuration_id: "nc-1234567890abcdef0", 
      status: "ACTIVE", 
      tier: "BASIC", 
      tier_upgrade_status: "BASIC", 
      use_case: "CODE_VERIFICATION", 
    }, 
  ], 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_notify_configurations({
  notify_configuration_ids: ["NotifyConfigurationIdOrArn"],
  filters: [
    {
      name: "display-name", # required, accepts display-name, enabled-countries, enabled-channels, default-template, default-pool, use-case, status, deletion-protection-enabled, tier-upgrade-status
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.notify_configurations #=> Array
resp.notify_configurations[0].notify_configuration_arn #=> String
resp.notify_configurations[0].notify_configuration_id #=> String
resp.notify_configurations[0].display_name #=> String
resp.notify_configurations[0].use_case #=> String, one of "CODE_VERIFICATION"
resp.notify_configurations[0].default_template_id #=> String
resp.notify_configurations[0].pool_id #=> String
resp.notify_configurations[0].enabled_countries #=> Array
resp.notify_configurations[0].enabled_countries[0] #=> String
resp.notify_configurations[0].enabled_channels #=> Array
resp.notify_configurations[0].enabled_channels[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.notify_configurations[0].tier #=> String, one of "BASIC", "ADVANCED"
resp.notify_configurations[0].tier_upgrade_status #=> String, one of "BASIC", "PENDING_UPGRADE", "ADVANCED", "REJECTED"
resp.notify_configurations[0].status #=> String, one of "PENDING", "ACTIVE", "REJECTED", "REQUIRES_VERIFICATION"
resp.notify_configurations[0].rejection_reason #=> String
resp.notify_configurations[0].deletion_protection_enabled #=> Boolean
resp.notify_configurations[0].created_timestamp #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :notify_configuration_ids
          (Array<String>)
          
            
          
          
            — 
    An array of notify configuration IDs to describe.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::NotifyConfigurationFilter>)
          
            
          
          
            — 
    An array of NotifyConfigurationFilter objects to filter the results
on.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


810

    		
    
      
# File 'sig/client.rbs', line 810

def describe_notify_configurations: (

    		
  





    
      

  

  
    #describe_notify_templates(params = {})  ⇒ Types::DescribeNotifyTemplatesResult 
  

  

  


  

    
Describes the specified notify templates or all notify templates in
your account.


If you specify template IDs, the output includes information for only
the specified notify templates. If you specify filters, the output
includes information for only those notify templates that meet the
filter criteria. If you don't specify template IDs or filters, the
output includes information for all notify templates.


If you specify a template ID that isn't valid, an error is returned.


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


  





  
  

    
Examples:

    
      
        
Example: DescribeNotifyTemplates

      
      

# Describe available notify templates for OTP verification over SMS.

resp = client.describe_notify_templates({
  filters: [
    {
      name: "template-type", 
      values: [
        "OTP_VERIFICATION", 
      ], 
    }, 
    {
      name: "channels", 
      values: [
        "SMS", 
      ], 
    }, 
  ], 
  max_results: 10, 
})

resp.to_h outputs the following:
{
  notify_templates: [
    {
      channels: [
        "SMS", 
      ], 
      content: "Your verification code is {{code}}. It expires in {{expiry}} minutes.", 
      created_timestamp: Time.parse(1704067200), 
      language_code: "en", 
      status: "ACTIVE", 
      supported_countries: [
        "US", 
        "CA", 
        "GB", 
      ], 
      template_id: "nt-1234567890abcdef0", 
      template_type: "OTP_VERIFICATION", 
      tier_access: [
        "BASIC", 
        "ADVANCED", 
      ], 
      variables: {
        "code" => {
          description: "The verification code", 
          max_length: 10, 
          required: true, 
          sample: "123456", 
          source: "CUSTOMER", 
          type: "STRING", 
        }, 
        "expiry" => {
          default_value: "10", 
          description: "Expiry time in minutes", 
          max_value: 60, 
          min_value: 1, 
          required: false, 
          sample: "10", 
          source: "CUSTOMER", 
          type: "INTEGER", 
        }, 
      }, 
      version: 1, 
    }, 
  ], 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_notify_templates({
  template_ids: ["NotifyTemplateId"],
  filters: [
    {
      name: "template-type", # required, accepts template-type, channels, tier-access, supported-countries, language-code, supported-voice-ids
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.notify_templates #=> Array
resp.notify_templates[0].template_id #=> String
resp.notify_templates[0].version #=> Integer
resp.notify_templates[0].template_type #=> String, one of "OTP_VERIFICATION"
resp.notify_templates[0].channels #=> Array
resp.notify_templates[0].channels[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.notify_templates[0].tier_access #=> Array
resp.notify_templates[0].tier_access[0] #=> String, one of "BASIC", "ADVANCED"
resp.notify_templates[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.notify_templates[0].supported_countries #=> Array
resp.notify_templates[0].supported_countries[0] #=> String
resp.notify_templates[0].language_code #=> String
resp.notify_templates[0].content #=> String
resp.notify_templates[0].variables #=> Hash
resp.notify_templates[0].variables["String"].type #=> String, one of "STRING", "INTEGER", "BOOLEAN"
resp.notify_templates[0].variables["String"].required #=> Boolean
resp.notify_templates[0].variables["String"].description #=> String
resp.notify_templates[0].variables["String"].max_length #=> Integer
resp.notify_templates[0].variables["String"].min_value #=> Integer
resp.notify_templates[0].variables["String"].max_value #=> Integer
resp.notify_templates[0].variables["String"].default_value #=> String
resp.notify_templates[0].variables["String"].pattern #=> String
resp.notify_templates[0].variables["String"].sample #=> String
resp.notify_templates[0].variables["String"].source #=> String, one of "CUSTOMER", "SYSTEM"
resp.notify_templates[0].supported_voice_ids #=> Array
resp.notify_templates[0].supported_voice_ids[0] #=> String, one of "AMY", "ASTRID", "BIANCA", "BRIAN", "CAMILA", "CARLA", "CARMEN", "CELINE", "CHANTAL", "CONCHITA", "CRISTIANO", "DORA", "EMMA", "ENRIQUE", "EWA", "FILIZ", "GERAINT", "GIORGIO", "GWYNETH", "HANS", "INES", "IVY", "JACEK", "JAN", "JOANNA", "JOEY", "JUSTIN", "KARL", "KENDRA", "KIMBERLY", "LEA", "LIV", "LOTTE", "LUCIA", "LUPE", "MADS", "MAJA", "MARLENE", "MATHIEU", "MATTHEW", "MAXIM", "MIA", "MIGUEL", "MIZUKI", "NAJA", "NICOLE", "PENELOPE", "RAVEENA", "RICARDO", "RUBEN", "RUSSELL", "SALLI", "SEOYEON", "TAKUMI", "TATYANA", "VICKI", "VITORIA", "ZEINA", "ZHIYU"
resp.notify_templates[0].created_timestamp #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :template_ids
          (Array<String>)
          
            
          
          
            — 
    An array of template IDs to describe.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::NotifyTemplateFilter>)
          
            
          
          
            — 
    An array of NotifyTemplateFilter objects to filter the results on.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


829

    		
    
      
# File 'sig/client.rbs', line 829

def describe_notify_templates: (

    		
  





    
      

  

  
    #describe_opt_out_lists(params = {})  ⇒ Types::DescribeOptOutListsResult 
  

  

  


  

    
Describes the specified opt-out list or all opt-out lists in your
account.


If you specify opt-out list names, the output includes information for
only the specified opt-out lists. Opt-out lists include only those
that meet the filter criteria. If you don't specify opt-out list
names or filters, the output includes information for all opt-out
lists.


If you specify an opt-out list name that isn't valid, an error is
returned.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_opt_out_lists({
  opt_out_list_names: ["OptOutListNameOrArn"],
  next_token: "NextToken",
  max_results: 1,
  owner: "SELF", # accepts SELF, SHARED
})

    
      
        
Response structure

      
      

resp.opt_out_lists #=> Array
resp.opt_out_lists[0].opt_out_list_arn #=> String
resp.opt_out_lists[0].opt_out_list_name #=> String
resp.opt_out_lists[0].created_timestamp #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :opt_out_list_names
          (Array<String>)
          
            
          
          
            — 
    The OptOutLists to show the details of. This is an array of strings
that can be either the OptOutListName or OptOutListArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
        
  • 
          :owner
          (String)
          
            
          
          
            — 
    Use SELF to filter the list of Opt-Out List to ones your account
owns or use SHARED to filter on Opt-Out List shared with your
account. The Owner and OptOutListNames parameters can't be used
at the same time.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


848

    		
    
      
# File 'sig/client.rbs', line 848

def describe_opt_out_lists: (

    		
  





    
      

  

  
    #describe_opted_out_numbers(params = {})  ⇒ Types::DescribeOptedOutNumbersResult 
  

  

  


  

    
Describes the specified opted out destination numbers or all opted out
destination numbers in an opt-out list.


If you specify opted out numbers, the output includes information for
only the specified opted out numbers. If you specify filters, the
output includes information for only those opted out numbers that meet
the filter criteria. If you don't specify opted out numbers or
filters, the output includes information for all opted out destination
numbers in your opt-out list.


If you specify an opted out number that isn't valid, an exception is
returned.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_opted_out_numbers({
  opt_out_list_name: "OptOutListNameOrArn", # required
  opted_out_numbers: ["PhoneNumber"],
  filters: [
    {
      name: "end-user-opted-out", # required, accepts end-user-opted-out
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.opt_out_list_arn #=> String
resp.opt_out_list_name #=> String
resp.opted_out_numbers #=> Array
resp.opted_out_numbers[0].opted_out_number #=> String
resp.opted_out_numbers[0].opted_out_timestamp #=> Time
resp.opted_out_numbers[0].end_user_opted_out #=> Boolean
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :opt_out_list_name
          (required, String)
          
            
          
          
            — 
    The OptOutListName or OptOutListArn of the OptOutList. You can use
DescribeOptOutLists to find the values for OptOutListName and
OptOutListArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :opted_out_numbers
          (Array<String>)
          
            
          
          
            — 
    An array of phone numbers to search for in the OptOutList.
    

    If you specify an opted out number that isn't valid, an exception is
returned.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::OptedOutFilter>)
          
            
          
          
            — 
    An array of OptedOutFilter objects to filter the results on.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


864

    		
    
      
# File 'sig/client.rbs', line 864

def describe_opted_out_numbers: (

    		
  





    
      

  

  
    #describe_phone_numbers(params = {})  ⇒ Types::DescribePhoneNumbersResult 
  

  

  


  

    
Describes the specified origination phone number, or all the phone
numbers in your account.


If you specify phone number IDs, the output includes information for
only the specified phone numbers. If you specify filters, the output
includes information for only those phone numbers that meet the filter
criteria. If you don't specify phone number IDs or filters, the
output includes information for all phone numbers.


If you specify a phone number ID that isn't valid, an error is
returned.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_phone_numbers({
  phone_number_ids: ["PhoneNumberIdOrArn"],
  filters: [
    {
      name: "status", # required, accepts status, iso-country-code, message-type, number-capability, number-type, two-way-enabled, self-managed-opt-outs-enabled, opt-out-list-name, deletion-protection-enabled, two-way-channel-arn
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  owner: "SELF", # accepts SELF, SHARED
})

    
      
        
Response structure

      
      

resp.phone_numbers #=> Array
resp.phone_numbers[0].phone_number_arn #=> String
resp.phone_numbers[0].phone_number_id #=> String
resp.phone_numbers[0].phone_number #=> String
resp.phone_numbers[0].status #=> String, one of "PENDING", "ACTIVE", "ASSOCIATING", "DISASSOCIATING", "DELETED"
resp.phone_numbers[0].iso_country_code #=> String
resp.phone_numbers[0].message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.phone_numbers[0].number_capabilities #=> Array
resp.phone_numbers[0].number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.phone_numbers[0].number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
resp.phone_numbers[0].monthly_leasing_price #=> String
resp.phone_numbers[0].two_way_enabled #=> Boolean
resp.phone_numbers[0].two_way_channel_arn #=> String
resp.phone_numbers[0].two_way_channel_role #=> String
resp.phone_numbers[0].self_managed_opt_outs_enabled #=> Boolean
resp.phone_numbers[0].opt_out_list_name #=> String
resp.phone_numbers[0].international_sending_enabled #=> Boolean
resp.phone_numbers[0].deletion_protection_enabled #=> Boolean
resp.phone_numbers[0].pool_id #=> String
resp.phone_numbers[0].registration_id #=> String
resp.phone_numbers[0].created_timestamp #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :phone_number_ids
          (Array<String>)
          
            
          
          
            — 
    The unique identifier of phone numbers to find information about. This
is an array of strings that can be either the PhoneNumberId or
PhoneNumberArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::PhoneNumberFilter>)
          
            
          
          
            — 
    An array of PhoneNumberFilter objects to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
        
  • 
          :owner
          (String)
          
            
          
          
            — 
    Use SELF to filter the list of phone numbers to ones your account
owns or use SHARED to filter on phone numbers shared with your
account. The Owner and PhoneNumberIds parameters can't be used at
the same time.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


884

    		
    
      
# File 'sig/client.rbs', line 884

def describe_phone_numbers: (

    		
  





    
      

  

  
    #describe_pools(params = {})  ⇒ Types::DescribePoolsResult 
  

  

  


  

    
Retrieves the specified pools or all pools associated with your Amazon
Web Services account.


If you specify pool IDs, the output includes information for only the
specified pools. If you specify filters, the output includes
information for only those pools that meet the filter criteria. If you
don't specify pool IDs or filters, the output includes information
for all pools.


If you specify a pool ID that isn't valid, an error is returned.


A pool is a collection of phone numbers and SenderIds. A pool can
include one or more phone numbers and SenderIds that are associated
with your Amazon Web Services 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.describe_pools({
  pool_ids: ["PoolIdOrArn"],
  filters: [
    {
      name: "status", # required, accepts status, message-type, two-way-enabled, self-managed-opt-outs-enabled, opt-out-list-name, shared-routes-enabled, deletion-protection-enabled, two-way-channel-arn
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  owner: "SELF", # accepts SELF, SHARED
})

    
      
        
Response structure

      
      

resp.pools #=> Array
resp.pools[0].pool_arn #=> String
resp.pools[0].pool_id #=> String
resp.pools[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
resp.pools[0].message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.pools[0].two_way_enabled #=> Boolean
resp.pools[0].two_way_channel_arn #=> String
resp.pools[0].two_way_channel_role #=> String
resp.pools[0].self_managed_opt_outs_enabled #=> Boolean
resp.pools[0].opt_out_list_name #=> String
resp.pools[0].shared_routes_enabled #=> Boolean
resp.pools[0].deletion_protection_enabled #=> Boolean
resp.pools[0].created_timestamp #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :pool_ids
          (Array<String>)
          
            
          
          
            — 
    The unique identifier of pools to find. This is an array of strings
that can be either the PoolId or PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::PoolFilter>)
          
            
          
          
            — 
    An array of PoolFilter objects to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
        
  • 
          :owner
          (String)
          
            
          
          
            — 
    Use SELF to filter the list of Pools to ones your account owns or
use SHARED to filter on Pools shared with your account. The Owner
and PoolIds parameters can't be used at the same time.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


904

    		
    
      
# File 'sig/client.rbs', line 904

def describe_pools: (

    		
  





    
      

  

  
    #describe_protect_configurations(params = {})  ⇒ Types::DescribeProtectConfigurationsResult 
  

  

  


  

    
Retrieves the protect configurations that match any of filters. If a
filter isn’t provided then all protect configurations are returned.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_protect_configurations({
  protect_configuration_ids: ["ProtectConfigurationIdOrArn"],
  filters: [
    {
      name: "account-default", # required, accepts account-default, deletion-protection-enabled
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.protect_configurations #=> Array
resp.protect_configurations[0].protect_configuration_arn #=> String
resp.protect_configurations[0].protect_configuration_id #=> String
resp.protect_configurations[0].created_timestamp #=> Time
resp.protect_configurations[0]. #=> Boolean
resp.protect_configurations[0].deletion_protection_enabled #=> Boolean
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_ids
          (Array<String>)
          
            
          
          
            — 
    An array of protect configuration identifiers to search for.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::ProtectConfigurationFilter>)
          
            
          
          
            — 
    An array of ProtectConfigurationFilter objects to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


924

    		
    
      
# File 'sig/client.rbs', line 924

def describe_protect_configurations: (

    		
  





    
      

  

  
    #describe_rcs_agent_country_launch_status(params = {})  ⇒ Types::DescribeRcsAgentCountryLaunchStatusResult 
  

  

  


  

    
Retrieves the per-country launch status of an RCS agent, including
carrier-level details for each country.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_rcs_agent_country_launch_status({
  rcs_agent_id: "RcsAgentIdOrArn", # required
  iso_country_codes: ["IsoCountryCode"],
  filters: [
    {
      name: "country-launch-status", # required, accepts country-launch-status
      values: ["FilterValue"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

    
      
        
Response structure

      
      

resp.rcs_agent_id #=> String
resp.rcs_agent_arn #=> String
resp.country_launch_status #=> Array
resp.country_launch_status[0].iso_country_code #=> String
resp.country_launch_status[0].status #=> String, one of "CREATED", "PENDING", "PARTIAL", "ACTIVE", "REJECTED"
resp.country_launch_status[0].rcs_platform_id #=> String
resp.country_launch_status[0].registration_id #=> String
resp.country_launch_status[0].carrier_status #=> Array
resp.country_launch_status[0].carrier_status[0].carrier_name #=> String
resp.country_launch_status[0].carrier_status[0].status #=> String, one of "PENDING", "ACTIVE", "REJECTED"
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :rcs_agent_id
          (required, String)
          
            
          
          
            — 
    The unique identifier of the RCS agent. You can use either the
RcsAgentId or RcsAgentArn.
    
          
        
    • 
      
        
  • 
          :iso_country_codes
          (Array<String>)
          
            
          
          
            — 
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2
format, to filter the results.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::CountryLaunchStatusFilter>)
          
            
          
          
            — 
    An array of CountryLaunchStatusFilter objects to filter the results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


945

    		
    
      
# File 'sig/client.rbs', line 945

def describe_rcs_agent_country_launch_status: (

    		
  





    
      

  

  
    #describe_rcs_agents(params = {})  ⇒ Types::DescribeRcsAgentsResult 
  

  

  


  

    
Retrieves the specified RCS agents or all RCS agents associated with
your Amazon Web Services account.


If you specify RCS agent IDs, the output includes information for only
the specified RCS agents. If you specify filters, the output includes
information for only those RCS agents that meet the filter criteria.
If you don't specify RCS agent IDs or filters, the output includes
information for all RCS agents.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_rcs_agents({
  rcs_agent_ids: ["RcsAgentIdOrArn"],
  owner: "SELF", # accepts SELF, SHARED
  filters: [
    {
      name: "status", # required, accepts status, two-way-enabled, self-managed-opt-outs-enabled, opt-out-list-name, deletion-protection-enabled, two-way-channel-arn
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.rcs_agents #=> Array
resp.rcs_agents[0].rcs_agent_arn #=> String
resp.rcs_agents[0].rcs_agent_id #=> String
resp.rcs_agents[0].status #=> String, one of "CREATED", "PENDING", "TESTING", "PARTIAL", "ACTIVE", "DELETED"
resp.rcs_agents[0].created_timestamp #=> Time
resp.rcs_agents[0].deletion_protection_enabled #=> Boolean
resp.rcs_agents[0].opt_out_list_name #=> String
resp.rcs_agents[0].self_managed_opt_outs_enabled #=> Boolean
resp.rcs_agents[0].two_way_channel_arn #=> String
resp.rcs_agents[0].two_way_channel_role #=> String
resp.rcs_agents[0].two_way_enabled #=> Boolean
resp.rcs_agents[0].pool_id #=> String
resp.rcs_agents[0].two_way_media_s3_bucket_name #=> String
resp.rcs_agents[0].two_way_media_s3_key_prefix #=> String
resp.rcs_agents[0].two_way_media_s3_role #=> String
resp.rcs_agents[0].two_way_rcs_events_enabled #=> Array
resp.rcs_agents[0].two_way_rcs_events_enabled[0] #=> String
resp.rcs_agents[0].testing_agent.status #=> String, one of "CREATED", "PENDING", "ACTIVE"
resp.rcs_agents[0].testing_agent.testing_agent_id #=> String
resp.rcs_agents[0].testing_agent.registration_id #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :rcs_agent_ids
          (Array<String>)
          
            
          
          
            — 
    An array of unique identifiers for the RCS agents. This is an array of
strings that can be either the RcsAgentId or RcsAgentArn.
    
          
        
    • 
      
        
  • 
          :owner
          (String)
          
            
          
          
            — 
    Use SELF to filter the list of RCS agents to ones your account owns
or use SHARED to filter on RCS agents shared with your account. The
Owner and RcsAgentIds parameters can't be used at the same time.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::RcsAgentFilter>)
          
            
          
          
            — 
    An array of RcsAgentFilter objects to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


965

    		
    
      
# File 'sig/client.rbs', line 965

def describe_rcs_agents: (

    		
  





    
      

  

  
    #describe_registration_attachments(params = {})  ⇒ Types::DescribeRegistrationAttachmentsResult 
  

  

  


  

    
Retrieves the specified registration attachments or all registration
attachments associated with your Amazon Web Services 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.describe_registration_attachments({
  registration_attachment_ids: ["RegistrationIdOrArn"],
  filters: [
    {
      name: "attachment-status", # required, accepts attachment-status
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.registration_attachments #=> Array
resp.registration_attachments[0].registration_attachment_arn #=> String
resp.registration_attachments[0].registration_attachment_id #=> String
resp.registration_attachments[0].attachment_status #=> String, one of "UPLOAD_IN_PROGRESS", "UPLOAD_COMPLETE", "UPLOAD_FAILED", "DELETED"
resp.registration_attachments[0].attachment_upload_error_reason #=> String, one of "INTERNAL_ERROR"
resp.registration_attachments[0].created_timestamp #=> Time
resp.registration_attachments[0].attachment_url #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_attachment_ids
          (Array<String>)
          
            
          
          
            — 
    The unique identifier of registration attachments to find. This is an
array of RegistrationAttachmentId.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::RegistrationAttachmentFilter>)
          
            
          
          
            — 
    An array of RegistrationAttachmentFilter objects to filter the
results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


985

    		
    
      
# File 'sig/client.rbs', line 985

def describe_registration_attachments: (

    		
  





    
      

  

  
    #describe_registration_field_definitions(params = {})  ⇒ Types::DescribeRegistrationFieldDefinitionsResult 
  

  

  


  

    
Retrieves the specified registration type field definitions. You can
use DescribeRegistrationFieldDefinitions to view the requirements for
creating, filling out, and submitting each registration type.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_registration_field_definitions({
  registration_type: "RegistrationType", # required
  section_path: "SectionPath",
  field_paths: ["FieldPath"],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.registration_type #=> String
resp.registration_field_definitions #=> Array
resp.registration_field_definitions[0].section_path #=> String
resp.registration_field_definitions[0].field_path #=> String
resp.registration_field_definitions[0].field_type #=> String, one of "SELECT", "TEXT", "ATTACHMENT"
resp.registration_field_definitions[0].field_requirement #=> String, one of "REQUIRED", "CONDITIONAL", "OPTIONAL"
resp.registration_field_definitions[0].select_validation.min_choices #=> Integer
resp.registration_field_definitions[0].select_validation.max_choices #=> Integer
resp.registration_field_definitions[0].select_validation.options #=> Array
resp.registration_field_definitions[0].select_validation.options[0] #=> String
resp.registration_field_definitions[0].text_validation.min_length #=> Integer
resp.registration_field_definitions[0].text_validation.max_length #=> Integer
resp.registration_field_definitions[0].text_validation.pattern #=> String
resp.registration_field_definitions[0].display_hints.title #=> String
resp.registration_field_definitions[0].display_hints.short_description #=> String
resp.registration_field_definitions[0].display_hints.long_description #=> String
resp.registration_field_definitions[0].display_hints.documentation_title #=> String
resp.registration_field_definitions[0].display_hints.documentation_link #=> String
resp.registration_field_definitions[0].display_hints.select_option_descriptions #=> Array
resp.registration_field_definitions[0].display_hints.select_option_descriptions[0].option #=> String
resp.registration_field_definitions[0].display_hints.select_option_descriptions[0].title #=> String
resp.registration_field_definitions[0].display_hints.select_option_descriptions[0].description #=> String
resp.registration_field_definitions[0].display_hints.text_validation_description #=> String
resp.registration_field_definitions[0].display_hints.example_text_value #=> String
resp.registration_field_definitions[0].conditional_behavior.rules #=> Array
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditions #=> Array
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditions[0].depends_on_field_path #=> String
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditions[0].operator #=> String
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditions[0].values #=> Array
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditions[0].values[0] #=> String
resp.registration_field_definitions[0].conditional_behavior.rules[0].rule_behavior #=> String
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditional_validation.min_length #=> Integer
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditional_validation.max_length #=> Integer
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditional_validation.pattern #=> String
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditional_validation.allowed_values #=> Array
resp.registration_field_definitions[0].conditional_behavior.rules[0].conditional_validation.allowed_values[0] #=> String
resp.registration_field_definitions[0].conditional_behavior.default_behavior #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_type
          (required, String)
          
            
          
          
            — 
    The type of registration form. The list of RegistrationTypes can
be found using the DescribeRegistrationTypeDefinitions action.
    
          
        
    • 
      
        
  • 
          :section_path
          (String)
          
            
          
          
            — 
    The path to the section of the registration.
    
          
        
    • 
      
        
  • 
          :field_paths
          (Array<String>)
          
            
          
          
            — 
    An array of paths to the registration form field.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1005

    		
    
      
# File 'sig/client.rbs', line 1005

def describe_registration_field_definitions: (

    		
  





    
      

  

  
    #describe_registration_field_values(params = {})  ⇒ Types::DescribeRegistrationFieldValuesResult 
  

  

  


  

    
Retrieves the specified registration field values.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_registration_field_values({
  registration_id: "RegistrationIdOrArn", # required
  version_number: 1,
  section_path: "SectionPath",
  field_paths: ["FieldPath"],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.version_number #=> Integer
resp.registration_field_values #=> Array
resp.registration_field_values[0].field_path #=> String
resp.registration_field_values[0].select_choices #=> Array
resp.registration_field_values[0].select_choices[0] #=> String
resp.registration_field_values[0].text_value #=> String
resp.registration_field_values[0].registration_attachment_id #=> String
resp.registration_field_values[0].denied_reason #=> String
resp.registration_field_values[0].feedback #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
        
  • 
          :version_number
          (Integer)
          
            
          
          
            — 
    The version number of the registration.
    
          
        
    • 
      
        
  • 
          :section_path
          (String)
          
            
          
          
            — 
    The path to the section of the registration.
    
          
        
    • 
      
        
  • 
          :field_paths
          (Array<String>)
          
            
          
          
            — 
    An array of paths to the registration form field.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1023

    		
    
      
# File 'sig/client.rbs', line 1023

def describe_registration_field_values: (

    		
  





    
      

  

  
    #describe_registration_section_definitions(params = {})  ⇒ Types::DescribeRegistrationSectionDefinitionsResult 
  

  

  


  

    
Retrieves the specified registration section definitions. You can use
DescribeRegistrationSectionDefinitions to view the requirements for
creating, filling out, and submitting each registration type.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_registration_section_definitions({
  registration_type: "RegistrationType", # required
  section_paths: ["SectionPath"],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.registration_type #=> String
resp.registration_section_definitions #=> Array
resp.registration_section_definitions[0].section_path #=> String
resp.registration_section_definitions[0].display_hints.title #=> String
resp.registration_section_definitions[0].display_hints.short_description #=> String
resp.registration_section_definitions[0].display_hints.long_description #=> String
resp.registration_section_definitions[0].display_hints.documentation_title #=> String
resp.registration_section_definitions[0].display_hints.documentation_link #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_type
          (required, String)
          
            
          
          
            — 
    The type of registration form. The list of RegistrationTypes can
be found using the DescribeRegistrationTypeDefinitions action.
    
          
        
    • 
      
        
  • 
          :section_paths
          (Array<String>)
          
            
          
          
            — 
    An array of paths for the registration form section.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1040

    		
    
      
# File 'sig/client.rbs', line 1040

def describe_registration_section_definitions: (

    		
  





    
      

  

  
    #describe_registration_type_definitions(params = {})  ⇒ Types::DescribeRegistrationTypeDefinitionsResult 
  

  

  


  

    
Retrieves the specified registration type definitions. You can use
DescribeRegistrationTypeDefinitions to view the requirements for
creating, filling out, and submitting each registration type.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_registration_type_definitions({
  registration_types: ["RegistrationType"],
  filters: [
    {
      name: "supported-association-resource-type", # required, accepts supported-association-resource-type, supported-association-iso-country-code
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.registration_type_definitions #=> Array
resp.registration_type_definitions[0].registration_type #=> String
resp.registration_type_definitions[0].supported_associations #=> Array
resp.registration_type_definitions[0].supported_associations[0].resource_type #=> String
resp.registration_type_definitions[0].supported_associations[0].iso_country_code #=> String
resp.registration_type_definitions[0].supported_associations[0].association_behavior #=> String, one of "ASSOCIATE_BEFORE_SUBMIT", "ASSOCIATE_ON_APPROVAL", "ASSOCIATE_AFTER_COMPLETE"
resp.registration_type_definitions[0].supported_associations[0].disassociation_behavior #=> String, one of "DISASSOCIATE_ALL_CLOSES_REGISTRATION", "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION", "DELETE_REGISTRATION_DISASSOCIATES"
resp.registration_type_definitions[0].display_hints.title #=> String
resp.registration_type_definitions[0].display_hints.short_description #=> String
resp.registration_type_definitions[0].display_hints.long_description #=> String
resp.registration_type_definitions[0].display_hints.documentation_title #=> String
resp.registration_type_definitions[0].display_hints.documentation_link #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_types
          (Array<String>)
          
            
          
          
            — 
    The type of registration form. The list of RegistrationTypes can
be found using the DescribeRegistrationTypeDefinitions action.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::RegistrationTypeFilter>)
          
            
          
          
            — 
    An array of RegistrationFilter objects to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1054

    		
    
      
# File 'sig/client.rbs', line 1054

def describe_registration_type_definitions: (

    		
  





    
      

  

  
    #describe_registration_versions(params = {})  ⇒ Types::DescribeRegistrationVersionsResult 
  

  

  


  

    
Retrieves the specified registration version.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_registration_versions({
  registration_id: "RegistrationIdOrArn", # required
  version_numbers: [1],
  filters: [
    {
      name: "registration-version-status", # required, accepts registration-version-status
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.registration_versions #=> Array
resp.registration_versions[0].version_number #=> Integer
resp.registration_versions[0].registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "AWS_REVIEWING", "REVIEWING", "REQUIRES_AUTHENTICATION", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED", "REQUIRES_OFFLINE_REVIEW"
resp.registration_versions[0].registration_version_status_history.draft_timestamp #=> Time
resp.registration_versions[0].registration_version_status_history.submitted_timestamp #=> Time
resp.registration_versions[0].registration_version_status_history.aws_reviewing_timestamp #=> Time
resp.registration_versions[0].registration_version_status_history.reviewing_timestamp #=> Time
resp.registration_versions[0].registration_version_status_history.requires_authentication_timestamp #=> Time
resp.registration_versions[0].registration_version_status_history.approved_timestamp #=> Time
resp.registration_versions[0].registration_version_status_history.discarded_timestamp #=> Time
resp.registration_versions[0].registration_version_status_history.denied_timestamp #=> Time
resp.registration_versions[0].registration_version_status_history.revoked_timestamp #=> Time
resp.registration_versions[0].registration_version_status_history.archived_timestamp #=> Time
resp.registration_versions[0].denied_reasons #=> Array
resp.registration_versions[0].denied_reasons[0].reason #=> String
resp.registration_versions[0].denied_reasons[0].short_description #=> String
resp.registration_versions[0].denied_reasons[0].long_description #=> String
resp.registration_versions[0].denied_reasons[0].documentation_title #=> String
resp.registration_versions[0].denied_reasons[0].documentation_link #=> String
resp.registration_versions[0].feedback #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
        
  • 
          :version_numbers
          (Array<Integer>)
          
            
          
          
            — 
    An array of registration version numbers.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::RegistrationVersionFilter>)
          
            
          
          
            — 
    An array of RegistrationVersionFilter objects to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1075

    		
    
      
# File 'sig/client.rbs', line 1075

def describe_registration_versions: (

    		
  





    
      

  

  
    #describe_registrations(params = {})  ⇒ Types::DescribeRegistrationsResult 
  

  

  


  

    
Retrieves the specified registrations.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_registrations({
  registration_ids: ["RegistrationIdOrArn"],
  filters: [
    {
      name: "registration-type", # required, accepts registration-type, registration-status
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.registrations #=> Array
resp.registrations[0].registration_arn #=> String
resp.registrations[0].registration_id #=> String
resp.registrations[0].registration_type #=> String
resp.registrations[0].registration_status #=> String, one of "CREATED", "SUBMITTED", "AWS_REVIEWING", "REVIEWING", "REQUIRES_AUTHENTICATION", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
resp.registrations[0].current_version_number #=> Integer
resp.registrations[0].approved_version_number #=> Integer
resp.registrations[0].latest_denied_version_number #=> Integer
resp.registrations[0].additional_attributes #=> Hash
resp.registrations[0].additional_attributes["String"] #=> String
resp.registrations[0].created_timestamp #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_ids
          (Array<String>)
          
            
          
          
            — 
    An array of unique identifiers for each registration.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::RegistrationFilter>)
          
            
          
          
            — 
    An array of RegistrationFilter objects to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1095

    		
    
      
# File 'sig/client.rbs', line 1095

def describe_registrations: (

    		
  





    
      

  

  
    #describe_sender_ids(params = {})  ⇒ Types::DescribeSenderIdsResult 
  

  

  


  

    
Describes the specified SenderIds or all SenderIds associated with
your Amazon Web Services account.


If you specify SenderIds, the output includes information for only the
specified SenderIds. If you specify filters, the output includes
information for only those SenderIds that meet the filter criteria. If
you don't specify SenderIds or filters, the output includes
information for all SenderIds.


f you specify a sender ID that isn't valid, an error is returned.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_sender_ids({
  sender_ids: [
    {
      sender_id: "SenderIdOrArn", # required
      iso_country_code: "IsoCountryCode", # required
    },
  ],
  filters: [
    {
      name: "sender-id", # required, accepts sender-id, iso-country-code, message-type, deletion-protection-enabled, registered
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  owner: "SELF", # accepts SELF, SHARED
})

    
      
        
Response structure

      
      

resp.sender_ids #=> Array
resp.sender_ids[0].sender_id_arn #=> String
resp.sender_ids[0].sender_id #=> String
resp.sender_ids[0].iso_country_code #=> String
resp.sender_ids[0].message_types #=> Array
resp.sender_ids[0].message_types[0] #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.sender_ids[0].monthly_leasing_price #=> String
resp.sender_ids[0].deletion_protection_enabled #=> Boolean
resp.sender_ids[0].registered #=> Boolean
resp.sender_ids[0].registration_id #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :sender_ids
          (Array<Types::SenderIdAndCountry>)
          
            
          
          
            — 
    An array of SenderIdAndCountry objects to search for.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::SenderIdFilter>)
          
            
          
          
            — 
    An array of SenderIdFilter objects to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
        
  • 
          :owner
          (String)
          
            
          
          
            — 
    Use SELF to filter the list of Sender Ids to ones your account owns
or use SHARED to filter on Sender Ids shared with your account. The
Owner and SenderIds parameters can't be used at the same time.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1114

    		
    
      
# File 'sig/client.rbs', line 1114

def describe_sender_ids: (

    		
  





    
      

  

  
    #describe_spend_limits(params = {})  ⇒ Types::DescribeSpendLimitsResult 
  

  

  


  

    
Describes the current monthly spend limits for sending voice and text
messages.


When you establish an Amazon Web Services account, the account has
initial monthly spend limit in a given Region. For more information on
increasing your monthly spend limit, see  Requesting increases to
your monthly SMS, MMS, or Voice spending quota  in the End User
Messaging SMS User Guide.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.spend_limits #=> Array
resp.spend_limits[0].name #=> String, one of "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", "MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT", "NOTIFY_MESSAGE_MONTHLY_SPEND_LIMIT", "RCS_MESSAGE_MONTHLY_SPEND_LIMIT"
resp.spend_limits[0].enforced_limit #=> Integer
resp.spend_limits[0].max_limit #=> Integer
resp.spend_limits[0].overridden #=> Boolean
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1139

    		
    
      
# File 'sig/client.rbs', line 1139

def describe_spend_limits: (

    		
  





    
      

  

  
    #describe_verified_destination_numbers(params = {})  ⇒ Types::DescribeVerifiedDestinationNumbersResult 
  

  

  


  

    
Retrieves the specified verified destination numbers.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_verified_destination_numbers({
  verified_destination_number_ids: ["VerifiedDestinationNumberIdOrArn"],
  destination_phone_numbers: ["PhoneNumber"],
  filters: [
    {
      name: "status", # required, accepts status, rcs-agent-id
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.verified_destination_numbers #=> Array
resp.verified_destination_numbers[0].verified_destination_number_arn #=> String
resp.verified_destination_numbers[0].verified_destination_number_id #=> String
resp.verified_destination_numbers[0].destination_phone_number #=> String
resp.verified_destination_numbers[0].status #=> String, one of "PENDING", "VERIFIED", "UNSUPPORTED"
resp.verified_destination_numbers[0].rcs_agent_id #=> String
resp.verified_destination_numbers[0].created_timestamp #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :verified_destination_number_ids
          (Array<String>)
          
            
          
          
            — 
    An array of VerifiedDestinationNumberid to retrieve.
    
          
        
    • 
      
        
  • 
          :destination_phone_numbers
          (Array<String>)
          
            
          
          
            — 
    An array of verified destination phone number, in E.164 format.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::VerifiedDestinationNumberFilter>)
          
            
          
          
            — 
    An array of VerifiedDestinationNumberFilter objects to filter the
results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1151

    		
    
      
# File 'sig/client.rbs', line 1151

def describe_verified_destination_numbers: (

    		
  





    
      

  

  
    #disassociate_origination_identity(params = {})  ⇒ Types::DisassociateOriginationIdentityResult 
  

  

  


  

    
Removes the specified origination identity from an existing pool.


If the origination identity isn't associated with the specified pool,
an error is returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.disassociate_origination_identity({
  pool_id: "PoolIdOrArn", # required
  origination_identity: "PhoneOrSenderIdOrArn", # required
  iso_country_code: "IsoCountryCode",
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.pool_arn #=> String
resp.pool_id #=> String
resp.origination_identity_arn #=> String
resp.origination_identity #=> String
resp.iso_country_code #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :pool_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the pool to disassociate with the
origination identity. This value can be either the PoolId or PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :origination_identity
          (required, String)
          
            
          
          
            — 
    The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, SenderId or SenderIdArn. You can use
DescribePhoneNumbers find the values for PhoneNumberId and
PhoneNumberArn, or use DescribeSenderIds to get the values for
SenderId and SenderIdArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :iso_country_code
          (String)
          
            
          
          
            — 
    The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region. This field is optional and is not required for origination
identity types that are not country-specific, such as RCS agents.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


1174

    		
    
      
# File 'sig/client.rbs', line 1174

def disassociate_origination_identity: (

    		
  





    
      

  

  
    #disassociate_protect_configuration(params = {})  ⇒ Types::DisassociateProtectConfigurationResult 
  

  

  


  

    
Disassociate a protect configuration from a configuration set.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.disassociate_protect_configuration({
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
  configuration_set_name: "ConfigurationSetNameOrArn", # required
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The name of the ConfigurationSet.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1190

    		
    
      
# File 'sig/client.rbs', line 1190

def disassociate_protect_configuration: (

    		
  





    
      

  

  
    #discard_registration_version(params = {})  ⇒ Types::DiscardRegistrationVersionResult 
  

  

  


  

    
Discard the current version of the registration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.discard_registration_version({
  registration_id: "RegistrationIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.version_number #=> Integer
resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "AWS_REVIEWING", "REVIEWING", "REQUIRES_AUTHENTICATION", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED", "REQUIRES_OFFLINE_REVIEW"
resp.registration_version_status_history.draft_timestamp #=> Time
resp.registration_version_status_history.submitted_timestamp #=> Time
resp.registration_version_status_history.aws_reviewing_timestamp #=> Time
resp.registration_version_status_history.reviewing_timestamp #=> Time
resp.registration_version_status_history.requires_authentication_timestamp #=> Time
resp.registration_version_status_history.approved_timestamp #=> Time
resp.registration_version_status_history.discarded_timestamp #=> Time
resp.registration_version_status_history.denied_timestamp #=> Time
resp.registration_version_status_history.revoked_timestamp #=> Time
resp.registration_version_status_history.archived_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1205

    		
    
      
# File 'sig/client.rbs', line 1205

def discard_registration_version: (

    		
  





    
      

  

  
    #get_protect_configuration_country_rule_set(params = {})  ⇒ Types::GetProtectConfigurationCountryRuleSetResult 
  

  

  


  

    
Retrieve the CountryRuleSet for the specified NumberCapability from a
protect configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_protect_configuration_country_rule_set({
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
  number_capability: "SMS", # required, accepts SMS, VOICE, MMS, RCS
})

    
      
        
Response structure

      
      

resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String
resp.number_capability #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.country_rule_set #=> Hash
resp.country_rule_set["IsoCountryCode"].protect_status #=> String, one of "ALLOW", "BLOCK", "MONITOR", "FILTER"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :number_capability
          (required, String)
          
            
          
          
            — 
    The capability type to return the CountryRuleSet for. Valid values are
SMS, VOICE, or MMS.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1218

    		
    
      
# File 'sig/client.rbs', line 1218

def get_protect_configuration_country_rule_set: (

    		
  





    
      

  

  
    #get_resource_policy(params = {})  ⇒ Types::GetResourcePolicyResult 
  

  

  


  

    
Retrieves the JSON text of the resource-based policy document attached
to the End User Messaging SMS resource. A shared resource can be a
Pool, Opt-out list, Sender Id, or Phone number.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_resource_policy({
  resource_arn: "AmazonResourceName", # required
})

    
      
        
Response structure

      
      

resp.resource_arn #=> String
resp.policy #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the End User Messaging SMS resource
attached to the resource-based policy.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1231

    		
    
      
# File 'sig/client.rbs', line 1231

def get_resource_policy: (

    		
  





    
      

  

  
    #list_notify_countries(params = {})  ⇒ Types::ListNotifyCountriesResult 
  

  

  


  

    
Lists countries that support notify messaging. You can optionally
filter by channel, use case, or tier.


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


  





  
  

    
Examples:

    
      
        
Example: ListNotifyCountries

      
      

# List countries that support notify messaging over SMS.

resp = client.list_notify_countries({
  channels: [
    "SMS", 
  ], 
  max_results: 10, 
})

resp.to_h outputs the following:
{
  notify_countries: [
    {
      country_name: "United States", 
      customer_owned_identity_required: false, 
      iso_country_code: "US", 
      supported_channels: [
        "SMS", 
        "VOICE", 
      ], 
      supported_tiers: [
        "BASIC", 
        "ADVANCED", 
      ], 
      supported_use_cases: [
        "CODE_VERIFICATION", 
      ], 
    }, 
    {
      country_name: "Canada", 
      customer_owned_identity_required: false, 
      iso_country_code: "CA", 
      supported_channels: [
        "SMS", 
      ], 
      supported_tiers: [
        "BASIC", 
      ], 
      supported_use_cases: [
        "CODE_VERIFICATION", 
      ], 
    }, 
  ], 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_notify_countries({
  channels: ["SMS"], # accepts SMS, VOICE, MMS, RCS
  use_cases: ["CODE_VERIFICATION"], # accepts CODE_VERIFICATION
  tier: "BASIC", # accepts BASIC, ADVANCED
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.notify_countries #=> Array
resp.notify_countries[0].iso_country_code #=> String
resp.notify_countries[0].country_name #=> String
resp.notify_countries[0].supported_channels #=> Array
resp.notify_countries[0].supported_channels[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.notify_countries[0].supported_use_cases #=> Array
resp.notify_countries[0].supported_use_cases[0] #=> String, one of "CODE_VERIFICATION"
resp.notify_countries[0].supported_tiers #=> Array
resp.notify_countries[0].supported_tiers[0] #=> String, one of "BASIC", "ADVANCED"
resp.notify_countries[0].customer_owned_identity_required #=> Boolean
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :channels
          (Array<String>)
          
            
          
          
            — 
    An array of channels to filter the results by.
    
          
        
    • 
      
        
  • 
          :use_cases
          (Array<String>)
          
            
          
          
            — 
    An array of use cases to filter the results by.
    
          
        
    • 
      
        
  • 
          :tier
          (String)
          
            
          
          
            — 
    The tier to filter the results by.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1242

    		
    
      
# File 'sig/client.rbs', line 1242

def list_notify_countries: (

    		
  





    
      

  

  
    #list_pool_origination_identities(params = {})  ⇒ Types::ListPoolOriginationIdentitiesResult 
  

  

  


  

    
Lists all associated origination identities in your pool.


If you specify filters, the output includes information for only those
origination identities that meet the filter criteria.


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_pool_origination_identities({
  pool_id: "PoolIdOrArn", # required
  filters: [
    {
      name: "iso-country-code", # required, accepts iso-country-code, number-capability
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.pool_arn #=> String
resp.pool_id #=> String
resp.origination_identities #=> Array
resp.origination_identities[0].origination_identity_arn #=> String
resp.origination_identities[0].origination_identity #=> String
resp.origination_identities[0].iso_country_code #=> String
resp.origination_identities[0].number_capabilities #=> Array
resp.origination_identities[0].number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.origination_identities[0].phone_number #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :pool_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the pool. This value can be either the
PoolId or PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::PoolOriginationIdentitiesFilter>)
          
            
          
          
            — 
    An array of PoolOriginationIdentitiesFilter objects to filter the
results..
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1259

    		
    
      
# File 'sig/client.rbs', line 1259

def list_pool_origination_identities: (

    		
  





    
      

  

  
    #list_protect_configuration_rule_set_number_overrides(params = {})  ⇒ Types::ListProtectConfigurationRuleSetNumberOverridesResult 
  

  

  


  

    
Retrieve all of the protect configuration rule set number overrides
that match the filters.


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_protect_configuration_rule_set_number_overrides({
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
  filters: [
    {
      name: "iso-country-code", # required, accepts iso-country-code, destination-phone-number-begins-with, action, expires-before, expires-after, created-before, created-after
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String
resp.rule_set_number_overrides #=> Array
resp.rule_set_number_overrides[0].destination_phone_number #=> String
resp.rule_set_number_overrides[0].created_timestamp #=> Time
resp.rule_set_number_overrides[0].action #=> String, one of "ALLOW", "BLOCK"
resp.rule_set_number_overrides[0].iso_country_code #=> String
resp.rule_set_number_overrides[0].expiration_timestamp #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::ProtectConfigurationRuleSetNumberOverrideFilterItem>)
          
            
          
          
            — 
    An array of ProtectConfigurationRuleSetNumberOverrideFilterItem
objects to filter the results.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1280

    		
    
      
# File 'sig/client.rbs', line 1280

def list_protect_configuration_rule_set_number_overrides: (

    		
  





    
      

  

  
    #list_registration_associations(params = {})  ⇒ Types::ListRegistrationAssociationsResult 
  

  

  


  

    
Retrieve all of the origination identities that are associated with a
registration.


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_registration_associations({
  registration_id: "RegistrationIdOrArn", # required
  filters: [
    {
      name: "resource-type", # required, accepts resource-type, iso-country-code
      values: ["FilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.registration_type #=> String
resp.registration_associations #=> Array
resp.registration_associations[0].resource_arn #=> String
resp.registration_associations[0].resource_id #=> String
resp.registration_associations[0].resource_type #=> String
resp.registration_associations[0].iso_country_code #=> String
resp.registration_associations[0].phone_number #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::RegistrationAssociationFilter>)
          
            
          
          
            — 
    An array of RegistrationAssociationFilter to apply to the results that
are returned.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per each request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1302

    		
    
      
# File 'sig/client.rbs', line 1302

def list_registration_associations: (

    		
  





    
      

  

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

  

  


  

    
List all tags associated with a resource.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.resource_arn #=> String
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 Amazon Resource Name (ARN) of the resource to query for.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1321

    		
    
      
# File 'sig/client.rbs', line 1321

def list_tags_for_resource: (

    		
  





    
      

  

  
    #put_keyword(params = {})  ⇒ Types::PutKeywordResult 
  

  

  


  

    
Creates or updates a keyword configuration on an origination phone
number or pool.


A keyword is a word that you can search for on a particular phone
number or pool. It is also a specific word or phrase that an end user
can send to your number to elicit a response, such as an informational
message or a special offer. When your number receives a message that
begins with a keyword, End User Messaging SMS responds with a
customizable message.


If you specify a keyword that isn't valid, an error is returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.put_keyword({
  origination_identity: "PhoneOrPoolIdOrArn", # required
  keyword: "Keyword", # required
  keyword_message: "KeywordMessage", # required
  keyword_action: "AUTOMATIC_RESPONSE", # accepts AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN
})

    
      
        
Response structure

      
      

resp.origination_identity_arn #=> String
resp.origination_identity #=> String
resp.keyword #=> String
resp.keyword_message #=> String
resp.keyword_action #=> String, one of "AUTOMATIC_RESPONSE", "OPT_OUT", "OPT_IN"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :origination_identity
          (required, String)
          
            
          
          
            — 
    The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, SenderId or SenderIdArn. You can use
DescribePhoneNumbers get the values for PhoneNumberId and
PhoneNumberArn while DescribeSenderIds can be used to get the values
for SenderId and SenderIdArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :keyword
          (required, String)
          
            
          
          
            — 
    The new keyword to add.
    
          
        
    • 
      
        
  • 
          :keyword_message
          (required, String)
          
            
          
          
            — 
    The message associated with the keyword.
    
          
        
    • 
      
        
  • 
          :keyword_action
          (String)
          
            
          
          
            — 
    The action to perform for the new keyword when it is received.
    

      

    • 

      AUTOMATIC_RESPONSE: A message is sent to the recipient.
      

      • 

    • 

      OPT_OUT: Keeps the recipient from receiving future messages.
      

      • 

    • 

      OPT_IN: The recipient wants to receive future messages.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1335

    		
    
      
# File 'sig/client.rbs', line 1335

def put_keyword: (

    		
  





    
      

  

  
    #put_message_feedback(params = {})  ⇒ Types::PutMessageFeedbackResult 
  

  

  


  

    
Set the MessageFeedbackStatus as RECEIVED or FAILED for the passed
in MessageId.


If you use message feedback then you must update message feedback
record. When you receive a signal that a user has received the message
you must use PutMessageFeedback to set the message feedback record
as RECEIVED; Otherwise, an hour after the message feedback record is
set to FAILED.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.put_message_feedback({
  message_id: "MessageId", # required
  message_feedback_status: "RECEIVED", # required, accepts RECEIVED, FAILED
})

    
      
        
Response structure

      
      

resp.message_id #=> String
resp.message_feedback_status #=> String, one of "RECEIVED", "FAILED"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :message_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the message.
    
          
        
    • 
      
        
  • 
          :message_feedback_status
          (required, String)
          
            
          
          
            — 
    Set the message feedback to be either RECEIVED or FAILED.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1349

    		
    
      
# File 'sig/client.rbs', line 1349

def put_message_feedback: (

    		
  





    
      

  

  
    #put_opted_out_number(params = {})  ⇒ Types::PutOptedOutNumberResult 
  

  

  


  

    
Creates an opted out destination phone number in the opt-out list.


If the destination phone number isn't valid or if the specified
opt-out list doesn't exist, an error is returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.put_opted_out_number({
  opt_out_list_name: "OptOutListNameOrArn", # required
  opted_out_number: "PhoneNumber", # required
})

    
      
        
Response structure

      
      

resp.opt_out_list_arn #=> String
resp.opt_out_list_name #=> String
resp.opted_out_number #=> String
resp.opted_out_timestamp #=> Time
resp.end_user_opted_out #=> Boolean

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :opt_out_list_name
          (required, String)
          
            
          
          
            — 
    The OptOutListName or OptOutListArn to add the phone number to.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :opted_out_number
          (required, String)
          
            
          
          
            — 
    The phone number to add to the OptOutList in E.164 format.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1364

    		
    
      
# File 'sig/client.rbs', line 1364

def put_opted_out_number: (

    		
  





    
      

  

  
    #put_protect_configuration_rule_set_number_override(params = {})  ⇒ Types::PutProtectConfigurationRuleSetNumberOverrideResult 
  

  

  


  

    
Create or update a phone number rule override and associate it with a
protect configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.put_protect_configuration_rule_set_number_override({
  client_token: "ClientToken",
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
  destination_phone_number: "PhoneNumber", # required
  action: "ALLOW", # required, accepts ALLOW, BLOCK
  expiration_timestamp: Time.now,
})

    
      
        
Response structure

      
      

resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String
resp.destination_phone_number #=> String
resp.created_timestamp #=> Time
resp.action #=> String, one of "ALLOW", "BLOCK"
resp.iso_country_code #=> String
resp.expiration_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

    A suitable default value is auto-generated. You should normally
not need to pass this option.**
    
          
        
    • 
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :destination_phone_number
          (required, String)
          
            
          
          
            — 
    The destination phone number in E.164 format.
    
          
        
    • 
      
        
  • 
          :action
          (required, String)
          
            
          
          
            — 
    The action for the rule to either block or allow messages to the
destination phone number.
    
          
        
    • 
      
        
  • 
          :expiration_timestamp
          (Time, DateTime, Date, Integer, String)
          
            
          
          
            — 
    The time the rule will expire at. If ExpirationTimestamp is not set
then the rule does not expire.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1381

    		
    
      
# File 'sig/client.rbs', line 1381

def put_protect_configuration_rule_set_number_override: (

    		
  





    
      

  

  
    #put_registration_field_value(params = {})  ⇒ Types::PutRegistrationFieldValueResult 
  

  

  


  

    
Creates or updates a field value for a registration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.put_registration_field_value({
  registration_id: "RegistrationIdOrArn", # required
  field_path: "FieldPath", # required
  select_choices: ["SelectChoice"],
  text_value: "TextValue",
  registration_attachment_id: "RegistrationAttachmentIdOrArn",
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.version_number #=> Integer
resp.field_path #=> String
resp.select_choices #=> Array
resp.select_choices[0] #=> String
resp.text_value #=> String
resp.registration_attachment_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
        
  • 
          :field_path
          (required, String)
          
            
          
          
            — 
    The path to the registration form field. You can use
DescribeRegistrationFieldDefinitions for a list of FieldPaths.
    
          
        
    • 
      
        
  • 
          :select_choices
          (Array<String>)
          
            
          
          
            — 
    An array of values for the form field.
    
          
        
    • 
      
        
  • 
          :text_value
          (String)
          
            
          
          
            — 
    The text data for a free form field.
    
          
        
    • 
      
        
  • 
          :registration_attachment_id
          (String)
          
            
          
          
            — 
    The unique identifier for the registration attachment.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1401

    		
    
      
# File 'sig/client.rbs', line 1401

def put_registration_field_value: (

    		
  





    
      

  

  
    #put_resource_policy(params = {})  ⇒ Types::PutResourcePolicyResult 
  

  

  


  

    
Attaches a resource-based policy to a End User Messaging SMS
resource(phone number, sender Id, phone poll, or opt-out list) that is
used for sharing the resource. A shared resource can be a Pool,
Opt-out list, Sender Id, or Phone number. For more information about
resource-based policies, see Working with shared resources in the
End User Messaging SMS User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.put_resource_policy({
  resource_arn: "AmazonResourceName", # required
  policy: "ResourcePolicy", # required
})

    
      
        
Response structure

      
      

resp.resource_arn #=> String
resp.policy #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the End User Messaging SMS resource
to attach the resource-based policy to.
    
          
        
    • 
      
        
  • 
          :policy
          (required, String)
          
            
          
          
            — 
    The JSON formatted resource-based policy to attach.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1417

    		
    
      
# File 'sig/client.rbs', line 1417

def put_resource_policy: (

    		
  





    
      

  

  
    #release_phone_number(params = {})  ⇒ Types::ReleasePhoneNumberResult 
  

  

  


  

    
Releases an existing origination phone number in your account. Once
released, a phone number is no longer available for sending messages.


If the origination phone number has deletion protection enabled or is
associated with a pool, an error is returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.release_phone_number({
  phone_number_id: "PhoneNumberIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.phone_number_arn #=> String
resp.phone_number_id #=> String
resp.phone_number #=> String
resp.status #=> String, one of "PENDING", "ACTIVE", "ASSOCIATING", "DISASSOCIATING", "DELETED"
resp.iso_country_code #=> String
resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.number_capabilities #=> Array
resp.number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
resp.monthly_leasing_price #=> String
resp.two_way_enabled #=> Boolean
resp.two_way_channel_arn #=> String
resp.two_way_channel_role #=> String
resp.self_managed_opt_outs_enabled #=> Boolean
resp.opt_out_list_name #=> String
resp.registration_id #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :phone_number_id
          (required, String)
          
            
          
          
            — 
    The PhoneNumberId or PhoneNumberArn of the phone number to release.
You can use DescribePhoneNumbers to get the values for PhoneNumberId
and PhoneNumberArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1443

    		
    
      
# File 'sig/client.rbs', line 1443

def release_phone_number: (

    		
  





    
      

  

  
    #release_sender_id(params = {})  ⇒ Types::ReleaseSenderIdResult 
  

  

  


  

    
Releases an existing sender ID in your account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.release_sender_id({
  sender_id: "SenderIdOrArn", # required
  iso_country_code: "IsoCountryCode", # required
})

    
      
        
Response structure

      
      

resp.sender_id_arn #=> String
resp.sender_id #=> String
resp.iso_country_code #=> String
resp.message_types #=> Array
resp.message_types[0] #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.monthly_leasing_price #=> String
resp.registered #=> Boolean
resp.registration_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :sender_id
          (required, String)
          
            
          
          
            — 
    The sender ID to release.
    
          
        
    • 
      
        
  • 
          :iso_country_code
          (required, String)
          
            
          
          
            — 
    The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1459

    		
    
      
# File 'sig/client.rbs', line 1459

def release_sender_id: (

    		
  





    
      

  

  
    #request_phone_number(params = {})  ⇒ Types::RequestPhoneNumberResult 
  

  

  


  

    
Request an origination phone number for use in your account. For more
information on phone number request see Request a phone number in
the End User Messaging SMS User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.request_phone_number({
  iso_country_code: "IsoCountryCode", # required
  message_type: "TRANSACTIONAL", # required, accepts TRANSACTIONAL, PROMOTIONAL
  number_capabilities: ["SMS"], # required, accepts SMS, VOICE, MMS, RCS
  number_type: "LONG_CODE", # required, accepts LONG_CODE, TOLL_FREE, TEN_DLC, SIMULATOR
  opt_out_list_name: "OptOutListNameOrArn",
  pool_id: "PoolIdOrArn",
  registration_id: "RegistrationIdOrArn",
  international_sending_enabled: false,
  deletion_protection_enabled: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.phone_number_arn #=> String
resp.phone_number_id #=> String
resp.phone_number #=> String
resp.status #=> String, one of "PENDING", "ACTIVE", "ASSOCIATING", "DISASSOCIATING", "DELETED"
resp.iso_country_code #=> String
resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.number_capabilities #=> Array
resp.number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.number_type #=> String, one of "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
resp.monthly_leasing_price #=> String
resp.two_way_enabled #=> Boolean
resp.two_way_channel_arn #=> String
resp.two_way_channel_role #=> String
resp.self_managed_opt_outs_enabled #=> Boolean
resp.opt_out_list_name #=> String
resp.international_sending_enabled #=> Boolean
resp.deletion_protection_enabled #=> Boolean
resp.pool_id #=> String
resp.registration_id #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :iso_country_code
          (required, String)
          
            
          
          
            — 
    The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region.
    
          
        
    • 
      
        
  • 
          :message_type
          (required, String)
          
            
          
          
            — 
    The type of message. Valid values are TRANSACTIONAL for messages
that are critical or time-sensitive and PROMOTIONAL for messages
that aren't critical or time-sensitive.
    
          
        
    • 
      
        
  • 
          :number_capabilities
          (required, Array<String>)
          
            
          
          
            — 
    Indicates if the phone number will be used for text messages, voice
messages, or both.
    
          
        
    • 
      
        
  • 
          :number_type
          (required, String)
          
            
          
          
            — 
    The type of phone number to request.
    

    When you request a SIMULATOR phone number, you must set
MessageType as TRANSACTIONAL.
    
          
        
    • 
      
        
  • 
          :opt_out_list_name
          (String)
          
            
          
          
            — 
    The name of the OptOutList to associate with the phone number. You can
use the OptOutListName or OptOutListArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :pool_id
          (String)
          
            
          
          
            — 
    The pool to associated with the phone number. You can use the PoolId
or PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :registration_id
          (String)
          
            
          
          
            — 
    Use this field to attach your phone number for an external
registration process.
    
          
        
    • 
      
        
  • 
          :international_sending_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the international
sending of phone number is Enabled.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the phone number
can't be deleted.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of tags (key and value pairs) to associate with the requested
phone number.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


1489

    		
    
      
# File 'sig/client.rbs', line 1489

def request_phone_number: (

    		
  





    
      

  

  
    #request_sender_id(params = {})  ⇒ Types::RequestSenderIdResult 
  

  

  


  

    
Request a new sender ID that doesn't require registration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.request_sender_id({
  sender_id: "SenderId", # required
  iso_country_code: "IsoCountryCode", # required
  message_types: ["TRANSACTIONAL"], # accepts TRANSACTIONAL, PROMOTIONAL
  deletion_protection_enabled: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.sender_id_arn #=> String
resp.sender_id #=> String
resp.iso_country_code #=> String
resp.message_types #=> Array
resp.message_types[0] #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.monthly_leasing_price #=> String
resp.deletion_protection_enabled #=> Boolean
resp.registered #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :sender_id
          (required, String)
          
            
          
          
            — 
    The sender ID string to request. The sender ID can be 1-11
alphanumeric characters including letters (A-Z, a-z), numbers (0-9),
or hyphens (-). The sender ID must contain at least one letter and
cannot start or end with a hyphen.
    
          
        
    • 
      
        
  • 
          :iso_country_code
          (required, String)
          
            
          
          
            — 
    The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region.
    
          
        
    • 
      
        
  • 
          :message_types
          (Array<String>)
          
            
          
          
            — 
    The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that
aren't critical or time-sensitive.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the sender ID can't
be deleted.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    An array of tags (key and value pairs) to associate with the sender
ID.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure
idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


1521

    		
    
      
# File 'sig/client.rbs', line 1521

def request_sender_id: (

    		
  





    
      

  

  
    #send_destination_number_verification_code(params = {})  ⇒ Types::SendDestinationNumberVerificationCodeResult 
  

  

  


  

    
Before you can send test messages to a verified destination phone
number you need to opt-in the verified destination phone number.
Creates a new text message with a verification code and send it to a
verified destination phone number. Once you have the verification code
use VerifyDestinationNumber to opt-in the verified destination phone
number to receive messages.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.send_destination_number_verification_code({
  verified_destination_number_id: "VerifiedDestinationNumberIdOrArn", # required
  verification_channel: "TEXT", # required, accepts TEXT, VOICE
  language_code: "DE_DE", # accepts DE_DE, EN_GB, EN_US, ES_419, ES_ES, FR_CA, FR_FR, IT_IT, JA_JP, KO_KR, PT_BR, ZH_CN, ZH_TW
  origination_identity: "VerificationMessageOriginationIdentity",
  configuration_set_name: "ConfigurationSetNameOrArn",
  context: {
    "ContextKey" => "ContextValue",
  },
  destination_country_parameters: {
    "IN_TEMPLATE_ID" => "DestinationCountryParameterValue",
  },
})

    
      
        
Response structure

      
      

resp.message_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :verified_destination_number_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the verified destination phone number.
    
          
        
    • 
      
        
  • 
          :verification_channel
          (required, String)
          
            
          
          
            — 
    Choose to send the verification code as an SMS or voice message.
    
          
        
    • 
      
        
  • 
          :language_code
          (String)
          
            
          
          
            — 
    Choose the language to use for the message.
    
          
        
    • 
      
        
  • 
          :origination_identity
          (String)
          
            
          
          
            — 
    The origination identity of the message. This can be either the
PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
PoolId, or PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :configuration_set_name
          (String)
          
            
          
          
            — 
    The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :context
          (Hash<String,String>)
          
            
          
          
            — 
    You can specify custom data in this field. If you do, that data is
logged to the event destination.
    
          
        
    • 
      
        
  • 
          :destination_country_parameters
          (Hash<String,String>)
          
            
          
          
            — 
    This field is used for any country-specific registration requirements.
Currently, this setting is only used when you send messages to
recipients in India using a sender ID. For more information see
Special requirements for sending SMS messages to recipients in
India.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1541

    		
    
      
# File 'sig/client.rbs', line 1541

def send_destination_number_verification_code: (

    		
  





    
      

  

  
    #send_media_message(params = {})  ⇒ Types::SendMediaMessageResult 
  

  

  


  

    
Creates a new multimedia message (MMS) and sends it to a recipient's
phone number.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.send_media_message({
  destination_phone_number: "PhoneNumber", # required
  origination_identity: "MediaMessageOriginationIdentity", # required
  message_body: "TextMessageBody",
  media_urls: ["MediaUrlValue"],
  configuration_set_name: "ConfigurationSetNameOrArn",
  max_price: "MaxPrice",
  time_to_live: 1,
  context: {
    "ContextKey" => "ContextValue",
  },
  dry_run: false,
  protect_configuration_id: "ProtectConfigurationIdOrArn",
  message_feedback_enabled: false,
})

    
      
        
Response structure

      
      

resp.message_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :destination_phone_number
          (required, String)
          
            
          
          
            — 
    The destination phone number in E.164 format.
    
          
        
    • 
      
        
  • 
          :origination_identity
          (required, String)
          
            
          
          
            — 
    The origination identity of the message. This can be either the
PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
PoolId, or PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :message_body
          (String)
          
            
          
          
            — 
    The text body of the message.
    
          
        
    • 
      
        
  • 
          :media_urls
          (Array<String>)
          
            
          
          
            — 
    An array of URLs to each media file to send.
    

    The media files have to be stored in an S3 bucket. Supported media
file formats are listed in MMS file types, size and character
limits. For more information on creating an S3 bucket and managing
objects, see Creating a bucket, Uploading objects in the
Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS
files in the Amazon Web Services End User Messaging SMS User
Guide.
    
          
        
    • 
      
        
  • 
          :configuration_set_name
          (String)
          
            
          
          
            — 
    The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :max_price
          (String)
          
            
          
          
            — 
    The maximum amount that you want to spend, in US dollars, per each MMS
message.
    
          
        
    • 
      
        
  • 
          :time_to_live
          (Integer)
          
            
          
          
            — 
    How long the media message is valid for. By default this is 72 hours.
    
          
        
    • 
      
        
  • 
          :context
          (Hash<String,String>)
          
            
          
          
            — 
    You can specify custom data in this field. If you do, that data is
logged to the event destination.
    
          
        
    • 
      
        
  • 
          :dry_run
          (Boolean)
          
            
          
          
            — 
    When set to true, the message is checked and validated, but isn't
sent to the end recipient.
    
          
        
    • 
      
        
  • 
          :protect_configuration_id
          (String)
          
            
          
          
            — 
    The unique identifier of the protect configuration to use.
    
          
        
    • 
      
        
  • 
          :message_feedback_enabled
          (Boolean)
          
            
          
          
            — 
    Set to true to enable message feedback for the message. When a user
receives the message you need to update the message status using
PutMessageFeedback.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1557

    		
    
      
# File 'sig/client.rbs', line 1557

def send_media_message: (

    		
  





    
      

  

  
    #send_notify_text_message(params = {})  ⇒ Types::SendNotifyTextMessageResult 
  

  

  


  

    
Sends a templated text message through a notify configuration to a
recipient's phone number.


  





  
  

    
Examples:

    
      
        
Example: SendNotifyTextMessage

      
      

# Send an OTP verification code via SMS using a notify configuration.

resp = client.send_notify_text_message({
  destination_phone_number: "+12065550100", 
  notify_configuration_id: "nc-1234567890abcdef0", 
  template_variables: {
    "code" => "123456", 
    "expiry" => "10", 
  }, 
})

resp.to_h outputs the following:
{
  message_id: "msg-1234567890abcdef0", 
  resolved_message_body: "Your verification code is 123456. It expires in 10 minutes.", 
  template_id: "nt-1234567890abcdef0", 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.send_notify_text_message({
  notify_configuration_id: "NotifyConfigurationIdOrArn", # required
  destination_phone_number: "PhoneNumber", # required
  template_id: "NotifyTemplateId",
  template_variables: { # required
    "TemplateVariableName" => "TemplateVariableValue",
  },
  time_to_live: 1,
  context: {
    "ContextKey" => "ContextValue",
  },
  configuration_set_name: "ConfigurationSetNameOrArn",
  dry_run: false,
  message_feedback_enabled: false,
})

    
      
        
Response structure

      
      

resp.message_id #=> String
resp.template_id #=> String
resp.resolved_message_body #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :notify_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier of the notify configuration to use for sending
the message. This can be either the NotifyConfigurationId or
NotifyConfigurationArn.
    
          
        
    • 
      
        
  • 
          :destination_phone_number
          (required, String)
          
            
          
          
            — 
    The destination phone number in E.164 format.
    
          
        
    • 
      
        
  • 
          :template_id
          (String)
          
            
          
          
            — 
    The unique identifier of the template to use for the message.
    
          
        
    • 
      
        
  • 
          :template_variables
          (required, Hash<String,String>)
          
            
          
          
            — 
    A map of template variable names and their values. All variable values
are passed as strings regardless of the declared variable type. For
example, pass INTEGER values as "42" and BOOLEAN values as
"true" or "false".
    
          
        
    • 
      
        
  • 
          :time_to_live
          (Integer)
          
            
          
          
            — 
    How long the text message is valid for, in seconds. By default this is
72 hours.
    
          
        
    • 
      
        
  • 
          :context
          (Hash<String,String>)
          
            
          
          
            — 
    You can specify custom data in this field. If you do, that data is
logged to the event destination.
    
          
        
    • 
      
        
  • 
          :configuration_set_name
          (String)
          
            
          
          
            — 
    The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :dry_run
          (Boolean)
          
            
          
          
            — 
    When set to true, the message is checked and validated, but isn't
sent to the end recipient.
    
          
        
    • 
      
        
  • 
          :message_feedback_enabled
          (Boolean)
          
            
          
          
            — 
    Set to true to enable message feedback for the message. When a user
receives the message you need to update the message status using
PutMessageFeedback.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1579

    		
    
      
# File 'sig/client.rbs', line 1579

def send_notify_text_message: (

    		
  





    
      

  

  
    #send_notify_voice_message(params = {})  ⇒ Types::SendNotifyVoiceMessageResult 
  

  

  


  

    
Sends a templated voice message through a notify configuration to a
recipient's phone number.


  





  
  

    
Examples:

    
      
        
Example: SendNotifyVoiceMessage

      
      

# Send an OTP verification code via voice call using a notify configuration.

resp = client.send_notify_voice_message({
  destination_phone_number: "+12065550100", 
  notify_configuration_id: "nc-1234567890abcdef0", 
  template_variables: {
    "code" => "123456", 
    "expiry" => "10", 
  }, 
  voice_id: "JOANNA", 
})

resp.to_h outputs the following:
{
  message_id: "msg-0987654321fedcba0", 
  resolved_message_body: "Your verification code is 123456. It expires in 10 minutes.", 
  template_id: "nt-1234567890abcdef0", 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.send_notify_voice_message({
  notify_configuration_id: "NotifyConfigurationIdOrArn", # required
  destination_phone_number: "PhoneNumber", # required
  template_id: "NotifyTemplateId",
  template_variables: { # required
    "TemplateVariableName" => "TemplateVariableValue",
  },
  voice_id: "AMY", # accepts AMY, ASTRID, BIANCA, BRIAN, CAMILA, CARLA, CARMEN, CELINE, CHANTAL, CONCHITA, CRISTIANO, DORA, EMMA, ENRIQUE, EWA, FILIZ, GERAINT, GIORGIO, GWYNETH, HANS, INES, IVY, JACEK, JAN, JOANNA, JOEY, JUSTIN, KARL, KENDRA, KIMBERLY, LEA, LIV, LOTTE, LUCIA, LUPE, MADS, MAJA, MARLENE, MATHIEU, MATTHEW, MAXIM, MIA, MIGUEL, MIZUKI, NAJA, NICOLE, PENELOPE, RAVEENA, RICARDO, RUBEN, RUSSELL, SALLI, SEOYEON, TAKUMI, TATYANA, VICKI, VITORIA, ZEINA, ZHIYU
  time_to_live: 1,
  context: {
    "ContextKey" => "ContextValue",
  },
  configuration_set_name: "ConfigurationSetNameOrArn",
  dry_run: false,
  message_feedback_enabled: false,
})

    
      
        
Response structure

      
      

resp.message_id #=> String
resp.template_id #=> String
resp.resolved_message_body #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :notify_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier of the notify configuration to use for sending
the message. This can be either the NotifyConfigurationId or
NotifyConfigurationArn.
    
          
        
    • 
      
        
  • 
          :destination_phone_number
          (required, String)
          
            
          
          
            — 
    The destination phone number in E.164 format.
    
          
        
    • 
      
        
  • 
          :template_id
          (String)
          
            
          
          
            — 
    The unique identifier of the template to use for the message.
    
          
        
    • 
      
        
  • 
          :template_variables
          (required, Hash<String,String>)
          
            
          
          
            — 
    A map of template variable names and their values. All variable values
are passed as strings regardless of the declared variable type. For
example, pass INTEGER values as "42" and BOOLEAN values as
"true" or "false".
    
          
        
    • 
      
        
  • 
          :voice_id
          (String)
          
            
          
          
            — 
    The voice ID to use for the voice message.
    
          
        
    • 
      
        
  • 
          :time_to_live
          (Integer)
          
            
          
          
            — 
    How long the voice message is valid for, in seconds. By default this
is 72 hours.
    
          
        
    • 
      
        
  • 
          :context
          (Hash<String,String>)
          
            
          
          
            — 
    You can specify custom data in this field. If you do, that data is
logged to the event destination.
    
          
        
    • 
      
        
  • 
          :configuration_set_name
          (String)
          
            
          
          
            — 
    The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :dry_run
          (Boolean)
          
            
          
          
            — 
    When set to true, the message is checked and validated, but isn't
sent to the end recipient.
    
          
        
    • 
      
        
  • 
          :message_feedback_enabled
          (Boolean)
          
            
          
          
            — 
    Set to true to enable message feedback for the message. When a user
receives the message you need to update the message status using
PutMessageFeedback.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1599

    		
    
      
# File 'sig/client.rbs', line 1599

def send_notify_voice_message: (

    		
  





    
      

  

  
    #send_rcs_message(params = {})  ⇒ Types::SendRcsMessageResult 
  

  

  


  

    
Creates a new RCS message and sends it to a recipient's phone number.
RCS messages support rich content including text, files, rich cards,
and carousels with interactive suggested actions.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.send_rcs_message({
  destination_phone_number: "PhoneNumber", # required
  origination_identity: "RcsMessageOriginationIdentity", # required
  rcs_message_content: {
    content: { # required
      text_message: {
        body: "RcsTextBody", # required
      },
      file_message: {
        file_url: "RcsMediaUrl", # required
        thumbnail_url: "RcsMediaUrl",
      },
      rich_card: {
        card_orientation: "RcsStandaloneCardCardOrientationString", # required
        thumbnail_image_alignment: "RcsStandaloneCardThumbnailImageAlignmentString",
        card_content: { # required
          title: "RcsCardTitle",
          description: "RcsCardDescription",
          media: {
            file_url: "RcsMediaUrl", # required
            thumbnail_url: "RcsMediaUrl",
            height: "RcsCardMediaHeightString",
          },
          suggestions: [
            {
              reply: {
                text: "RcsSuggestedActionText", # required
                postback_data: "RcsPostbackData", # required
              },
              open_url: {
                text: "RcsSuggestedActionText", # required
                postback_data: "RcsPostbackData", # required
                url: "RcsOpenUrlValue", # required
                application: "RcsOpenUrlActionApplicationString",
                webview_view_mode: "RcsOpenUrlActionWebviewViewModeString",
              },
              dial_phone: {
                text: "RcsSuggestedActionText", # required
                postback_data: "RcsPostbackData", # required
                phone_number: "PhoneNumber", # required
              },
              show_location: {
                text: "RcsSuggestedActionText", # required
                postback_data: "RcsPostbackData", # required
                latitude: 1.0, # required
                longitude: 1.0, # required
                label: "RcsLocationLabel",
              },
              request_location: {
                text: "RcsSuggestedActionText", # required
                postback_data: "RcsPostbackData", # required
              },
              create_calendar_event: {
                text: "RcsSuggestedActionText", # required
                postback_data: "RcsPostbackData", # required
                title: "RcsCalendarEventTitle", # required
                start_time: Time.now, # required
                end_time: Time.now, # required
                description: "RcsCalendarEventDescription",
              },
            },
          ],
        },
      },
      carousel: {
        card_width: "RcsCarouselCardWidthString", # required
        card_contents: [ # required
          {
            title: "RcsCardTitle",
            description: "RcsCardDescription",
            media: {
              file_url: "RcsMediaUrl", # required
              thumbnail_url: "RcsMediaUrl",
              height: "RcsCarouselCardMediaHeightString",
            },
            suggestions: [
              {
                reply: {
                  text: "RcsSuggestedActionText", # required
                  postback_data: "RcsPostbackData", # required
                },
                open_url: {
                  text: "RcsSuggestedActionText", # required
                  postback_data: "RcsPostbackData", # required
                  url: "RcsOpenUrlValue", # required
                  application: "RcsOpenUrlActionApplicationString",
                  webview_view_mode: "RcsOpenUrlActionWebviewViewModeString",
                },
                dial_phone: {
                  text: "RcsSuggestedActionText", # required
                  postback_data: "RcsPostbackData", # required
                  phone_number: "PhoneNumber", # required
                },
                show_location: {
                  text: "RcsSuggestedActionText", # required
                  postback_data: "RcsPostbackData", # required
                  latitude: 1.0, # required
                  longitude: 1.0, # required
                  label: "RcsLocationLabel",
                },
                request_location: {
                  text: "RcsSuggestedActionText", # required
                  postback_data: "RcsPostbackData", # required
                },
                create_calendar_event: {
                  text: "RcsSuggestedActionText", # required
                  postback_data: "RcsPostbackData", # required
                  title: "RcsCalendarEventTitle", # required
                  start_time: Time.now, # required
                  end_time: Time.now, # required
                  description: "RcsCalendarEventDescription",
                },
              },
            ],
          },
        ],
      },
    },
    suggestions: [
      {
        reply: {
          text: "RcsSuggestedActionText", # required
          postback_data: "RcsPostbackData", # required
        },
        open_url: {
          text: "RcsSuggestedActionText", # required
          postback_data: "RcsPostbackData", # required
          url: "RcsOpenUrlValue", # required
          application: "RcsOpenUrlActionApplicationString",
          webview_view_mode: "RcsOpenUrlActionWebviewViewModeString",
        },
        dial_phone: {
          text: "RcsSuggestedActionText", # required
          postback_data: "RcsPostbackData", # required
          phone_number: "PhoneNumber", # required
        },
        show_location: {
          text: "RcsSuggestedActionText", # required
          postback_data: "RcsPostbackData", # required
          latitude: 1.0, # required
          longitude: 1.0, # required
          label: "RcsLocationLabel",
        },
        request_location: {
          text: "RcsSuggestedActionText", # required
          postback_data: "RcsPostbackData", # required
        },
        create_calendar_event: {
          text: "RcsSuggestedActionText", # required
          postback_data: "RcsPostbackData", # required
          title: "RcsCalendarEventTitle", # required
          start_time: Time.now, # required
          end_time: Time.now, # required
          description: "RcsCalendarEventDescription",
        },
      },
    ],
  },
  time_to_live: 1,
  message_traffic_type: "RcsMessageTrafficType",
  fallback_configuration: {
    channel: "SMS", # required, accepts SMS, MMS
    message_body: "RcsFallbackMessageBody",
    media_urls: ["MediaUrlValue"],
    origination_identity: "RcsFallbackOriginationIdentity",
  },
  protect_configuration_id: "ProtectConfigurationIdOrArn",
  configuration_set_name: "ConfigurationSetNameOrArn",
  max_price: "MaxPrice",
  dry_run: false,
  context: {
    "ContextKey" => "ContextValue",
  },
  message_feedback_enabled: false,
})

    
      
        
Response structure

      
      

resp.message_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :destination_phone_number
          (required, String)
          
            
          
          
            — 
    The destination phone number in E.164 format.
    
          
        
    • 
      
        
  • 
          :origination_identity
          (required, String)
          
            
          
          
            — 
    The origination identity of the message. This can be either the
RcsAgentId, RcsAgentArn, PoolId, or PoolArn.
    
          
        
    • 
      
        
  • 
          :rcs_message_content
          (Types::RcsMessageContent)
          
            
          
          
            — 
    The content of the RCS message. Contains the message content (text,
file, rich card, or carousel) and optional message-level suggested
actions.
    
          
        
    • 
      
        
  • 
          :time_to_live
          (Integer)
          
            
          
          
            — 
    The duration in seconds that the RCS message is valid for delivery. If
the message cannot be delivered within this duration, it is considered
expired. Valid values are 1 to 172800 (48 hours). If a
FallbackConfiguration is provided, the fallback is triggered when the
duration expires without delivery confirmation.
    
          
        
    • 
      
        
  • 
          :message_traffic_type
          (String)
          
            
          
          
            — 
    The traffic type of the RCS message. Valid values are AUTHENTICATION,
TRANSACTION, PROMOTION, SERVICE_REQUEST, and ACKNOWLEDGEMENT. This
field is reserved for future use.
    
          
        
    • 
      
        
  • 
          :fallback_configuration
          (Types::RcsFallbackConfiguration)
          
            
          
          
            — 
    Configuration for SMS or MMS fallback when RCS delivery fails. If
provided, the service sends a fallback message via the specified
channel when the RCS message fails or the TimeToLive expires.
    
          
        
    • 
      
        
  • 
          :protect_configuration_id
          (String)
          
            
          
          
            — 
    The unique identifier of the protect configuration to use.
    
          
        
    • 
      
        
  • 
          :configuration_set_name
          (String)
          
            
          
          
            — 
    The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :max_price
          (String)
          
            
          
          
            — 
    The maximum amount that you want to spend, in US dollars, per each RCS
message.
    
          
        
    • 
      
        
  • 
          :dry_run
          (Boolean)
          
            
          
          
            — 
    When set to true, the message is checked and validated, but isn't
sent to the end recipient.
    
          
        
    • 
      
        
  • 
          :context
          (Hash<String,String>)
          
            
          
          
            — 
    You can specify custom data in this field. If you do, that data is
logged to the event destination.
    
          
        
    • 
      
        
  • 
          :message_feedback_enabled
          (Boolean)
          
            
          
          
            — 
    Set to true to enable message feedback for the message. When a user
receives the message you need to update the message status using
PutMessageFeedback.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1618

    		
    
      
# File 'sig/client.rbs', line 1618

def send_rcs_message: (

    		
  





    
      

  

  
    #send_text_message(params = {})  ⇒ Types::SendTextMessageResult 
  

  

  


  

    
Creates a new text message and sends it to a recipient's phone
number. SendTextMessage only sends an SMS message to one recipient
each time it is invoked.


SMS throughput limits are measured in Message Parts per Second (MPS).
Your MPS limit depends on the destination country of your messages, as
well as the type of phone number (origination number) that you use to
send the message. For more information about MPS, see Message Parts
per Second (MPS) limits in the End User Messaging SMS User
Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.send_text_message({
  destination_phone_number: "PhoneNumber", # required
  origination_identity: "TextMessageOriginationIdentity",
  message_body: "TextMessageBody",
  message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
  keyword: "Keyword",
  configuration_set_name: "ConfigurationSetNameOrArn",
  max_price: "MaxPrice",
  time_to_live: 1,
  context: {
    "ContextKey" => "ContextValue",
  },
  destination_country_parameters: {
    "IN_TEMPLATE_ID" => "DestinationCountryParameterValue",
  },
  dry_run: false,
  protect_configuration_id: "ProtectConfigurationIdOrArn",
  message_feedback_enabled: false,
})

    
      
        
Response structure

      
      

resp.message_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :destination_phone_number
          (required, String)
          
            
          
          
            — 
    The destination phone number in E.164 format.
    
          
        
    • 
      
        
  • 
          :origination_identity
          (String)
          
            
          
          
            — 
    The origination identity of the message. This can be either the
PhoneNumber, PhoneNumberId, PhoneNumberArn, RcsAgentId, RcsAgentArn,
SenderId, SenderIdArn, PoolId, or PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :message_body
          (String)
          
            
          
          
            — 
    The body of the text message.
    
          
        
    • 
      
        
  • 
          :message_type
          (String)
          
            
          
          
            — 
    The type of message. Valid values are for messages that are critical
or time-sensitive and PROMOTIONAL for messages that aren't critical
or time-sensitive.
    
          
        
    • 
      
        
  • 
          :keyword
          (String)
          
            
          
          
            — 
    When you register a short code in the US, you must specify a program
name. If you don’t have a US short code, omit this attribute.
    
          
        
    • 
      
        
  • 
          :configuration_set_name
          (String)
          
            
          
          
            — 
    The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :max_price
          (String)
          
            
          
          
            — 
    The maximum amount that you want to spend, in US dollars, per each
text message. If the calculated amount to send the text message is
greater than MaxPrice, the message is not sent and an error is
returned.
    
          
        
    • 
      
        
  • 
          :time_to_live
          (Integer)
          
            
          
          
            — 
    How long the text message is valid for, in seconds. By default this is
72 hours. If the messages isn't handed off before the TTL expires we
stop attempting to hand off the message and return TTL_EXPIRED
event.
    
          
        
    • 
      
        
  • 
          :context
          (Hash<String,String>)
          
            
          
          
            — 
    You can specify custom data in this field. If you do, that data is
logged to the event destination.
    
          
        
    • 
      
        
  • 
          :destination_country_parameters
          (Hash<String,String>)
          
            
          
          
            — 
    This field is used for any country-specific registration requirements.
Currently, this setting is only used when you send messages to
recipients in India using a sender ID. For more information see
Special requirements for sending SMS messages to recipients in
India.
    

      

    • 

      IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you
received after completing the sender ID registration process.
      

      • 

    • 

      IN_TEMPLATE_ID The template ID that you received after completing
the sender ID registration process.
      

      Make sure that the Template ID that you specify matches your message
template exactly. If your message doesn't match the template that
you provided during the registration process, the mobile carriers
might reject your message.
      

      • 

    
          
        
    • 
      
        
  • 
          :dry_run
          (Boolean)
          
            
          
          
            — 
    When set to true, the message is checked and validated, but isn't
sent to the end recipient. You are not charged for using DryRun.
    

    The Message Parts per Second (MPS) limit when using DryRun is five.
If your origination identity has a lower MPS limit then the lower MPS
limit is used. For more information about MPS limits, see Message
Parts per Second (MPS) limits in the End User Messaging SMS User
Guide..
    
          
        
    • 
      
        
  • 
          :protect_configuration_id
          (String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :message_feedback_enabled
          (Boolean)
          
            
          
          
            — 
    Set to true to enable message feedback for the message. When a user
receives the message you need to update the message status using
PutMessageFeedback.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1690

    		
    
      
# File 'sig/client.rbs', line 1690

def send_text_message: (

    		
  





    
      

  

  
    #send_voice_message(params = {})  ⇒ Types::SendVoiceMessageResult 
  

  

  


  

    
Allows you to send a request that sends a voice message. This
operation uses Amazon Polly to convert a text script into a voice
message.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.send_voice_message({
  destination_phone_number: "PhoneNumber", # required
  origination_identity: "VoiceMessageOriginationIdentity", # required
  message_body: "VoiceMessageBody",
  message_body_text_type: "TEXT", # accepts TEXT, SSML
  voice_id: "AMY", # accepts AMY, ASTRID, BIANCA, BRIAN, CAMILA, CARLA, CARMEN, CELINE, CHANTAL, CONCHITA, CRISTIANO, DORA, EMMA, ENRIQUE, EWA, FILIZ, GERAINT, GIORGIO, GWYNETH, HANS, INES, IVY, JACEK, JAN, JOANNA, JOEY, JUSTIN, KARL, KENDRA, KIMBERLY, LEA, LIV, LOTTE, LUCIA, LUPE, MADS, MAJA, MARLENE, MATHIEU, MATTHEW, MAXIM, MIA, MIGUEL, MIZUKI, NAJA, NICOLE, PENELOPE, RAVEENA, RICARDO, RUBEN, RUSSELL, SALLI, SEOYEON, TAKUMI, TATYANA, VICKI, VITORIA, ZEINA, ZHIYU
  configuration_set_name: "ConfigurationSetNameOrArn",
  max_price_per_minute: "MaxPrice",
  time_to_live: 1,
  context: {
    "ContextKey" => "ContextValue",
  },
  dry_run: false,
  protect_configuration_id: "ProtectConfigurationIdOrArn",
  message_feedback_enabled: false,
})

    
      
        
Response structure

      
      

resp.message_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :destination_phone_number
          (required, String)
          
            
          
          
            — 
    The destination phone number in E.164 format.
    
          
        
    • 
      
        
  • 
          :origination_identity
          (required, String)
          
            
          
          
            — 
    The origination identity to use for the voice call. This can be the
PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :message_body
          (String)
          
            
          
          
            — 
    The text to convert to a voice message.
    
          
        
    • 
      
        
  • 
          :message_body_text_type
          (String)
          
            
          
          
            — 
    Specifies if the MessageBody field contains text or speech synthesis
markup language (SSML).
    

      

    • 

      TEXT: This is the default value. When used the maximum character
limit is 3000.
      

      • 

    • 

      SSML: When used the maximum character limit is 6000 including SSML
tagging.
      

      • 

    
          
        
    • 
      
        
  • 
          :voice_id
          (String)
          
            
          
          
            — 
    The voice for the Amazon Polly service to use. By default this is
set to "MATTHEW".
    
          
        
    • 
      
        
  • 
          :configuration_set_name
          (String)
          
            
          
          
            — 
    The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :max_price_per_minute
          (String)
          
            
          
          
            — 
    The maximum amount to spend per voice message, in US dollars.
    
          
        
    • 
      
        
  • 
          :time_to_live
          (Integer)
          
            
          
          
            — 
    How long the voice message is valid for. By default this is 72 hours.
    
          
        
    • 
      
        
  • 
          :context
          (Hash<String,String>)
          
            
          
          
            — 
    You can specify custom data in this field. If you do, that data is
logged to the event destination.
    
          
        
    • 
      
        
  • 
          :dry_run
          (Boolean)
          
            
          
          
            — 
    When set to true, the message is checked and validated, but isn't
sent to the end recipient.
    
          
        
    • 
      
        
  • 
          :protect_configuration_id
          (String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :message_feedback_enabled
          (Boolean)
          
            
          
          
            — 
    Set to true to enable message feedback for the message. When a user
receives the message you need to update the message status using
PutMessageFeedback.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1712

    		
    
      
# File 'sig/client.rbs', line 1712

def send_voice_message: (

    		
  





    
      

  

  
    #set_account_default_protect_configuration(params = {})  ⇒ Types::SetAccountDefaultProtectConfigurationResult 
  

  

  


  

    
Set a protect configuration as your account default. You can only have
one account default protect configuration at a time. The current
account default protect configuration is replaced with the provided
protect configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.({
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
})

    
      
        
Response structure

      
      

resp.default_protect_configuration_arn #=> String
resp.default_protect_configuration_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1734

    		
    
      
# File 'sig/client.rbs', line 1734

def set_account_default_protect_configuration: (

    		
  





    
      

  

  
    #set_default_message_feedback_enabled(params = {})  ⇒ Types::SetDefaultMessageFeedbackEnabledResult 
  

  

  


  

    
Sets a configuration set's default for message feedback.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.set_default_message_feedback_enabled({
  configuration_set_name: "ConfigurationSetNameOrArn", # required
  message_feedback_enabled: false, # required
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.message_feedback_enabled #=> Boolean

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :message_feedback_enabled
          (required, Boolean)
          
            
          
          
            — 
    Set to true to enable message feedback.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1746

    		
    
      
# File 'sig/client.rbs', line 1746

def set_default_message_feedback_enabled: (

    		
  





    
      

  

  
    #set_default_message_type(params = {})  ⇒ Types::SetDefaultMessageTypeResult 
  

  

  


  

    
Sets the default message type on a configuration set.


Choose the category of SMS messages that you plan to send from this
account. If you send account-related messages or time-sensitive
messages such as one-time passcodes, choose Transactional. If you
plan to send messages that contain marketing material or other
promotional content, choose Promotional. This setting applies to
your entire Amazon Web Services account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.set_default_message_type({
  configuration_set_name: "ConfigurationSetNameOrArn", # required
  message_type: "TRANSACTIONAL", # required, accepts TRANSACTIONAL, PROMOTIONAL
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The configuration set to update with a new default message type. This
field can be the ConsigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :message_type
          (required, String)
          
            
          
          
            — 
    The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that
aren't critical or time-sensitive.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1759

    		
    
      
# File 'sig/client.rbs', line 1759

def set_default_message_type: (

    		
  





    
      

  

  
    #set_default_sender_id(params = {})  ⇒ Types::SetDefaultSenderIdResult 
  

  

  


  

    
Sets default sender ID on a configuration set.


When sending a text message to a destination country that supports
sender IDs, the default sender ID on the configuration set specified
will be used if no dedicated origination phone numbers or registered
sender IDs are available in your account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.set_default_sender_id({
  configuration_set_name: "ConfigurationSetNameOrArn", # required
  sender_id: "SenderId", # required
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.sender_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The configuration set to updated with a new default SenderId. This
field can be the ConsigurationSetName or ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :sender_id
          (required, String)
          
            
          
          
            — 
    The current sender ID for the configuration set. When sending a text
message to a destination country which supports SenderIds, the default
sender ID on the configuration set specified on SendTextMessage will
be used if no dedicated origination phone numbers or registered
SenderIds are available in your account, instead of a generic sender
ID, such as 'NOTICE'.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1772

    		
    
      
# File 'sig/client.rbs', line 1772

def set_default_sender_id: (

    		
  





    
      

  

  
    #set_media_message_spend_limit_override(params = {})  ⇒ Types::SetMediaMessageSpendLimitOverrideResult 
  

  

  


  

    
Sets an account level monthly spend limit override for sending MMS
messages. The requested spend limit must be less than or equal to the
MaxLimit, which is set by Amazon Web Services.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.set_media_message_spend_limit_override({
  monthly_limit: 1, # required
})

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :monthly_limit
          (required, Integer)
          
            
          
          
            — 
    The new monthly limit to enforce on text messages.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1783

    		
    
      
# File 'sig/client.rbs', line 1783

def set_media_message_spend_limit_override: (

    		
  





    
      

  

  
    #set_notify_message_spend_limit_override(params = {})  ⇒ Types::SetNotifyMessageSpendLimitOverrideResult 
  

  

  


  

    
Sets an account level monthly spend limit override for sending notify
messages. The requested spend limit must be less than or equal to the
MaxLimit, which is set by Amazon Web Services.


  





  
  

    
Examples:

    
      
        
Example: SetNotifyMessageSpendLimitOverride

      
      

# Set a monthly spend limit override for notify messages.

resp = client.set_notify_message_spend_limit_override({
  monthly_limit: 1000, 
})

resp.to_h outputs the following:
{
  monthly_limit: 1000, 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.set_notify_message_spend_limit_override({
  monthly_limit: 1, # required
})

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :monthly_limit
          (required, Integer)
          
            
          
          
            — 
    The new monthly limit to enforce on notify messages.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1793

    		
    
      
# File 'sig/client.rbs', line 1793

def set_notify_message_spend_limit_override: (

    		
  





    
      

  

  
    #set_rcs_message_spend_limit_override(params = {})  ⇒ Types::SetRcsMessageSpendLimitOverrideResult 
  

  

  


  

    
Sets an account level monthly spend limit override for sending RCS
messages. The requested spend limit must be less than or equal to the
MaxLimit, which is set by Amazon Web Services.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.set_rcs_message_spend_limit_override({
  monthly_limit: 1, # required
})

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :monthly_limit
          (required, Integer)
          
            
          
          
            — 
    The new monthly limit to enforce on RCS message spending.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1803

    		
    
      
# File 'sig/client.rbs', line 1803

def set_rcs_message_spend_limit_override: (

    		
  





    
      

  

  
    #set_text_message_spend_limit_override(params = {})  ⇒ Types::SetTextMessageSpendLimitOverrideResult 
  

  

  


  

    
Sets an account level monthly spend limit override for sending text
messages. The requested spend limit must be less than or equal to the
MaxLimit, which is set by Amazon Web Services.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.set_text_message_spend_limit_override({
  monthly_limit: 1, # required
})

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :monthly_limit
          (required, Integer)
          
            
          
          
            — 
    The new monthly limit to enforce on text messages.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1813

    		
    
      
# File 'sig/client.rbs', line 1813

def set_text_message_spend_limit_override: (

    		
  





    
      

  

  
    #set_voice_message_spend_limit_override(params = {})  ⇒ Types::SetVoiceMessageSpendLimitOverrideResult 
  

  

  


  

    
Sets an account level monthly spend limit override for sending voice
messages. The requested spend limit must be less than or equal to the
MaxLimit, which is set by Amazon Web Services.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.set_voice_message_spend_limit_override({
  monthly_limit: 1, # required
})

    
      
        
Response structure

      
      

resp.monthly_limit #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :monthly_limit
          (required, Integer)
          
            
          
          
            — 
    The new monthly limit to enforce on voice messages.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1823

    		
    
      
# File 'sig/client.rbs', line 1823

def set_voice_message_spend_limit_override: (

    		
  





    
      

  

  
    #submit_registration_version(params = {})  ⇒ Types::SubmitRegistrationVersionResult 
  

  

  


  

    
Submit the specified registration for review and approval.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.submit_registration_version({
  registration_id: "RegistrationIdOrArn", # required
  aws_review: false,
})

    
      
        
Response structure

      
      

resp.registration_arn #=> String
resp.registration_id #=> String
resp.version_number #=> Integer
resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "AWS_REVIEWING", "REVIEWING", "REQUIRES_AUTHENTICATION", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED", "REQUIRES_OFFLINE_REVIEW"
resp.registration_version_status_history.draft_timestamp #=> Time
resp.registration_version_status_history.submitted_timestamp #=> Time
resp.registration_version_status_history.aws_reviewing_timestamp #=> Time
resp.registration_version_status_history.reviewing_timestamp #=> Time
resp.registration_version_status_history.requires_authentication_timestamp #=> Time
resp.registration_version_status_history.approved_timestamp #=> Time
resp.registration_version_status_history.discarded_timestamp #=> Time
resp.registration_version_status_history.denied_timestamp #=> Time
resp.registration_version_status_history.revoked_timestamp #=> Time
resp.registration_version_status_history.archived_timestamp #=> Time
resp.aws_review #=> Boolean

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :registration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the registration.
    
          
        
    • 
      
        
  • 
          :aws_review
          (Boolean)
          
            
          
          
            — 
    Set to true to request AWS review of the registration. When enabled,
AWS will perform additional validation and review of the registration
submission before processing.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1838

    		
    
      
# File 'sig/client.rbs', line 1838

def submit_registration_version: (

    		
  





    
      

  

  
    #tag_resource(params = {})  ⇒ Struct 
  

  

  


  

    
Adds or overwrites only the specified tags for the specified resource.
When you specify an existing tag key, the value is overwritten with
the new value. Each tag consists of a key and an optional value. Tag
keys must be unique per resource. For more information about tags, see
Tags  in the End User Messaging SMS User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the resource.
    
          
        
    • 
      
        
  • 
          :tags
          (required, Array<Types::Tag>)
          
            
          
          
            — 
    An array of key and value pair tags that are associated with the
resource.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1848

    		
    
      
# File 'sig/client.rbs', line 1848

def tag_resource: (

    		
  





    
      

  

  
    #untag_resource(params = {})  ⇒ Struct 
  

  

  


  

    
Removes the association of the specified tags from a resource. For
more information on tags see Tags  in the End User Messaging SMS
User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the resource.
    
          
        
    • 
      
        
  • 
          :tag_keys
          (required, Array<String>)
          
            
          
          
            — 
    An array of tag key values to unassociate with the resource.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1863

    		
    
      
# File 'sig/client.rbs', line 1863

def untag_resource: (

    		
  





    
      

  

  
    #update_event_destination(params = {})  ⇒ Types::UpdateEventDestinationResult 
  

  

  


  

    
Updates an existing event destination in a configuration set. You can
update the IAM role ARN for CloudWatch Logs and Firehose. You can also
enable or disable the event destination.


You may want to update an event destination to change its matching
event types or updating the destination resource ARN. You can't
change an event destination's type between CloudWatch Logs, Firehose,
and Amazon SNS.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_event_destination({
  configuration_set_name: "ConfigurationSetNameOrArn", # required
  event_destination_name: "EventDestinationName", # required
  enabled: false,
  matching_event_types: ["ALL"], # accepts ALL, TEXT_ALL, TEXT_SENT, TEXT_PENDING, TEXT_QUEUED, TEXT_SUCCESSFUL, TEXT_DELIVERED, TEXT_INVALID, TEXT_INVALID_MESSAGE, TEXT_UNREACHABLE, TEXT_CARRIER_UNREACHABLE, TEXT_BLOCKED, TEXT_CARRIER_BLOCKED, TEXT_SPAM, TEXT_UNKNOWN, TEXT_TTL_EXPIRED, TEXT_PROTECT_BLOCKED, VOICE_ALL, VOICE_INITIATED, VOICE_RINGING, VOICE_ANSWERED, VOICE_COMPLETED, VOICE_BUSY, VOICE_NO_ANSWER, VOICE_FAILED, VOICE_TTL_EXPIRED, MEDIA_ALL, MEDIA_PENDING, MEDIA_QUEUED, MEDIA_SUCCESSFUL, MEDIA_DELIVERED, MEDIA_INVALID, MEDIA_INVALID_MESSAGE, MEDIA_UNREACHABLE, MEDIA_CARRIER_UNREACHABLE, MEDIA_BLOCKED, MEDIA_CARRIER_BLOCKED, MEDIA_SPAM, MEDIA_UNKNOWN, MEDIA_TTL_EXPIRED, MEDIA_FILE_INACCESSIBLE, MEDIA_FILE_TYPE_UNSUPPORTED, MEDIA_FILE_SIZE_EXCEEDED, RCS_ALL, RCS_QUEUED, RCS_SENT, RCS_DELIVERED, RCS_READ, RCS_FAILED, RCS_TTL_EXPIRED, RCS_PROTECT_BLOCKED, RCS_FALLEN_BACK_TO_SMS
  cloud_watch_logs_destination: {
    iam_role_arn: "IamRoleArn", # required
    log_group_arn: "LogGroupArn", # required
  },
  kinesis_firehose_destination: {
    iam_role_arn: "IamRoleArn", # required
    delivery_stream_arn: "DeliveryStreamArn", # required
  },
  sns_destination: {
    topic_arn: "SnsTopicArn", # required
  },
})

    
      
        
Response structure

      
      

resp.configuration_set_arn #=> String
resp.configuration_set_name #=> String
resp.event_destination.event_destination_name #=> String
resp.event_destination.enabled #=> Boolean
resp.event_destination.matching_event_types #=> Array
resp.event_destination.matching_event_types[0] #=> String, one of "ALL", "TEXT_ALL", "TEXT_SENT", "TEXT_PENDING", "TEXT_QUEUED", "TEXT_SUCCESSFUL", "TEXT_DELIVERED", "TEXT_INVALID", "TEXT_INVALID_MESSAGE", "TEXT_UNREACHABLE", "TEXT_CARRIER_UNREACHABLE", "TEXT_BLOCKED", "TEXT_CARRIER_BLOCKED", "TEXT_SPAM", "TEXT_UNKNOWN", "TEXT_TTL_EXPIRED", "TEXT_PROTECT_BLOCKED", "VOICE_ALL", "VOICE_INITIATED", "VOICE_RINGING", "VOICE_ANSWERED", "VOICE_COMPLETED", "VOICE_BUSY", "VOICE_NO_ANSWER", "VOICE_FAILED", "VOICE_TTL_EXPIRED", "MEDIA_ALL", "MEDIA_PENDING", "MEDIA_QUEUED", "MEDIA_SUCCESSFUL", "MEDIA_DELIVERED", "MEDIA_INVALID", "MEDIA_INVALID_MESSAGE", "MEDIA_UNREACHABLE", "MEDIA_CARRIER_UNREACHABLE", "MEDIA_BLOCKED", "MEDIA_CARRIER_BLOCKED", "MEDIA_SPAM", "MEDIA_UNKNOWN", "MEDIA_TTL_EXPIRED", "MEDIA_FILE_INACCESSIBLE", "MEDIA_FILE_TYPE_UNSUPPORTED", "MEDIA_FILE_SIZE_EXCEEDED", "RCS_ALL", "RCS_QUEUED", "RCS_SENT", "RCS_DELIVERED", "RCS_READ", "RCS_FAILED", "RCS_TTL_EXPIRED", "RCS_PROTECT_BLOCKED", "RCS_FALLEN_BACK_TO_SMS"
resp.event_destination.cloud_watch_logs_destination.iam_role_arn #=> String
resp.event_destination.cloud_watch_logs_destination.log_group_arn #=> String
resp.event_destination.kinesis_firehose_destination.iam_role_arn #=> String
resp.event_destination.kinesis_firehose_destination.delivery_stream_arn #=> String
resp.event_destination.sns_destination.topic_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :configuration_set_name
          (required, String)
          
            
          
          
            — 
    The configuration set to update with the new event destination. Valid
values for this can be the ConfigurationSetName or
ConfigurationSetArn.
    
          
        
    • 
      
        
  • 
          :event_destination_name
          (required, String)
          
            
          
          
            — 
    The name to use for the event destination.
    
          
        
    • 
      
        
  • 
          :enabled
          (Boolean)
          
            
          
          
            — 
    When set to true logging is enabled.
    
          
        
    • 
      
        
  • 
          :matching_event_types
          (Array<String>)
          
            
          
          
            — 
    An array of event types that determine which events to log.
    

     The TEXT_SENT event type is not supported.
    
 
    
          
        
    • 
      
        
  • 
          :cloud_watch_logs_destination
          (Types::CloudWatchLogsDestination)
          
            
          
          
            — 
    An object that contains information about an event destination that
sends data to CloudWatch Logs.
    
          
        
    • 
      
        
  • 
          :kinesis_firehose_destination
          (Types::KinesisFirehoseDestination)
          
            
          
          
            — 
    An object that contains information about an event destination for
logging to Firehose.
    
          
        
    • 
      
        
  • 
          :sns_destination
          (Types::SnsDestination)
          
            
          
          
            — 
    An object that contains information about an event destination that
sends data to Amazon SNS.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1876

    		
    
      
# File 'sig/client.rbs', line 1876

def update_event_destination: (

    		
  





    
      

  

  
    #update_notify_configuration(params = {})  ⇒ Types::UpdateNotifyConfigurationResult 
  

  

  


  

    
Updates an existing notify configuration. You can update the default
template, pool association, enabled channels, enabled countries, and
deletion protection settings.


  





  
  

    
Examples:

    
      
        
Example: UpdateNotifyConfiguration

      
      

# Update a notify configuration to add voice channel and additional countries.

resp = client.update_notify_configuration({
  deletion_protection_enabled: true, 
  enabled_channels: [
    "SMS", 
    "VOICE", 
  ], 
  enabled_countries: [
    "US", 
    "CA", 
    "GB", 
  ], 
  notify_configuration_id: "nc-1234567890abcdef0", 
})

resp.to_h outputs the following:
{
  created_timestamp: Time.parse(1704067200), 
  deletion_protection_enabled: true, 
  display_name: "MyOTPConfig", 
  enabled_channels: [
    "SMS", 
    "VOICE", 
  ], 
  enabled_countries: [
    "US", 
    "CA", 
    "GB", 
  ], 
  notify_configuration_arn: "arn:aws:sms-voice:us-east-1:111122223333:notify-configuration/nc-1234567890abcdef0", 
  notify_configuration_id: "nc-1234567890abcdef0", 
  status: "ACTIVE", 
  tier: "BASIC", 
  tier_upgrade_status: "BASIC", 
  use_case: "CODE_VERIFICATION", 
}

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_notify_configuration({
  notify_configuration_id: "NotifyConfigurationIdOrArn", # required
  default_template_id: "NotifyTemplateId",
  pool_id: "NotifyPoolIdOrUnset",
  enabled_countries: ["IsoCountryCode"],
  enabled_channels: ["SMS"], # accepts SMS, VOICE, MMS, RCS
  deletion_protection_enabled: false,
})

    
      
        
Response structure

      
      

resp.notify_configuration_arn #=> String
resp.notify_configuration_id #=> String
resp.display_name #=> String
resp.use_case #=> String, one of "CODE_VERIFICATION"
resp.default_template_id #=> String
resp.pool_id #=> String
resp.enabled_countries #=> Array
resp.enabled_countries[0] #=> String
resp.enabled_channels #=> Array
resp.enabled_channels[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.tier #=> String, one of "BASIC", "ADVANCED"
resp.tier_upgrade_status #=> String, one of "BASIC", "PENDING_UPGRADE", "ADVANCED", "REJECTED"
resp.status #=> String, one of "PENDING", "ACTIVE", "REJECTED", "REQUIRES_VERIFICATION"
resp.rejection_reason #=> String
resp.deletion_protection_enabled #=> Boolean
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :notify_configuration_id
          (required, String)
          
            
          
          
            — 
    The identifier of the notify configuration to update. The
NotifyConfigurationId can be found using the
DescribeNotifyConfigurations operation.
    
          
        
    • 
      
        
  • 
          :default_template_id
          (String)
          
            
          
          
            — 
    The default template identifier to associate with the notify
configuration. If specified, this template is used when sending
messages without an explicit template identifier. Pass the special
value UNSET_DEFAULT_TEMPLATE to clear the current default template
from the notify configuration.
    
          
        
    • 
      
        
  • 
          :pool_id
          (String)
          
            
          
          
            — 
    The pool identifier or Amazon Resource Name (ARN) to associate with
the notify configuration. Pass the special value
UNSET_DEFAULT_POOL_FOR_NOTIFY to clear the current default pool from
the notify configuration.
    
          
        
    • 
      
        
  • 
          :enabled_countries
          (Array<String>)
          
            
          
          
            — 
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2
format, that are enabled for the notify configuration.
    
          
        
    • 
      
        
  • 
          :enabled_channels
          (Array<String>)
          
            
          
          
            — 
    An array of channels to enable for the notify configuration. Supported
values include SMS and VOICE.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    When set to true the notify configuration can't be deleted.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1913

    		
    
      
# File 'sig/client.rbs', line 1913

def update_notify_configuration: (

    		
  





    
      

  

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

  

  


  

    
Updates the configuration of an existing origination phone number. You
can update the opt-out list, enable or disable two-way messaging,
change the TwoWayChannelArn, enable or disable self-managed opt-outs,
and enable or disable deletion protection.


If the origination phone number is associated with a pool, an error is
returned.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_phone_number({
  phone_number_id: "PhoneNumberIdOrArn", # required
  two_way_enabled: false,
  two_way_channel_arn: "TwoWayChannelArn",
  two_way_channel_role: "IamRoleArn",
  self_managed_opt_outs_enabled: false,
  opt_out_list_name: "OptOutListNameOrArn",
  international_sending_enabled: false,
  deletion_protection_enabled: false,
})

    
      
        
Response structure

      
      

resp.phone_number_arn #=> String
resp.phone_number_id #=> String
resp.phone_number #=> String
resp.status #=> String, one of "PENDING", "ACTIVE", "ASSOCIATING", "DISASSOCIATING", "DELETED"
resp.iso_country_code #=> String
resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.number_capabilities #=> Array
resp.number_capabilities[0] #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.number_type #=> String, one of "SHORT_CODE", "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR"
resp.monthly_leasing_price #=> String
resp.two_way_enabled #=> Boolean
resp.two_way_channel_arn #=> String
resp.two_way_channel_role #=> String
resp.self_managed_opt_outs_enabled #=> Boolean
resp.opt_out_list_name #=> String
resp.international_sending_enabled #=> Boolean
resp.deletion_protection_enabled #=> Boolean
resp.registration_id #=> String
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :phone_number_id
          (required, String)
          
            
          
          
            — 
    The unique identifier of the phone number. Valid values for this field
can be either the PhoneNumberId or PhoneNumberArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :two_way_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
    
          
        
    • 
      
        
  • 
          :two_way_channel_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the two way channel.
    
          
        
    • 
      
        
  • 
          :two_way_channel_role
          (String)
          
            
          
          
            — 
    An optional IAM Role Arn for a service to assume, to be able to post
inbound SMS messages.
    
          
        
    • 
      
        
  • 
          :self_managed_opt_outs_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to false and an end
recipient sends a message that begins with HELP or STOP to one of your
dedicated numbers, End User Messaging SMS automatically replies with a
customizable message and adds the end recipient to the OptOutList.
When set to true you're responsible for responding to HELP and STOP
requests. You're also responsible for tracking and honoring opt-out
requests.
    
          
        
    • 
      
        
  • 
          :opt_out_list_name
          (String)
          
            
          
          
            — 
    The OptOutList to add the phone number to. You can use either the opt
out list name or the opt out list ARN.
    
          
        
    • 
      
        
  • 
          :international_sending_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the international
sending of phone number is Enabled.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the phone number
can't be deleted.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1945

    		
    
      
# File 'sig/client.rbs', line 1945

def update_phone_number: (

    		
  





    
      

  

  
    #update_pool(params = {})  ⇒ Types::UpdatePoolResult 
  

  

  


  

    
Updates the configuration of an existing pool. You can update the
opt-out list, enable or disable two-way messaging, change the
TwoWayChannelArn, enable or disable self-managed opt-outs, enable or
disable deletion protection, and enable or disable shared routes.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_pool({
  pool_id: "PoolIdOrArn", # required
  two_way_enabled: false,
  two_way_channel_arn: "TwoWayChannelArn",
  two_way_channel_role: "IamRoleArn",
  self_managed_opt_outs_enabled: false,
  opt_out_list_name: "OptOutListNameOrArn",
  shared_routes_enabled: false,
  deletion_protection_enabled: false,
})

    
      
        
Response structure

      
      

resp.pool_arn #=> String
resp.pool_id #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING"
resp.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.two_way_enabled #=> Boolean
resp.two_way_channel_arn #=> String
resp.two_way_channel_role #=> String
resp.self_managed_opt_outs_enabled #=> Boolean
resp.opt_out_list_name #=> String
resp.shared_routes_enabled #=> Boolean
resp.deletion_protection_enabled #=> Boolean
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :pool_id
          (required, String)
          
            
          
          
            — 
    The unique identifier of the pool to update. Valid values are either
the PoolId or PoolArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :two_way_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
    
          
        
    • 
      
        
  • 
          :two_way_channel_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the two way channel.
    
          
        
    • 
      
        
  • 
          :two_way_channel_role
          (String)
          
            
          
          
            — 
    An optional IAM Role Arn for a service to assume, to be able to post
inbound SMS messages.
    
          
        
    • 
      
        
  • 
          :self_managed_opt_outs_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to false and an end
recipient sends a message that begins with HELP or STOP to one of your
dedicated numbers, End User Messaging SMS automatically replies with a
customizable message and adds the end recipient to the OptOutList.
When set to true you're responsible for responding to HELP and STOP
requests. You're also responsible for tracking and honoring opt-out
requests.
    
          
        
    • 
      
        
  • 
          :opt_out_list_name
          (String)
          
            
          
          
            — 
    The OptOutList to associate with the pool. Valid values are either
OptOutListName or OptOutListArn.
    

    If you are using a shared End User Messaging SMS resource then you
must use the full Amazon Resource Name(ARN).
    
          
        
    • 
      
        
  • 
          :shared_routes_enabled
          (Boolean)
          
            
          
          
            — 
    Indicates whether shared routes are enabled for the pool.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    When set to true the pool can't be deleted.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1973

    		
    
      
# File 'sig/client.rbs', line 1973

def update_pool: (

    		
  





    
      

  

  
    #update_protect_configuration(params = {})  ⇒ Types::UpdateProtectConfigurationResult 
  

  

  


  

    
Update the setting for an existing protect configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_protect_configuration({
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
  deletion_protection_enabled: false,
})

    
      
        
Response structure

      
      

resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String
resp.created_timestamp #=> Time
resp. #=> Boolean
resp.deletion_protection_enabled #=> Boolean

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    When set to true deletion protection is enabled. By default this is
set to false.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1994

    		
    
      
# File 'sig/client.rbs', line 1994

def update_protect_configuration: (

    		
  





    
      

  

  
    #update_protect_configuration_country_rule_set(params = {})  ⇒ Types::UpdateProtectConfigurationCountryRuleSetResult 
  

  

  


  

    
Update a country rule set to ALLOW, BLOCK, MONITOR, or FILTER
messages to be sent to the specified destination counties. You can
update one or multiple countries at a time. The updates are only
applied to the specified NumberCapability type.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_protect_configuration_country_rule_set({
  protect_configuration_id: "ProtectConfigurationIdOrArn", # required
  number_capability: "SMS", # required, accepts SMS, VOICE, MMS, RCS
  country_rule_set_updates: { # required
    "IsoCountryCode" => {
      protect_status: "ALLOW", # required, accepts ALLOW, BLOCK, MONITOR, FILTER
    },
  },
})

    
      
        
Response structure

      
      

resp.protect_configuration_arn #=> String
resp.protect_configuration_id #=> String
resp.number_capability #=> String, one of "SMS", "VOICE", "MMS", "RCS"
resp.country_rule_set #=> Hash
resp.country_rule_set["IsoCountryCode"].protect_status #=> String, one of "ALLOW", "BLOCK", "MONITOR", "FILTER"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :protect_configuration_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the protect configuration.
    
          
        
    • 
      
        
  • 
          :number_capability
          (required, String)
          
            
          
          
            — 
    The number capability to apply the CountryRuleSetUpdates updates to.
    
          
        
    • 
      
        
  • 
          :country_rule_set_updates
          (required, Hash<String,Types::ProtectConfigurationCountryRuleSetInformation>)
          
            
          
          
            — 
    A map of ProtectConfigurationCountryRuleSetInformation objects that
contain the details for the requested NumberCapability. The Key is the
two-letter ISO country code. For a list of supported ISO country
codes, see Supported countries and regions (SMS channel) in the
End User Messaging SMS User Guide.
    

    For example, to set the United States as allowed and Canada as
blocked, the CountryRuleSetUpdates would be formatted as:
"CountryRuleSetUpdates": { "US" : { "ProtectStatus": "ALLOW" } "CA" : { "ProtectStatus": "BLOCK" } }
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


2008

    		
    
      
# File 'sig/client.rbs', line 2008

def update_protect_configuration_country_rule_set: (

    		
  





    
      

  

  
    #update_rcs_agent(params = {})  ⇒ Types::UpdateRcsAgentResult 
  

  

  


  

    
Updates the configuration of an existing RCS agent. You can update the
opt-out list, deletion protection, two-way messaging settings, and
self-managed opt-outs configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_rcs_agent({
  rcs_agent_id: "RcsAgentIdOrArn", # required
  deletion_protection_enabled: false,
  opt_out_list_name: "OptOutListNameOrArn",
  self_managed_opt_outs_enabled: false,
  two_way_channel_arn: "TwoWayChannelArn",
  two_way_channel_role: "IamRoleArn",
  two_way_enabled: false,
  two_way_media_s3_bucket_name: "TwoWayMediaS3BucketNameOrUnset",
  two_way_media_s3_key_prefix: "TwoWayMediaS3KeyPrefix",
  two_way_media_s3_role: "IamRoleArnOrUnset",
  two_way_rcs_events_enabled: ["RcsEventType"],
})

    
      
        
Response structure

      
      

resp.rcs_agent_arn #=> String
resp.rcs_agent_id #=> String
resp.status #=> String, one of "CREATED", "PENDING", "TESTING", "PARTIAL", "ACTIVE", "DELETED"
resp.created_timestamp #=> Time
resp.deletion_protection_enabled #=> Boolean
resp.opt_out_list_name #=> String
resp.self_managed_opt_outs_enabled #=> Boolean
resp.two_way_channel_arn #=> String
resp.two_way_channel_role #=> String
resp.two_way_enabled #=> Boolean
resp.two_way_media_s3_bucket_name #=> String
resp.two_way_media_s3_key_prefix #=> String
resp.two_way_media_s3_role #=> String
resp.two_way_rcs_events_enabled #=> Array
resp.two_way_rcs_events_enabled[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :rcs_agent_id
          (required, String)
          
            
          
          
            — 
    The unique identifier of the RCS agent to update. You can use either
the RcsAgentId or RcsAgentArn.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the RCS agent can't
be deleted.
    
          
        
    • 
      
        
  • 
          :opt_out_list_name
          (String)
          
            
          
          
            — 
    The OptOutList to associate with the RCS agent. Valid values are
either OptOutListName or OptOutListArn.
    
          
        
    • 
      
        
  • 
          :self_managed_opt_outs_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true you're responsible
for responding to HELP and STOP requests. You're also responsible for
tracking and honoring opt-out requests.
    
          
        
    • 
      
        
  • 
          :two_way_channel_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the two way channel.
    
          
        
    • 
      
        
  • 
          :two_way_channel_role
          (String)
          
            
          
          
            — 
    An optional IAM Role Arn for a service to assume, to be able to post
inbound SMS messages.
    
          
        
    • 
      
        
  • 
          :two_way_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
    
          
        
    • 
      
        
  • 
          :two_way_media_s3_bucket_name
          (String)
          
            
          
          
            — 
    The name of the S3 bucket where inbound RCS media files are stored.
Two-way messaging must be enabled on the agent. To remove the media
configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION
for both this field and TwoWayMediaS3Role.
    
          
        
    • 
      
        
  • 
          :two_way_media_s3_key_prefix
          (String)
          
            
          
          
            — 
    The key prefix used for inbound RCS media objects in the S3 bucket.
    
          
        
    • 
      
        
  • 
          :two_way_media_s3_role
          (String)
          
            
          
          
            — 
    The ARN of the IAM role used to write inbound RCS media files to the
S3 bucket. The role must have s3:PutObject permission on the bucket
and a trust policy allowing sms-voice.amazonaws.com to assume it. To
remove the media configuration, pass the sentinel value
UNSET_RCS_MEDIA_CONFIGURATION for both this field and
TwoWayMediaS3BucketName.
    
          
        
    • 
      
        
  • 
          :two_way_rcs_events_enabled
          (Array<String>)
          
            
          
          
            — 
    The list of RCS event types to enable for two-way messaging. Pass an
empty list to disable all event types. The special value ALL enables
all current and future event types and must be the sole element if
used.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


2035

    		
    
      
# File 'sig/client.rbs', line 2035

def update_rcs_agent: (

    		
  





    
      

  

  
    #update_sender_id(params = {})  ⇒ Types::UpdateSenderIdResult 
  

  

  


  

    
Updates the configuration of an existing sender ID.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_sender_id({
  sender_id: "SenderIdOrArn", # required
  iso_country_code: "IsoCountryCode", # required
  deletion_protection_enabled: false,
})

    
      
        
Response structure

      
      

resp.sender_id_arn #=> String
resp.sender_id #=> String
resp.iso_country_code #=> String
resp.message_types #=> Array
resp.message_types[0] #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.monthly_leasing_price #=> String
resp.deletion_protection_enabled #=> Boolean
resp.registered #=> Boolean
resp.registration_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :sender_id
          (required, String)
          
            
          
          
            — 
    The sender ID to update.
    
          
        
    • 
      
        
  • 
          :iso_country_code
          (required, String)
          
            
          
          
            — 
    The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region.
    
          
        
    • 
      
        
  • 
          :deletion_protection_enabled
          (Boolean)
          
            
          
          
            — 
    By default this is set to false. When set to true the sender ID can't
be deleted.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


2062

    		
    
      
# File 'sig/client.rbs', line 2062

def update_sender_id: (

    		
  





    
      

  

  
    #verify_destination_number(params = {})  ⇒ Types::VerifyDestinationNumberResult 
  

  

  


  

    
Use the verification code that was received by the verified
destination phone number to opt-in the verified destination phone
number to receive more messages.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.verify_destination_number({
  verified_destination_number_id: "VerifiedDestinationNumberIdOrArn", # required
  verification_code: "VerificationCode", # required
})

    
      
        
Response structure

      
      

resp.verified_destination_number_arn #=> String
resp.verified_destination_number_id #=> String
resp.destination_phone_number #=> String
resp.status #=> String, one of "PENDING", "VERIFIED", "UNSUPPORTED"
resp.created_timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :verified_destination_number_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the verififed destination phone number.
    
          
        
    • 
      
        
  • 
          :verification_code
          (required, String)
          
            
          
          
            — 
    The verification code that was received by the verified destination
phone number.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


2078

    		
    
      
# File 'sig/client.rbs', line 2078

def verify_destination_number: (

    		
  





    
      

  

  
    #waiter_names  ⇒ Object 
  

  

  


  

    

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



Deprecated. 



  





  



  

    
      


7682
7683
7684

    		
    
      
# File 'lib/aws-sdk-pinpointsmsvoicev2/client.rb', line 7682

def waiter_names
  []
end