Connect / Client / list_predefined_attributes

list_predefined_attributes¶

Connect.Client.list_predefined_attributes(**kwargs)¶

Lists predefined attributes for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for:

Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes.

For the predefined attributes per instance quota, see Amazon Connect quotas.

Endpoints: See Amazon Connect endpoints and quotas.

Request Syntax

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

Parameters:

InstanceId (string) –
[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
NextToken (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.
MaxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'PredefinedAttributeSummaryList': [
        {
            'Name': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  If there are additional results, this is the token for the next set of results.
- PredefinedAttributeSummaryList (list) –
  
  Summary of the predefined attributes.
  - (dict) –
    
    Summary of a predefined attribute.
    - Name (string) –
      
      The name of the predefined attribute.
    - LastModifiedTime (datetime) –
      
      Last modified time.
    - LastModifiedRegion (string) –
      
      Last modified region.

Exceptions

Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException