Class: Aws::PinpointSMSVoiceV2::Types::PhoneNumberInformation

Inherits:

Struct

Object
Struct
Aws::PinpointSMSVoiceV2::Types::PhoneNumberInformation

show all

Defined in:: gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

The information for a phone number, in E.164 format, in an Amazon Web Services account.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#created_timestamp ⇒ Time
The time when the phone number was created, in [UNIX epoch time][1] format.
#deletion_protection_enabled ⇒ Boolean
When set to true the phone number can't be deleted.
#iso_country_code ⇒ String
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
#message_type ⇒ String
The type of message.
#monthly_leasing_price ⇒ String
The price, in US dollars, to lease the phone number.
#number_capabilities ⇒ Array<String>
Describes if the origination identity can be used for text messages, voice calls or both.
#number_type ⇒ String
The type of phone number.
#opt_out_list_name ⇒ String
The name of the OptOutList associated with the phone number.
#phone_number ⇒ String
The phone number in E.164 format.
#phone_number_arn ⇒ String
The Amazon Resource Name (ARN) associated with the phone number.
#phone_number_id ⇒ String
The unique identifier for the phone number.
#pool_id ⇒ String
The unique identifier of the pool associated with the phone number.
#registration_id ⇒ String
The unique identifier for the registration.
#self_managed_opt_outs_enabled ⇒ Boolean
When set to false 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.
#status ⇒ String
The current status of the phone number.
#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 phone number was created, in UNIX epoch time format.

Returns:

(Time)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ `Boolean`

When set to true the phone number can't be deleted.

Returns:

(Boolean)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#iso_country_code ⇒ `String`

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#message_type ⇒ `String`

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#monthly_leasing_price ⇒ `String`

The price, in US dollars, to lease the phone number.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#number_capabilities ⇒ `Array<String>`

Describes if the origination identity can be used for text messages, voice calls or both.

Returns:

(Array<String>)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#number_type ⇒ `String`

The type of phone number.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#opt_out_list_name ⇒ `String`

The name of the OptOutList associated with the phone number.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number ⇒ `String`

The phone number in E.164 format.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number_arn ⇒ `String`

The Amazon Resource Name (ARN) associated with the phone number.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number_id ⇒ `String`

The unique identifier for the phone number.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#pool_id ⇒ `String`

The unique identifier of the pool associated with the phone number.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#registration_id ⇒ `String`

The unique identifier for the registration.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_opt_outs_enabled ⇒ `Boolean`

When set to false 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 request. For more information see Self-managed opt-outs

Returns:

(Boolean)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The current status of the phone number.

Returns:

(String)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :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 3671

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :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 3671

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :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 using the TwoWayChannelArn.

Returns:

(Boolean)

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

class PhoneNumberInformation < Struct.new(
  :phone_number_arn,
  :phone_number_id,
  :phone_number,
  :status,
  :iso_country_code,
  :message_type,
  :number_capabilities,
  :number_type,
  :monthly_leasing_price,
  :two_way_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :self_managed_opt_outs_enabled,
  :opt_out_list_name,
  :deletion_protection_enabled,
  :pool_id,
  :registration_id,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::PinpointSMSVoiceV2::Types::PhoneNumberInformation

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#created_timestamp ⇒ Time

#deletion_protection_enabled ⇒ Boolean

#iso_country_code ⇒ String

#message_type ⇒ String

#monthly_leasing_price ⇒ String

#number_capabilities ⇒ Array<String>

#number_type ⇒ String

#opt_out_list_name ⇒ String

#phone_number ⇒ String

#phone_number_arn ⇒ String

#phone_number_id ⇒ String

#pool_id ⇒ String

#registration_id ⇒ String

#self_managed_opt_outs_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`

#iso_country_code ⇒ `String`

#message_type ⇒ `String`

#monthly_leasing_price ⇒ `String`

#number_capabilities ⇒ `Array<String>`

#number_type ⇒ `String`

#opt_out_list_name ⇒ `String`

#phone_number ⇒ `String`

#phone_number_arn ⇒ `String`

#phone_number_id ⇒ `String`

#pool_id ⇒ `String`

#registration_id ⇒ `String`

#self_managed_opt_outs_enabled ⇒ `Boolean`

#status ⇒ `String`

#two_way_channel_arn ⇒ `String`

#two_way_channel_role ⇒ `String`

#two_way_enabled ⇒ `Boolean`