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

Inherits:
Struct
  • Object
show all
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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#area_codeString

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

Returns:

  • (String)


8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
# 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

#cityString

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

Returns:

  • (String)


8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
# 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

#countryString

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

Returns:

  • (String)


8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
# 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_resultsInteger

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

Returns:

  • (Integer)


8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
# 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_tokenString

The token used to retrieve the next page of results.

Returns:

  • (String)


8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
# 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_typeString

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

Returns:

  • (String)


8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
# 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

#stateString

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

Returns:

  • (String)


8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
# 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_prefixString

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

Returns:

  • (String)


8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
# 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