Class: Aws::PinpointSMSVoiceV2::Types::UpdatePoolResult

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_timestampTime

The time when the pool was created, in UNIX epoch time format.

Returns:

  • (Time)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabledBoolean

When set to true the pool can't be deleted.

Returns:

  • (Boolean)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#message_typeString

The type of message for the pool to use.

Returns:

  • (String)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#opt_out_list_nameString

The name of the OptOutList associated with the pool.

Returns:

  • (String)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#pool_arnString

The ARN of the pool.

Returns:

  • (String)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#pool_idString

The unique identifier of the pool.

Returns:

  • (String)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_opt_outs_enabledBoolean

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)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#shared_routes_enabledBoolean

Indicates whether shared routes are enabled for the pool.

Returns:

  • (Boolean)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the pool update request.

Returns:

  • (String)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#two_way_channel_arnString

The Amazon Resource Name (ARN) of the two way channel.

Returns:

  • (String)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#two_way_enabledBoolean

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Returns:

  • (Boolean)


3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3496

class UpdatePoolResult < 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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end