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

Inherits:

Struct

Object
Struct
Aws::PinpointSMSVoiceV2::Types::UpdatePoolResult

show all

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 the pool can't be deleted.
#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 ARN of the pool.
#pool_id ⇒ String
The unique identifier of the pool.
#self_managed_opt_outs_enabled ⇒ Boolean
When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList.
#shared_routes_enabled ⇒ Boolean
Indicates whether shared routes are enabled for the pool.
#status ⇒ String
The current status of the pool update request.
#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

#created_timestamp ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#message_type ⇒ `String`

The type of message for the pool to use.

Returns:

(String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#opt_out_list_name ⇒ `String`

The name of the OptOutList associated with the pool.

Returns:

(String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#pool_arn ⇒ `String`

The ARN of the pool.

Returns:

(String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#pool_id ⇒ `String`

The unique identifier of the pool.

Returns:

(String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_opt_outs_enabled ⇒ `Boolean`

When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS 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)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#shared_routes_enabled ⇒ `Boolean`

Indicates whether shared routes are enabled for the pool.

Returns:

(Boolean)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The current status of the pool update request.

Returns:

(String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#two_way_channel_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  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)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :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.

Returns:

(Boolean)

# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 10127

class UpdatePoolResult < Struct.new(
  :pool_arn,
  :pool_id,
  :status,
  :message_type,
  :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,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#created_timestamp ⇒ Time

#deletion_protection_enabled ⇒ Boolean

#message_type ⇒ String

#opt_out_list_name ⇒ String

#pool_arn ⇒ String

#pool_id ⇒ String

#self_managed_opt_outs_enabled ⇒ Boolean

#shared_routes_enabled ⇒ Boolean

#status ⇒ String

#two_way_channel_arn ⇒ String

#two_way_channel_role ⇒ String

#two_way_enabled ⇒ Boolean

#created_timestamp ⇒ `Time`

#deletion_protection_enabled ⇒ `Boolean`

#message_type ⇒ `String`

#opt_out_list_name ⇒ `String`

#pool_arn ⇒ `String`

#pool_id ⇒ `String`

#self_managed_opt_outs_enabled ⇒ `Boolean`

#shared_routes_enabled ⇒ `Boolean`

#status ⇒ `String`

#two_way_channel_arn ⇒ `String`

#two_way_channel_role ⇒ `String`

#two_way_enabled ⇒ `Boolean`