SESV2 / Client / put_configuration_set_vdm_options

put_configuration_set_vdm_options#

SESV2.Client.put_configuration_set_vdm_options(**kwargs)#

Specify VDM preferences for email that you send using the configuration set.

You can execute this operation no more than once per second.

See also: AWS API Documentation

Request Syntax

response = client.put_configuration_set_vdm_options(
    ConfigurationSetName='string',
    VdmOptions={
        'DashboardOptions': {
            'EngagementMetrics': 'ENABLED'|'DISABLED'
        },
        'GuardianOptions': {
            'OptimizedSharedDelivery': 'ENABLED'|'DISABLED'
        }
    }
)
Parameters:
  • ConfigurationSetName (string) –

    [REQUIRED]

    The name of the configuration set.

  • VdmOptions (dict) –

    The VDM options to apply to the configuration set.

    • DashboardOptions (dict) –

      Specifies additional settings for your VDM configuration as applicable to the Dashboard.

      • EngagementMetrics (string) –

        Specifies the status of your VDM engagement metrics collection. Can be one of the following:

        • ENABLED – Amazon SES enables engagement metrics for the configuration set.

        • DISABLED – Amazon SES disables engagement metrics for the configuration set.

    • GuardianOptions (dict) –

      Specifies additional settings for your VDM configuration as applicable to the Guardian.

      • OptimizedSharedDelivery (string) –

        Specifies the status of your VDM optimized shared delivery. Can be one of the following:

        • ENABLED – Amazon SES enables optimized shared delivery for the configuration set.

        • DISABLED – Amazon SES disables optimized shared delivery for the configuration set.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    An HTTP 200 response if the request succeeds, or an error message if the request fails.

Exceptions

  • SESV2.Client.exceptions.NotFoundException

  • SESV2.Client.exceptions.TooManyRequestsException

  • SESV2.Client.exceptions.BadRequestException