Class: Aws::PinpointSMSVoiceV2::Types::CreatePoolResult
- Inherits:
-
Struct
- Object
- Struct
- Aws::PinpointSMSVoiceV2::Types::CreatePoolResult
- Defined in:
- gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#created_timestamp ⇒ Time
The time when the pool was created, in [UNIX epoch time][1] format.
-
#deletion_protection_enabled ⇒ Boolean
When set to true deletion protection is enabled.
-
#message_type ⇒ String
The type of message for the pool to use.
-
#opt_out_list_name ⇒ String
The name of the OptOutList associated with the pool.
-
#pool_arn ⇒ String
The Amazon Resource Name (ARN) for the pool.
-
#pool_id ⇒ String
The unique identifier for the pool.
-
#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.
-
#status ⇒ String
The current status of the pool.
-
#tags ⇒ Array<Types::Tag>
An array of tags (key and value pairs) associated with the pool.
-
#two_way_channel_arn ⇒ String
The Amazon Resource Name (ARN) of the two way channel.
-
#two_way_enabled ⇒ Boolean
By default this is set to false.
Instance Attribute Details
#created_timestamp ⇒ Time
The time when the pool was created, in UNIX epoch time format.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |
#deletion_protection_enabled ⇒ Boolean
When set to true deletion protection is enabled. By default this is set to false.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |
#message_type ⇒ String
The type of message for the pool to use.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |
#opt_out_list_name ⇒ String
The name of the OptOutList associated with the pool.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |
#pool_arn ⇒ String
The Amazon Resource Name (ARN) for the pool.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |
#pool_id ⇒ String
The unique identifier for the pool.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) 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.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |
#shared_routes_enabled ⇒ Boolean
Indicates whether shared routes are enabled for the pool.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
An array of tags (key and value pairs) associated with the pool.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |
#two_way_channel_arn ⇒ String
The Amazon Resource Name (ARN) of the two way channel.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) 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.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 686 class CreatePoolResult < Struct.new( :pool_arn, :pool_id, :status, :message_type, :two_way_enabled, :two_way_channel_arn, :self_managed_opt_outs_enabled, :opt_out_list_name, :shared_routes_enabled, :deletion_protection_enabled, :tags, :created_timestamp) SENSITIVE = [] include Aws::Structure end |