Class: Aws::PinpointSMSVoiceV2::Types::RequestPhoneNumberRequest

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::RequestPhoneNumberRequest

Defined in:

gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #deletion_protection_enabled ⇒ Boolean

  By default this is set to false.

• #international_sending_enabled ⇒ Boolean

  By default this is set to false.

• #iso_country_code ⇒ String

  The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

• #message_type ⇒ String

  The type of message.

• #number_capabilities ⇒ Array<String>

  Indicates if the phone number will be used for text messages, voice messages, or both.

• #number_preference ⇒ Array<Types::NumberPreferenceItem>

  An optional selection preference used to request a specific phone number, such as a number that starts with, ends with, or contains a particular digit pattern.

• #number_type ⇒ String

  The type of phone number to request.

• #opt_out_list_name ⇒ String

  The name of the OptOutList to associate with the phone number.

• #pool_id ⇒ String

  The pool to associated with the phone number.

• #registration_id ⇒ String

  Use this field to attach your phone number for an external registration process.

• #tags ⇒ Array<Types::Tag>

  An array of tags (key and value pairs) to associate with the requested phone number.

Instance Attribute Details

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

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ Boolean

By default this is set to false. When set to true the phone number can't be deleted.

Returns:

• (Boolean)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#international_sending_enabled ⇒ Boolean

By default this is set to false. When set to true the international sending of phone number is Enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#iso_country_code ⇒ String

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#message_type ⇒ 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:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#number_capabilities ⇒ Array<String>

Indicates if the phone number will be used for text messages, voice messages, or both.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#number_preference ⇒ Array<Types::NumberPreferenceItem>

An optional selection preference used to request a specific phone number, such as a number that starts with, ends with, or contains a particular digit pattern. You can specify at most one preference. Number preferences apply only to TEN_DLC requests in the US.

Returns:

• (Array<Types::NumberPreferenceItem>)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#number_type ⇒ String

The type of phone number to request.

When you request a SIMULATOR phone number, you must set MessageType as TRANSACTIONAL.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#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).

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#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).

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#registration_id ⇒ String

Use this field to attach your phone number for an external registration process.

Returns:

• (String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An array of tags (key and value pairs) to associate with the requested phone number.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 7844

class RequestPhoneNumberRequest < Struct.new(
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :opt_out_list_name,
  :pool_id,
  :registration_id,
  :number_preference,
  :international_sending_enabled,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end