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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
-
#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_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) 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.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :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.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :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.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :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.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :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.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :deletion_protection_enabled, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |
#number_type ⇒ String
The type of phone number to request.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :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.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :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.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :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.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :deletion_protection_enabled, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
An array of tags (key and value pairs) associate with the requested phone number.
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5037 class RequestPhoneNumberRequest < Struct.new( :iso_country_code, :message_type, :number_capabilities, :number_type, :opt_out_list_name, :pool_id, :registration_id, :deletion_protection_enabled, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |