identity_notification_topic#

State module to manage AWS SES Identity notification topic.

async idem_aws.states.aws.ses.identity_notification_topic.present(hub, ctx, name: str, identity: str, notification_type: str, sns_topic: str = None, enabled: str = None, resource_id: str = None) → Dict[str, Any][source]#

Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications.

When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified.

Parameters:

  • name (str) – A name for the Identity Notification Topic.

  • identity (str) – The identity (email address or domain) that you want to set the Amazon SNS topic for.

  • notification_type (str) – The type of notifications that will be published to the specified Amazon SNS topic.

  • sns_topic (str, Optional) – The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

  • enabled (bool, Optional) – Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

  • resource_id (str, Optional) – The identifier for AWS Identity Notification Topic, combination of identity, notification topic separated by a separator ‘::’.

Request Syntax:
resource_is_present:
  aws.ses.identity_notification_topic.present:
    - name: "string"
    - identity: "string"
    - notification_type: "string"
    - sns_topic: "string"
Returns:

Dict[str, Any]

Examples

resource_is_present:
  aws.ses.identity_notification_topic.present:
    - name: name
    - identity: user@example.com
    - notification_type: Bounce
    - sns_topic: arn:aws:sns:us-west-2:111122223333:MyTopic
async idem_aws.states.aws.ses.identity_notification_topic.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Clears the SnsTopic and disables the publishing.

Parameters:

  • name (str) – A name for the Identity Notification Topic.

  • resource_id (str, Optional) – The identifier for AWS Identity Notification Topic, combination of identity, notification topic separated by a separator ‘::’.

Request Syntax:
resource_is_absent:
  aws.ses.identity_notification_topic.absent:
    - name: "string"
    - resource_id: "string"
Returns:

Dict[str, Any]

Examples

resource_is_absent:
  aws.ses.identity_notification_topic.absent:
    - name: value
    - resource_id: value
async idem_aws.states.aws.ses.identity_notification_topic.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.ses.identity_notification_topic