AWS API Changes

2019/10/23 - Amazon Connect Service - 4 new api methods

Changes This release adds 4 new APIs ListQueues, ListPhoneNumbers, ListContactFlows, and ListHoursOfOperations, which can be used to programmatically list Queues, PhoneNumbers, ContactFlows, and HoursOfOperations configured for an Amazon Connect instance respectively. You can learn more about the new APIs here: https://docs.aws.amazon.com/connect/latest/APIReference/Welcome.html.

ListQueues (new)

Link ¶

Provides information about the queues for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_queues(
    InstanceId='string',
    QueueTypes=[
        'STANDARD'|'AGENT',
    ],
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueTypes

list

param QueueTypes

The type of queue.

(string) --

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 MaxResults

integer

param MaxResults

The maximimum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'QueueSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'QueueType': 'STANDARD'|'AGENT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- QueueSummaryList (list) --
  
  Information about the queues.
  - (dict) --
    
    Contains summary information about a queue.
    - Id (string) --
      
      The identifier of the queue.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the queue.
    - Name (string) --
      
      The name of the queue.
    - QueueType (string) --
      
      The type of queue.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

ListContactFlows (new)

Link ¶

Provides information about the contact flows for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_contact_flows(
    InstanceId='string',
    ContactFlowTypes=[
        'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
    ],
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type ContactFlowTypes

list

param ContactFlowTypes

The type of contact flow.

(string) --

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 MaxResults

integer

param MaxResults

The maximimum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'ContactFlowSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ContactFlowSummaryList (list) --
  
  Information about the contact flows.
  - (dict) --
    
    Contains summary information about a contact flow.
    - Id (string) --
      
      The identifier of the contact flow.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the contact flow.
    - Name (string) --
      
      The name of the contact flow.
    - ContactFlowType (string) --
      
      The type of contact flow.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

ListHoursOfOperations (new)

Link ¶

Provides information about the hours of operation for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_hours_of_operations(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

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 MaxResults

integer

param MaxResults

The maximimum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'HoursOfOperationSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- HoursOfOperationSummaryList (list) --
  
  Information about the hours of operation.
  - (dict) --
    
    Contains summary information about hours of operation for a contact center.
    - Id (string) --
      
      The identifier of the hours of operation.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the hours of operation.
    - Name (string) --
      
      The name of the hours of operation.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

ListPhoneNumbers (new)

Link ¶

Provides information about the phone numbers for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

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

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type PhoneNumberTypes

list

param PhoneNumberTypes

The type of phone number.

(string) --

type PhoneNumberCountryCodes

list

param PhoneNumberCountryCodes

The ISO country code.

(string) --

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 MaxResults

integer

param MaxResults

The maximimum number of results to return per page.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- PhoneNumberSummaryList (list) --
  
  Information about the phone numbers.
  - (dict) --
    
    Contains summary information about a phone number for a contact center.
    - Id (string) --
      
      The identifier of the phone number.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the phone number.
    - PhoneNumber (string) --
      
      The phone number.
    - PhoneNumberType (string) --
      
      The type of phone number.
    - PhoneNumberCountryCode (string) --
      
      The ISO country code.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.