Class: Aws::PinpointSMSVoiceV2::Types::UpdatePhoneNumberRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (Boolean) 


6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6378

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.

Returns:

  • (String) 


6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6378

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.

Returns:

  • (String) 


6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6378

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, Amazon Pinpoint 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.

Returns:

  • (Boolean) 


6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6378

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.

Returns:

  • (String) 


6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6378

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.

Returns:

  • (String) 


6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6378

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.

Returns:

  • (Boolean) 


6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6378

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