AWS API Changes

2022/04/20 - Amazon Connect Service - 8 new api methods

Changes This release adds APIs to search, claim, release, list, update, and describe phone numbers. You can also use them to associate and disassociate contact flows to phone numbers.

DescribePhoneNumber (new)

Link ¶

Gets details and status of a phone number that’s claimed to your Amazon Connect instance

See also: AWS API Documentation

Request Syntax

client.describe_phone_number(
    PhoneNumberId='string'
)

type PhoneNumberId

string

param PhoneNumberId

[REQUIRED]

The identifier of the phone number.

rtype

dict

returns

Response Syntax

{
    'ClaimedPhoneNumberSummary': {
        'PhoneNumberId': 'string',
        'PhoneNumberArn': 'string',
        'PhoneNumber': 'string',
        'PhoneNumberCountryCode': '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',
        'PhoneNumberType': 'TOLL_FREE'|'DID',
        'PhoneNumberDescription': 'string',
        'TargetArn': 'string',
        'Tags': {
            'string': 'string'
        },
        'PhoneNumberStatus': {
            'Status': 'CLAIMED'|'IN_PROGRESS'|'FAILED',
            'Message': 'string'
        }
    }
}

Response Structure

(dict) --
- ClaimedPhoneNumberSummary (dict) --
  
  Information about a phone number that's been claimed to your Amazon Connect instance.
  - PhoneNumberId (string) --
    
    The identifier of the phone number.
  - PhoneNumberArn (string) --
    
    The Amazon Resource Name (ARN) of the phone number.
  - PhoneNumber (string) --
    
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code] .
  - PhoneNumberCountryCode (string) --
    
    The ISO country code.
  - PhoneNumberType (string) --
    
    The type of phone number.
  - PhoneNumberDescription (string) --
    
    The description of the phone number.
  - TargetArn (string) --
    
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
  - Tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - PhoneNumberStatus (dict) --
    
    The status of the phone number.
    - Status (string) --
      
      The status.
    - Message (string) --
      
      The status message.

SearchAvailablePhoneNumbers (new)

Link ¶

Searches for available phone numbers that you can claim to your Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.search_available_phone_numbers(
    TargetArn='string',
    PhoneNumberCountryCode='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',
    PhoneNumberType='TOLL_FREE'|'DID',
    PhoneNumberPrefix='string',
    MaxResults=123,
    NextToken='string'
)

type TargetArn

string

param TargetArn

[REQUIRED]

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

type PhoneNumberCountryCode

string

param PhoneNumberCountryCode

[REQUIRED]

The ISO country code.

type PhoneNumberType

string

param PhoneNumberType

[REQUIRED]

The type of phone number.

type PhoneNumberPrefix

string

param PhoneNumberPrefix

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

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

type NextToken

string

param 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.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'AvailableNumbersList': [
        {
            'PhoneNumber': 'string',
            'PhoneNumberCountryCode': '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',
            'PhoneNumberType': 'TOLL_FREE'|'DID'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.
- AvailableNumbersList (list) --
  
  A list of available phone numbers that you can claim for your Amazon Connect instance.
  - (dict) --
    
    Information about available phone numbers.
    - PhoneNumber (string) --
      
      The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code] .
    - PhoneNumberCountryCode (string) --
      
      The ISO country code.
    - PhoneNumberType (string) --
      
      The type of phone number.

ReleasePhoneNumber (new)

Link ¶

Releases a phone number previously claimed to an Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.release_phone_number(
    PhoneNumberId='string',
    ClientToken='string'
)

type PhoneNumberId

string

param PhoneNumberId

[REQUIRED]

The identifier of the phone number.

type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

returns

None

ClaimPhoneNumber (new)

Link ¶

Claims an available phone number to your Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.claim_phone_number(
    TargetArn='string',
    PhoneNumber='string',
    PhoneNumberDescription='string',
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)

type TargetArn

string

param TargetArn

[REQUIRED]

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

type PhoneNumber

string

param PhoneNumber

[REQUIRED]

The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code] .

type PhoneNumberDescription

string

param PhoneNumberDescription

The description of the phone number.

type Tags

dict

param Tags

The tags used to organize, track, or control access for this resource.

(string) --
- (string) --

type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'PhoneNumberId': 'string',
    'PhoneNumberArn': 'string'
}

Response Structure

(dict) --
- PhoneNumberId (string) --
  
  The identifier of the phone number.
- PhoneNumberArn (string) --
  
  The Amazon Resource Name (ARN) of the phone number.

ListPhoneNumbersV2 (new)

Link ¶

Lists phone numbers claimed to your Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

client.list_phone_numbers_v2(
    TargetArn='string',
    MaxResults=123,
    NextToken='string',
    PhoneNumberCountryCodes=[
        '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',
    ],
    PhoneNumberTypes=[
        'TOLL_FREE'|'DID',
    ],
    PhoneNumberPrefix='string'
)

type TargetArn

string

param TargetArn

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account.

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

type NextToken

string

param 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.

type PhoneNumberCountryCodes

list

param PhoneNumberCountryCodes

The ISO country code.

(string) --

type PhoneNumberTypes

list

param PhoneNumberTypes

The type of phone number.

(string) --

type PhoneNumberPrefix

string

param PhoneNumberPrefix

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

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'ListPhoneNumbersSummaryList': [
        {
            'PhoneNumberId': 'string',
            'PhoneNumberArn': 'string',
            'PhoneNumber': 'string',
            'PhoneNumberCountryCode': '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',
            'PhoneNumberType': 'TOLL_FREE'|'DID',
            'TargetArn': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.
- ListPhoneNumbersSummaryList (list) --
  
  Information about phone numbers that have been claimed to your Amazon Connect instances.
  - (dict) --
    
    Information about phone numbers that have been claimed to your Amazon Connect instance.
    - PhoneNumberId (string) --
      
      The identifier of the phone number.
    - PhoneNumberArn (string) --
      
      The Amazon Resource Name (ARN) of the phone number.
    - PhoneNumber (string) --
      
      The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code] .
    - PhoneNumberCountryCode (string) --
      
      The ISO country code.
    - PhoneNumberType (string) --
      
      The type of phone number.
    - TargetArn (string) --
      
      The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

DisassociatePhoneNumberContactFlow (new)

Link ¶

Removes the contact flow association from a phone number claimed to your Amazon Connect instance, if a contact flow association exists.

See also: AWS API Documentation

Request Syntax

client.disassociate_phone_number_contact_flow(
    PhoneNumberId='string',
    InstanceId='string'
)

type PhoneNumberId

string

param PhoneNumberId

[REQUIRED]

The identifier of the phone number.

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

returns

None

AssociatePhoneNumberContactFlow (new)

Link ¶

Associates a contact flow with a phone number claimed to your Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.associate_phone_number_contact_flow(
    PhoneNumberId='string',
    InstanceId='string',
    ContactFlowId='string'
)

type PhoneNumberId

string

param PhoneNumberId

[REQUIRED]

A unique identifier for the phone number.

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ContactFlowId

string

param ContactFlowId

[REQUIRED]

The identifier of the contact flow.

returns

None

UpdatePhoneNumber (new)

Link ¶

Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in the same Region.

See also: AWS API Documentation

Request Syntax

client.update_phone_number(
    PhoneNumberId='string',
    TargetArn='string',
    ClientToken='string'
)

type PhoneNumberId

string

param PhoneNumberId

[REQUIRED]

The identifier of the phone number.

type TargetArn

string

param TargetArn

[REQUIRED]

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

type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'PhoneNumberId': 'string',
    'PhoneNumberArn': 'string'
}

Response Structure

(dict) --
- PhoneNumberId (string) --
  
  The identifier of the phone number.
- PhoneNumberArn (string) --
  
  The Amazon Resource Name (ARN) of the phone number.