Skip to content

S3Config

Source code in docs_src/capo_forecast/types/s3_config.py
class S3Config(TypedDict, closed=True):
    path: "capo_forecast.types.s3_path.S3Path"
    """<p>The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.</p>"""
    role_arn: "capo_forecast.types.arn.Arn"
    """<p>The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the <code>KMSKeyArn</code> key, the role must allow access to the key.</p> <p>Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an <code>InvalidInputException</code> error.</p>"""
    kms_key_arn: NotRequired["capo_forecast.types.kms_key_arn.KMSKeyArn"]
    """<p>The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.</p>"""

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KMSKeyArn]

The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.

path instance-attribute

path: S3Path

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

role_arn instance-attribute

role_arn: Arn

The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.