Class: Aws::PinpointSMSVoiceV2::Types::UpdatePoolRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::PinpointSMSVoiceV2::Types::UpdatePoolRequest
- 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
When set to true the pool can't be deleted.
-
#opt_out_list_name ⇒ String
The OptOutList to associate with the pool.
-
#pool_id ⇒ String
The unique identifier of the pool to update.
-
#self_managed_opt_outs_enabled ⇒ Boolean
By default this is set to false.
-
#shared_routes_enabled ⇒ Boolean
Indicates whether shared routes are enabled for the pool.
-
#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
When set to true the pool can't be deleted.
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6576 class UpdatePoolRequest < Struct.new( :pool_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#opt_out_list_name ⇒ String
The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6576 class UpdatePoolRequest < Struct.new( :pool_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#pool_id ⇒ String
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6576 class UpdatePoolRequest < Struct.new( :pool_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :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.
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6576 class UpdatePoolRequest < Struct.new( :pool_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#shared_routes_enabled ⇒ Boolean
Indicates whether shared routes are enabled for the pool.
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6576 class UpdatePoolRequest < Struct.new( :pool_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |
#two_way_channel_arn ⇒ String
The Amazon Resource Name (ARN) of the two way channel.
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6576 class UpdatePoolRequest < Struct.new( :pool_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :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.
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6576 class UpdatePoolRequest < Struct.new( :pool_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :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.
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 6576 class UpdatePoolRequest < Struct.new( :pool_id, :two_way_enabled, :two_way_channel_arn, :two_way_channel_role, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled) SENSITIVE = [] include Aws::Structure end |