Class: Aws::ChimeSDKVoice::Types::SearchAvailablePhoneNumbersRequest

Inherits:

Struct

• Object
• Struct
• Aws::ChimeSDKVoice::Types::SearchAvailablePhoneNumbersRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #area_code ⇒ String

  Confines a search to just the phone numbers associated with the specified area code.

• #city ⇒ String

  Confines a search to just the phone numbers associated with the specified city.

• #country ⇒ String

  Confines a search to just the phone numbers associated with the specified country.

• #max_results ⇒ Integer

  The maximum number of results to return.

• #next_token ⇒ String

  The token used to return the next page of results.

• #phone_number_type ⇒ String

  Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

• #state ⇒ String

  Confines a search to just the phone numbers associated with the specified state.

• #toll_free_prefix ⇒ String

  Confines a search to just the phone numbers associated with the specified toll-free prefix.

Instance Attribute Details

#area_code ⇒ String

Confines a search to just the phone numbers associated with the specified area code.

Returns:

• (String)

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

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :area_code,
  :city,
  :country,
  :state,
  :toll_free_prefix,
  :phone_number_type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#city ⇒ String

Confines a search to just the phone numbers associated with the specified city.

Returns:

• (String)

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

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :area_code,
  :city,
  :country,
  :state,
  :toll_free_prefix,
  :phone_number_type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#country ⇒ String

Confines a search to just the phone numbers associated with the specified country.

Returns:

• (String)

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

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :area_code,
  :city,
  :country,
  :state,
  :toll_free_prefix,
  :phone_number_type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return.

Returns:

• (Integer)

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

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :area_code,
  :city,
  :country,
  :state,
  :toll_free_prefix,
  :phone_number_type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token used to return the next page of results.

Returns:

• (String)

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

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :area_code,
  :city,
  :country,
  :state,
  :toll_free_prefix,
  :phone_number_type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number_type ⇒ String

Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

Returns:

• (String)

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

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :area_code,
  :city,
  :country,
  :state,
  :toll_free_prefix,
  :phone_number_type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

Confines a search to just the phone numbers associated with the specified state.

Returns:

• (String)

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

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :area_code,
  :city,
  :country,
  :state,
  :toll_free_prefix,
  :phone_number_type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#toll_free_prefix ⇒ String

Confines a search to just the phone numbers associated with the specified toll-free prefix.

Returns:

• (String)

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

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :area_code,
  :city,
  :country,
  :state,
  :toll_free_prefix,
  :phone_number_type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end