Skip to content

S3Action

Source code in docs_src/capo_mailmanager/types/s3_action.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class S3Action(TypedDict, closed=True):
    action_failure_policy: NotRequired[
        "capo_mailmanager.types.action_failure_policy.ActionFailurePolicy"
    ]
    """<p>A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.</p>"""
    role_arn: "capo_mailmanager.types.iam_role_arn.IamRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.</p>"""
    s3_bucket: "capo_mailmanager.types.s3_bucket.S3Bucket"
    """<p>The bucket name of the S3 bucket to write to.</p>"""
    s3_prefix: NotRequired["capo_mailmanager.types.s3_prefix.S3Prefix"]
    """<p>The S3 prefix to use for the write to the s3 bucket.</p>"""
    s3_sse_kms_key_id: NotRequired["capo_mailmanager.types.kms_key_id.KmsKeyId"]
    """<p>The KMS Key ID to use to encrypt the message in S3.</p>"""

action_failure_policy instance-attribute 

action_failure_policy: NotRequired[ActionFailurePolicy]

A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.

role_arn instance-attribute 

role_arn: IamRoleArn

The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.

s3_bucket instance-attribute 

s3_bucket: S3Bucket

The bucket name of the S3 bucket to write to.

s3_prefix instance-attribute 

s3_prefix: NotRequired[S3Prefix]

The S3 prefix to use for the write to the s3 bucket.

s3_sse_kms_key_id instance-attribute 

s3_sse_kms_key_id: NotRequired[KmsKeyId]

The KMS Key ID to use to encrypt the message in S3.