com.amazonaws.services.connect.model

Class SearchAvailablePhoneNumbersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.SearchAvailablePhoneNumbersRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SearchAvailablePhoneNumbersRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchAvailablePhoneNumbersRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Integer	getMaxResults() The maximum number of results to return per page.
java.lang.String	getNextToken() The token for the next set of results.
java.lang.String	getPhoneNumberCountryCode() The ISO country code.
java.lang.String	getPhoneNumberPrefix() The prefix of the phone number.
java.lang.String	getPhoneNumberType() The type of phone number.
java.lang.String	getTargetArn() The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
int	hashCode()
void	setMaxResults(java.lang.Integer maxResults) The maximum number of results to return per page.
void	setNextToken(java.lang.String nextToken) The token for the next set of results.
void	setPhoneNumberCountryCode(PhoneNumberCountryCode phoneNumberCountryCode) The ISO country code.
void	setPhoneNumberCountryCode(java.lang.String phoneNumberCountryCode) The ISO country code.
void	setPhoneNumberPrefix(java.lang.String phoneNumberPrefix) The prefix of the phone number.
void	setPhoneNumberType(PhoneNumberType phoneNumberType) The type of phone number.
void	setPhoneNumberType(java.lang.String phoneNumberType) The type of phone number.
void	setTargetArn(java.lang.String targetArn) The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SearchAvailablePhoneNumbersRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of results to return per page.
SearchAvailablePhoneNumbersRequest	withNextToken(java.lang.String nextToken) The token for the next set of results.
SearchAvailablePhoneNumbersRequest	withPhoneNumberCountryCode(PhoneNumberCountryCode phoneNumberCountryCode) The ISO country code.
SearchAvailablePhoneNumbersRequest	withPhoneNumberCountryCode(java.lang.String phoneNumberCountryCode) The ISO country code.
SearchAvailablePhoneNumbersRequest	withPhoneNumberPrefix(java.lang.String phoneNumberPrefix) The prefix of the phone number.
SearchAvailablePhoneNumbersRequest	withPhoneNumberType(PhoneNumberType phoneNumberType) The type of phone number.
SearchAvailablePhoneNumbersRequest	withPhoneNumberType(java.lang.String phoneNumberType) The type of phone number.
SearchAvailablePhoneNumbersRequest	withTargetArn(java.lang.String targetArn) The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchAvailablePhoneNumbersRequest

public SearchAvailablePhoneNumbersRequest()

Method Detail

getTargetArn

public java.lang.String getTargetArn()

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Returns:

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

setTargetArn

public void setTargetArn(java.lang.String targetArn)

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Parameters:

targetArn -

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

withTargetArn

public SearchAvailablePhoneNumbersRequest withTargetArn(java.lang.String targetArn)

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Returns a reference to this object so that method calls can be chained together.

Parameters:

targetArn -

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Returns:

A reference to this updated object so that method calls can be chained together.

getPhoneNumberCountryCode

public java.lang.String getPhoneNumberCountryCode()

The ISO country code.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

Returns:

The ISO country code.

See Also:

PhoneNumberCountryCode

setPhoneNumberCountryCode

public void setPhoneNumberCountryCode(java.lang.String phoneNumberCountryCode)

The ISO country code.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

Parameters:

phoneNumberCountryCode -

The ISO country code.

See Also:

PhoneNumberCountryCode

withPhoneNumberCountryCode

public SearchAvailablePhoneNumbersRequest withPhoneNumberCountryCode(java.lang.String phoneNumberCountryCode)

The ISO country code.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

Parameters:

phoneNumberCountryCode -

The ISO country code.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PhoneNumberCountryCode

setPhoneNumberCountryCode

public void setPhoneNumberCountryCode(PhoneNumberCountryCode phoneNumberCountryCode)

The ISO country code.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

Parameters:

phoneNumberCountryCode -

The ISO country code.

See Also:

PhoneNumberCountryCode

withPhoneNumberCountryCode

public SearchAvailablePhoneNumbersRequest withPhoneNumberCountryCode(PhoneNumberCountryCode phoneNumberCountryCode)

The ISO country code.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

Parameters:

phoneNumberCountryCode -

The ISO country code.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PhoneNumberCountryCode

getPhoneNumberType

public java.lang.String getPhoneNumberType()

The type of phone number.

Constraints:
Allowed Values: TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID

Returns:

The type of phone number.

See Also:

PhoneNumberType

setPhoneNumberType

public void setPhoneNumberType(java.lang.String phoneNumberType)

The type of phone number.

Constraints:
Allowed Values: TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID

Parameters:

phoneNumberType -

The type of phone number.

See Also:

PhoneNumberType

withPhoneNumberType

public SearchAvailablePhoneNumbersRequest withPhoneNumberType(java.lang.String phoneNumberType)

The type of phone number.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID

Parameters:

phoneNumberType -

The type of phone number.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PhoneNumberType

setPhoneNumberType

public void setPhoneNumberType(PhoneNumberType phoneNumberType)

The type of phone number.

Constraints:
Allowed Values: TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID

Parameters:

phoneNumberType -

The type of phone number.

See Also:

PhoneNumberType

withPhoneNumberType

public SearchAvailablePhoneNumbersRequest withPhoneNumberType(PhoneNumberType phoneNumberType)

The type of phone number.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID

Parameters:

phoneNumberType -

The type of phone number.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PhoneNumberType

getPhoneNumberPrefix

public java.lang.String getPhoneNumberPrefix()

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

Constraints:
Pattern: \\+?[0-9]{1,11}

Returns:

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

setPhoneNumberPrefix

public void setPhoneNumberPrefix(java.lang.String phoneNumberPrefix)

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

Constraints:
Pattern: \\+?[0-9]{1,11}

Parameters:

phoneNumberPrefix -

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

withPhoneNumberPrefix

public SearchAvailablePhoneNumbersRequest withPhoneNumberPrefix(java.lang.String phoneNumberPrefix)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: \\+?[0-9]{1,11}

Parameters:

phoneNumberPrefix -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of results to return per page.

Constraints:
Range: 1 - 10

Returns:

The maximum number of results to return per page.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of results to return per page.

Constraints:
Range: 1 - 10

Parameters:

maxResults -

The maximum number of results to return per page.

withMaxResults

public SearchAvailablePhoneNumbersRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of results to return per page.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 10

Parameters:

maxResults -

The maximum number of results to return per page.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

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.

Constraints:
Length: 1 - 100000

Returns:

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.

setNextToken

public void setNextToken(java.lang.String nextToken)

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.

Constraints:
Length: 1 - 100000

Parameters:

nextToken -

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.

withNextToken

public SearchAvailablePhoneNumbersRequest withNextToken(java.lang.String nextToken)

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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100000

Parameters:

nextToken -

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:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object