Class: Aws::Chime::Types::SearchAvailablePhoneNumbersRequest

Inherits:

Struct

• Object
• Struct
• Aws::Chime::Types::SearchAvailablePhoneNumbersRequest

Defined in:

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

Overview

Note:

When making an API call, you may pass SearchAvailablePhoneNumbersRequest data as a hash:

{
  area_code: "String",
  city: "String",
  country: "Alpha2CountryCode",
  state: "String",
  toll_free_prefix: "TollFreePrefix",
  phone_number_type: "Local", # accepts Local, TollFree
  max_results: 1,
  next_token: "String",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #area_code ⇒ String

  The area code used to filter results.

• #city ⇒ String

  The city used to filter results.

• #country ⇒ String

  The country used to filter results.

• #max_results ⇒ Integer

  The maximum number of results to return in a single call.

• #next_token ⇒ String

  The token used to retrieve the next page of results.

• #phone_number_type ⇒ String

  The phone number type used to filter results.

• #state ⇒ String

  The state used to filter results.

• #toll_free_prefix ⇒ String

  The toll-free prefix that you use to filter results.

Instance Attribute Details

#area_code ⇒ String

The area code used to filter results. Only applies to the US.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8966

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

The city used to filter results. Only applies to the US.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8966

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

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8966

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 in a single call.

Returns:

• (Integer)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8966

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 retrieve the next page of results.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8966

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

The phone number type used to filter results. Required for non-US numbers.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8966

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

The state used to filter results. Required only if you provide City. Only applies to the US.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8966

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

The toll-free prefix that you use to filter results. Only applies to the US.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 8966

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