Amazon Connect Service

2022/06/17 - Amazon Connect Service - 3 updated api methods

Changes  This release updates these APIs: UpdateInstanceAttribute, DescribeInstanceAttribute and ListInstanceAttributes. You can use it to programmatically enable/disable High volume outbound communications using attribute type HIGH_VOLUME_OUTBOUND on the specified Amazon Connect instance.

DescribeInstanceAttribute (updated) Link ¶
Changes (request, response)
Request 
{'AttributeType': {'HIGH_VOLUME_OUTBOUND'}}
Response 
{'Attribute': {'AttributeType': {'HIGH_VOLUME_OUTBOUND'}}}

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

Describes the specified instance attribute.

See also: AWS API Documentation

Request Syntax

client.describe_instance_attribute(
    InstanceId='string',
    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'
)
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 AttributeType

string

param AttributeType

[REQUIRED]

The type of attribute.

rtype

dict

returns

Response Syntax

{
    'Attribute': {
        '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',
        'Value': 'string'
    }
}

Response Structure

  • (dict) --

    • Attribute (dict) --

      The type of attribute.

      • AttributeType (string) --

        The type of attribute.

      • Value (string) --

        The value of the attribute.

ListInstanceAttributes (updated) Link ¶
Changes (response) 
{'Attributes': {'AttributeType': {'HIGH_VOLUME_OUTBOUND'}}}

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

client.list_instance_attributes(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)
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 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 maximum number of results to return per page.

rtype

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',
            '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.

UpdateInstanceAttribute (updated) Link ¶
Changes (request) 
{'AttributeType': {'HIGH_VOLUME_OUTBOUND'}}

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

Updates the value for the specified attribute type.

See also: AWS API Documentation

Request Syntax

client.update_instance_attribute(
    InstanceId='string',
    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',
    Value='string'
)
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 AttributeType

string

param AttributeType

[REQUIRED]

The type of attribute.

Note

Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.

type Value

string

param Value

[REQUIRED]

The value for the attribute. Maximum character limit is 100.

returns

None