Class: Aws::ChimeSDKVoice::Types::PhoneNumber

Inherits:

Struct

• Object
• Struct
• Aws::ChimeSDKVoice::Types::PhoneNumber

Defined in:

gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb

Overview

A phone number used to call an Amazon Chime SDK Voice Connector.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:phone_number_id, :e164_phone_number, :calling_name, :name]

Instance Attribute Summary

• #associations ⇒ Array<Types::PhoneNumberAssociation>

  The phone number's associations.

• #calling_name ⇒ String

  The outbound calling name associated with the phone number.

• #calling_name_status ⇒ String

  The outbound calling name status.

• #capabilities ⇒ Types::PhoneNumberCapabilities

  The phone number's capabilities.

• #country ⇒ String

  The phone number's country.

• #created_timestamp ⇒ Time

  The phone number creation timestamp, in ISO 8601 format.

• #deletion_timestamp ⇒ Time

  The deleted phone number timestamp, in ISO 8601 format.

• #e164_phone_number ⇒ String

  The phone number, in E.164 format.

• #name ⇒ String

  The name of the phone number.

• #order_id ⇒ String

  The phone number's order ID.

• #phone_number_id ⇒ String

  The phone number's ID.

• #product_type ⇒ String

  The phone number's product type.

• #status ⇒ String

  The phone number's status.

• #type ⇒ String

  The phone number's type.

• #updated_timestamp ⇒ Time

  The updated phone number timestamp, in ISO 8601 format.

Instance Attribute Details

#associations ⇒ Array<Types::PhoneNumberAssociation>

The phone number's associations.

Returns:

• (Array<Types::PhoneNumberAssociation>)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#calling_name ⇒ String

The outbound calling name associated with the phone number.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#calling_name_status ⇒ String

The outbound calling name status.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#capabilities ⇒ Types::PhoneNumberCapabilities

The phone number's capabilities.

Returns:

• (Types::PhoneNumberCapabilities)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#country ⇒ String

The phone number's country. Format: ISO 3166-1 alpha-2.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#created_timestamp ⇒ Time

The phone number creation timestamp, in ISO 8601 format.

Returns:

• (Time)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#deletion_timestamp ⇒ Time

The deleted phone number timestamp, in ISO 8601 format.

Returns:

• (Time)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#e164_phone_number ⇒ String

The phone number, in E.164 format.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#name ⇒ String

The name of the phone number.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#order_id ⇒ String

The phone number's order ID.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#phone_number_id ⇒ String

The phone number's ID.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#product_type ⇒ String

The phone number's product type.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#status ⇒ String

The phone number's status.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#type ⇒ String

The phone number's type.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end

#updated_timestamp ⇒ Time

The updated phone number timestamp, in ISO 8601 format.

Returns:

• (Time)

# File 'gems/aws-sdk-chimesdkvoice/lib/aws-sdk-chimesdkvoice/types.rb', line 2187

class PhoneNumber < Struct.new(
  :phone_number_id,
  :e164_phone_number,
  :country,
  :type,
  :product_type,
  :status,
  :capabilities,
  :associations,
  :calling_name,
  :calling_name_status,
  :created_timestamp,
  :updated_timestamp,
  :deletion_timestamp,
  :order_id,
  :name)
  SENSITIVE = [:phone_number_id, :e164_phone_number, :calling_name, :name]
  include Aws::Structure
end