| Column Name | Column Data Type |
|---|
rule_name Required Input Column
The name of the receipt rule. | VARCHAR |
rule_set_name Required Input Column
The name of the receipt rule set that the receipt rule belongs to. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
rule
A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy. | STRUCT(
"name" VARCHAR,
"enabled" BOOLEAN,
"tls_policy" VARCHAR,
"recipients" VARCHAR[],
"actions" STRUCT(
"s3_action" STRUCT(
"topic_arn" VARCHAR,
"bucket_name" VARCHAR,
"object_key_prefix" VARCHAR,
"kms_key_arn" VARCHAR,
"iam_role_arn" VARCHAR
),
"bounce_action" STRUCT(
"topic_arn" VARCHAR,
"smtp_reply_code" VARCHAR,
"status_code" VARCHAR,
"message" VARCHAR,
"sender" VARCHAR
),
"workmail_action" STRUCT(
"topic_arn" VARCHAR,
"organization_arn" VARCHAR
),
"lambda_action" STRUCT(
"topic_arn" VARCHAR,
"function_arn" VARCHAR,
"invocation_type" VARCHAR
),
"stop_action" STRUCT(
"scope" VARCHAR,
"topic_arn" VARCHAR
),
"add_header_action" STRUCT(
"header_name" VARCHAR,
"header_value" VARCHAR
),
"sns_action" STRUCT(
"topic_arn" VARCHAR,
"encoding" VARCHAR
)
)[],
"scan_enabled" BOOLEAN
) |
Show child fields- rule.actions[]
Show child fields- rule.actions[].add_header_action
Adds a header to the received email. Show child fields- rule.actions[].add_header_action.header_name
The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes. - rule.actions[].add_header_action.header_value
The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.
- rule.actions[].bounce_action
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). Show child fields- rule.actions[].bounce_action.message
Human-readable text to include in the bounce message. - rule.actions[].bounce_action.sender
The email address of the sender of the bounced email. This is the address from which the bounce message is sent. - rule.actions[].bounce_action.smtp_reply_code
The SMTP reply code, as defined by RFC 5321. - rule.actions[].bounce_action.status_code
The SMTP enhanced status code, as defined by RFC 3463. - rule.actions[].bounce_action.topic_arn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
- rule.actions[].lambda_action
Calls an Amazon Web Services Lambda function, and optionally, publishes a notification to Amazon SNS. Show child fields- rule.actions[].lambda_action.function_arn
The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An example of an Amazon Web Services Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about Amazon Web Services Lambda, see the Amazon Web Services Lambda Developer Guide. - rule.actions[].lambda_action.invocation_type
The invocation type of the Amazon Web Services Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about Amazon Web Services Lambda invocation types, see the Amazon Web Services Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set. - rule.actions[].lambda_action.topic_arn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
- rule.actions[].s3_action
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS. Show child fields- rule.actions[].s3_action.bucket_name
The name of the Amazon S3 bucket for incoming email. - rule.actions[].s3_action.iam_role_arn
The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket, optionally encrypting your mail via the provided customer managed key, and publishing to the Amazon SNS topic. This role should have access to the following APIs: -
s3:PutObject, kms:Encrypt and kms:GenerateDataKey for the given Amazon S3 bucket. -
kms:GenerateDataKey for the given Amazon Web Services KMS customer managed key. -
sns:Publish for the given Amazon SNS topic. If an IAM role ARN is provided, the role (and only the role) is used to access all the given resources (Amazon S3 bucket, Amazon Web Services KMS customer managed key and Amazon SNS topic). Therefore, setting up individual resource access permissions is not required. - rule.actions[].s3_action.kms_key_arn
The customer managed key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default managed key or a custom managed key that you created in Amazon Web Services KMS as follows: -
To use the default managed key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your Amazon Web Services account ID is 123456789012 and you want to use the default managed key in the US West (Oregon) Region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default managed key, you don't need to perform any extra steps to give Amazon SES permission to use the key. -
To use a custom managed key that you created in Amazon Web Services KMS, provide the ARN of the managed key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the Amazon Web Services KMS Developer Guide. If you do not specify a managed key, Amazon SES does not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your Amazon Web Services KMS keys for decryption. This encryption client is currently available with the Amazon Web Services SDK for Java and Amazon Web Services SDK for Ruby only. For more information about client-side encryption using Amazon Web Services KMS managed keys, see the Amazon S3 Developer Guide. - rule.actions[].s3_action.object_key_prefix
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket. - rule.actions[].s3_action.topic_arn
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
- rule.actions[].sns_action
Publishes the email content within a notification to Amazon SNS. Show child fields- rule.actions[].sns_action.encoding
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8. - rule.actions[].sns_action.topic_arn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
- rule.actions[].stop_action
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS. Show child fields- rule.actions[].stop_action.scope
The scope of the StopAction. The only acceptable value is RuleSet. - rule.actions[].stop_action.topic_arn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. You can find the ARN of a topic by using the ListTopics Amazon SNS operation. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
- rule.actions[].workmail_action
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS. Show child fields- rule.actions[].workmail_action.organization_arn
The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format: arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId> You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide. - rule.actions[].workmail_action.topic_arn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
- rule.enabled
If true, the receipt rule is active. The default value is false. - rule.name
The name of the receipt rule. The name must meet the following requirements: -
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). -
Start and end with a letter or number. -
Contain 64 characters or fewer. - rule.recipients[]
- rule.scan_enabled
If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false. - rule.tls_policy
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
|