Connect / Client / list_instance_attributes

list_instance_attributes#

Connect.Client.list_instance_attributes(**kwargs)#

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all attribute types for the given instance.

See also: AWS API Documentation

Request Syntax

response = client.list_instance_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

{
    'Attributes': [
        {
            'AttributeType': 'INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Attributes (list) –

      The attribute types.

      • (dict) –

        A toggle for an individual feature at the instance level.

        • AttributeType (string) –

          The type of attribute.

        • Value (string) –

          The value of the attribute.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ThrottlingException