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

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::SearchAvailablePhoneNumbersRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #instance_id ⇒ String

  The identifier of the Amazon Connect instance that phone numbers are claimed to.

• #max_results ⇒ Integer

  The maximum number of results to return per page.

• #next_token ⇒ String

  The token for the next set of results.

• #phone_number_country_code ⇒ String

  The ISO country code.

• #phone_number_prefix ⇒ String

  The prefix of the phone number.

• #phone_number_type ⇒ String

  The type of phone number.

• #target_arn ⇒ String

  The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.

Instance Attribute Details

#instance_id ⇒ String

The identifier of the Amazon Connect 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`.

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 26504

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)

# File 'lib/aws-sdk-connect/types.rb', line 26504

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)

# File 'lib/aws-sdk-connect/types.rb', line 26504

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)

# File 'lib/aws-sdk-connect/types.rb', line 26504

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)

# File 'lib/aws-sdk-connect/types.rb', line 26504

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)

# File 'lib/aws-sdk-connect/types.rb', line 26504

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 Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter ‘InstanceId` or `TargetArn`.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 26504

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