ConnectCampaignServiceV2 / Client / update_campaign_communication_limits

update_campaign_communication_limits#

ConnectCampaignServiceV2.Client.update_campaign_communication_limits(**kwargs)#

Updates the communication limits config for a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

response = client.update_campaign_communication_limits(
    id='string',
    communicationLimitsOverride={
        'allChannelSubtypes': {
            'communicationLimitsList': [
                {
                    'maxCountPerRecipient': 123,
                    'frequency': 123,
                    'unit': 'DAY'
                },
            ]
        }
    }
)
Parameters:

  • id (string) –

    [REQUIRED]

    Identifier representing a Campaign

  • communicationLimitsOverride (dict) –

    [REQUIRED]

    Communication limits config

    • allChannelSubtypes (dict) –

      Communication limits

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: communicationLimitsList.

      • communicationLimitsList (list) –

        List of communication limit

        • (dict) –

          Communication Limit

          • maxCountPerRecipient (integer) – [REQUIRED]

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

          • frequency (integer) – [REQUIRED]

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

          • unit (string) – [REQUIRED]

            The communication limit time unit.

Returns:

None

Exceptions

  • ConnectCampaignServiceV2.Client.exceptions.InternalServerException

  • ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundException

  • ConnectCampaignServiceV2.Client.exceptions.ValidationException

  • ConnectCampaignServiceV2.Client.exceptions.ConflictException

  • ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignStateException

  • ConnectCampaignServiceV2.Client.exceptions.AccessDeniedException