You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Chime::Types::ListPhoneNumbersRequest

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 ListPhoneNumbersRequest data as a hash:

{
  status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
  product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
  filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId
  filter_value: "String",
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#filter_nameString

The filter to use to limit the number of results.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1517

class ListPhoneNumbersRequest < Struct.new(
  :status,
  :product_type,
  :filter_name,
  :filter_value,
  :max_results,
  :next_token)
  include Aws::Structure
end

#filter_valueString

The value to use for the filter.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1517

class ListPhoneNumbersRequest < Struct.new(
  :status,
  :product_type,
  :filter_name,
  :filter_value,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


1517
1518
1519
1520
1521
1522
1523
1524
1525
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1517

class ListPhoneNumbersRequest < Struct.new(
  :status,
  :product_type,
  :filter_name,
  :filter_value,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token to use to retrieve the next page of results.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1517

class ListPhoneNumbersRequest < Struct.new(
  :status,
  :product_type,
  :filter_name,
  :filter_value,
  :max_results,
  :next_token)
  include Aws::Structure
end

#product_typeString

The phone number product type.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1517

class ListPhoneNumbersRequest < Struct.new(
  :status,
  :product_type,
  :filter_name,
  :filter_value,
  :max_results,
  :next_token)
  include Aws::Structure
end

#statusString

The phone number status.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1517

class ListPhoneNumbersRequest < Struct.new(
  :status,
  :product_type,
  :filter_name,
  :filter_value,
  :max_results,
  :next_token)
  include Aws::Structure
end