event_destination#

State module to manage AWS SES event destination.

async idem_aws.states.aws.sesv2.event_destination.present(hub, ctx, name: str, configuration_set_name: str, event_destination: EventDestinationDefinition, resource_id: str = None) → Dict[str, Any][source]#

Create or update an event destination.

Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set can include more than one event destination.

Parameters:

resource_id (str, Optional) – An identifier that identifies the event destination within the configuration set. Defaults to None.
name (str) – A name that identifies the event destination within the configuration set.
configuration_set_name (str) – The name of the configuration set.
event_destination (dict[str, Any]) –
An object that defines the event destination.
- Enabled (bool, Optional):
  If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition. If false, the event destination is disabled. When the event destination is disabled, events aren’t sent to the specified destinations.
- MatchingEventTypes (list[str], Optional):
  An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition.
- KinesisFirehoseDestination (dict[str, Any], Optional):
  An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
  - IamRoleArn (str):
    The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
  - DeliveryStreamArn (str):
    The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
- CloudWatchDestination (dict[str, Any], Optional):
  An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
  - DimensionConfigurations (list[dict[str, Any]]):
    An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
    
    DimensionName (str):
    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
    
    DimensionValueSource (str):
    The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags.
    
    DefaultDimensionValue (str):
    The default value of the dimension that is published to Amazon CloudWatch if you don’t provide the value of the dimension when you send an email. This value has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
- SnsDestination (dict[str, Any], Optional):
  An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
  - TopicArn (str):
    The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
- PinpointDestination (dict[str, Any], Optional):
  An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
  - ApplicationArn (str, Optional):
    The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.

Returns:

{"result": True|False, "comment": ("A tuple",), "ret": None|Dict}

Examples

resource_is_present:
  aws.sesv2.event_destination.present:
    - name: value
    - configuration_set_name: value
    - event_destination: value

async idem_aws.states.aws.sesv2.event_destination.absent(hub, ctx, name: str, configuration_set_name: str = None, resource_id: str = None) → Dict[str, Any][source]#

Delete an event destination.

Parameters:

name (str) – The name of the event destination to delete.
configuration_set_name (str, Optional) – The name of the configuration set that contains the event destination to delete.
resource_id (str, Optional) – An identifier of the resource in the provider.

Returns:

{"result": True|False, "comment": ("A tuple",), "ret": None|Dict}

Examples

resource_is_absent:
  aws.sesv2.event_destination.absent:
    - name: value
    - resource_id: value
    - configuration_set_name: value

async idem_aws.states.aws.sesv2.event_destination.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Returns:: Dict[str, Any]

Examples

idem describe aws.sesv2.event_destination