ConnectCampaignServiceV2 / Client / get_instance_communication_limits

get_instance_communication_limits

ConnectCampaignServiceV2.Client.get_instance_communication_limits(**kwargs)

Get the instance communication limits.

See also: AWS API Documentation

Request Syntax

response = client.get_instance_communication_limits(
    connectInstanceId='string'
)
Parameters:

connectInstanceId (string) –

[REQUIRED]

Amazon Connect Instance Id

Return type:

dict

Returns:

Response Syntax

{
    'communicationLimitsConfig': {
        'allChannelSubtypes': {
            'communicationLimitsList': [
                {
                    'maxCountPerRecipient': 123,
                    'frequency': 123,
                    'unit': 'DAY'
                },
            ]
        }
    }
}

Response Structure

  • (dict) –

    The response for GetInstanceCommunicationLimits API.

    • communicationLimitsConfig (dict) –

      Instance Communication limits config

      • allChannelSubtypes (dict) –

        Communication limits

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: communicationLimitsList. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • communicationLimitsList (list) –

          List of communication limit

          • (dict) –

            Communication Limit

            • maxCountPerRecipient (integer) –

              Maximum number of contacts allowed for a given target within the given frequency.

            • frequency (integer) –

              The number of days to consider with regards to this limit.

            • unit (string) –

              The communication limit time unit.

Exceptions