/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Chime::SearchAvailablePhoneNumbers

NAME

Paws::Chime::SearchAvailablePhoneNumbers - Arguments for method SearchAvailablePhoneNumbers on Paws::Chime

DESCRIPTION

This class represents the parameters used for calling the method SearchAvailablePhoneNumbers on the Amazon Chime service. Use the attributes of this class as arguments to method SearchAvailablePhoneNumbers.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchAvailablePhoneNumbers.

SYNOPSIS

my $chime = Paws->service('Chime');
my $SearchAvailablePhoneNumbersResponse =
  $chime->SearchAvailablePhoneNumbers(
  AreaCode        => 'MyString',               # OPTIONAL
  City            => 'MyString',               # OPTIONAL
  Country         => 'MyAlpha2CountryCode',    # OPTIONAL
  MaxResults      => 1,                        # OPTIONAL
  NextToken       => 'MyString',               # OPTIONAL
  PhoneNumberType => 'Local',                  # OPTIONAL
  State           => 'MyString',               # OPTIONAL
  TollFreePrefix  => 'MyTollFreePrefix',       # OPTIONAL
  );

# Results:
my $E164PhoneNumbers =
  $SearchAvailablePhoneNumbersResponse->E164PhoneNumbers;
my $NextToken = $SearchAvailablePhoneNumbersResponse->NextToken;

# Returns a L<Paws::Chime::SearchAvailablePhoneNumbersResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/chime/SearchAvailablePhoneNumbers

ATTRIBUTES

AreaCode => Str

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

City => Str

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

Country => Str

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

MaxResults => Int

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

NextToken => Str

The token used to retrieve the next page of results.

PhoneNumberType => Str

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

Valid values are: "Local", "TollFree"

State => Str

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

TollFreePrefix => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method SearchAvailablePhoneNumbers in Paws::Chime

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues