Class: Aws::PinpointSMSVoiceV2::Types::UpdatePhoneNumberRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::PinpointSMSVoiceV2::Types::UpdatePhoneNumberRequest
- Defined in:
- gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#deletion_protection_enabled ⇒ Boolean
By default this is set to false.
-
#opt_out_list_name ⇒ String
The OptOutList to add the phone number to.
-
#phone_number_id ⇒ String
The unique identifier of the phone number.
-
#self_managed_opt_outs_enabled ⇒ Boolean
By default this is set to false.
-
#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.
Instance Attribute Details
#deletion_protection_enabled ⇒ Boolean
By default this is set to false. When set to true the phone number can't be deleted.
6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6417 class UpdatePhoneNumberRequest < Struct.new( :phone_number_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#opt_out_list_name ⇒ String
The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6417 class UpdatePhoneNumberRequest < Struct.new( :phone_number_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#phone_number_id ⇒ String
The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6417 class UpdatePhoneNumberRequest < Struct.new( :phone_number_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#self_managed_opt_outs_enabled ⇒ Boolean
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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.
6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6417 class UpdatePhoneNumberRequest < Struct.new( :phone_number_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#two_way_channel_arn ⇒ String
The Amazon Resource Name (ARN) of the two way channel.
6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6417 class UpdatePhoneNumberRequest < Struct.new( :phone_number_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#two_way_channel_role ⇒ String
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6417 class UpdatePhoneNumberRequest < Struct.new( :phone_number_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#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.
6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6417 class UpdatePhoneNumberRequest < Struct.new( :phone_number_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |