Class: Aws::Connect::Types::SearchAvailablePhoneNumbersRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#instance_id ⇒ String

The identifier of the Connect Customer instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

Returns:

  • (String)


32788
32789
32790
32791
32792
32793
32794
32795
32796
32797
32798
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 32788

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :target_arn,
  :instance_id,
  :phone_number_country_code,
  :phone_number_type,
  :phone_number_prefix,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

  • (Integer)


32788
32789
32790
32791
32792
32793
32794
32795
32796
32797
32798
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 32788

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :target_arn,
  :instance_id,
  :phone_number_country_code,
  :phone_number_type,
  :phone_number_prefix,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

  • (String)


32788
32789
32790
32791
32792
32793
32794
32795
32796
32797
32798
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 32788

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :target_arn,
  :instance_id,
  :phone_number_country_code,
  :phone_number_type,
  :phone_number_prefix,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number_country_code ⇒ String

The ISO country code.

Returns:

  • (String)


32788
32789
32790
32791
32792
32793
32794
32795
32796
32797
32798
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 32788

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :target_arn,
  :instance_id,
  :phone_number_country_code,
  :phone_number_type,
  :phone_number_prefix,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number_prefix ⇒ String

The prefix of the phone number. If provided, it must contain + as part of the country code.

Returns:

  • (String)


32788
32789
32790
32791
32792
32793
32794
32795
32796
32797
32798
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 32788

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :target_arn,
  :instance_id,
  :phone_number_country_code,
  :phone_number_type,
  :phone_number_prefix,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number_type ⇒ String

The type of phone number.

Returns:

  • (String)


32788
32789
32790
32791
32792
32793
32794
32795
32796
32797
32798
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 32788

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :target_arn,
  :instance_id,
  :phone_number_country_code,
  :phone_number_type,
  :phone_number_prefix,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#target_arn ⇒ String

The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

Returns:

  • (String)


32788
32789
32790
32791
32792
32793
32794
32795
32796
32797
32798
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 32788

class SearchAvailablePhoneNumbersRequest < Struct.new(
  :target_arn,
  :instance_id,
  :phone_number_country_code,
  :phone_number_type,
  :phone_number_prefix,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end