Skip to content

StorageLensConfiguration

Source code in docs_src/capo_s3_control/types/storage_lens_configuration.py
class StorageLensConfiguration(TypedDict, closed=True):
    id: "capo_s3_control.types.config_id.ConfigId"
    """<p>A container for the Amazon S3 Storage Lens configuration ID.</p>"""
    account_level: "capo_s3_control.types.account_level.AccountLevel"
    """<p>A container for all the account-level configurations of your S3 Storage Lens configuration.</p>"""
    include: NotRequired["capo_s3_control.types.include.Include"]
    """<p>A container for what is included in this configuration. This container can only be valid if there is no <code>Exclude</code> container submitted, and it's not empty. </p>"""
    exclude: NotRequired["capo_s3_control.types.exclude.Exclude"]
    """<p>A container for what is excluded in this configuration. This container can only be valid if there is no <code>Include</code> container submitted, and it's not empty. </p>"""
    data_export: NotRequired[
        "capo_s3_control.types.storage_lens_data_export.StorageLensDataExport"
    ]
    """<p>A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.</p>"""
    expanded_prefixes_data_export: NotRequired[
        "capo_s3_control.types.storage_lens_expanded_prefixes_data_export.StorageLensExpandedPrefixesDataExport"
    ]
    """<p>A container that configures your S3 Storage Lens expanded prefixes metrics report. </p>"""
    is_enabled: "capo_s3_control.types.is_enabled.IsEnabled"
    """<p>A container for whether the S3 Storage Lens configuration is enabled.</p>"""
    aws_org: NotRequired["capo_s3_control.types.storage_lens_aws_org.StorageLensAwsOrg"]
    """<p>A container for the Amazon Web Services organization for this S3 Storage Lens configuration.</p>"""
    storage_lens_arn: NotRequired[
        "capo_s3_control.types.storage_lens_arn.StorageLensArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: <code> arn:aws:s3:<i>us-east-1</i>:<i>example-account-id</i>:storage-lens/<i>your-dashboard-name</i> </code> </p>"""
    prefix_delimiter: NotRequired[
        "capo_s3_control.types.storage_lens_prefix_level_delimiter.StorageLensPrefixLevelDelimiter"
    ]
    """<p>A container for all prefix delimiters that are used for object keys in this S3 Storage Lens configuration. The prefix delimiters determine how S3 Storage Lens counts prefix depth, by separating the hierarchical levels in object keys.</p> <note> <ul> <li> <p>If either a prefix delimiter or existing delimiter is undefined, Amazon S3 uses the delimiter that’s defined.</p> </li> <li> <p>If both the prefix delimiter and existing delimiter are undefined, S3 uses <code>/</code> as the default delimiter.</p> </li> <li> <p>When custom delimiters are used, both the prefix delimiter and existing delimiter must specify the same special character. Otherwise, your request results in an error.</p> </li> </ul> </note>"""

account_level instance-attribute

account_level: AccountLevel

A container for all the account-level configurations of your S3 Storage Lens configuration.

aws_org instance-attribute

aws_org: NotRequired[StorageLensAwsOrg]

A container for the Amazon Web Services organization for this S3 Storage Lens configuration.

data_export instance-attribute

data_export: NotRequired[StorageLensDataExport]

A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

exclude instance-attribute

exclude: NotRequired[Exclude]

A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.

expanded_prefixes_data_export instance-attribute

expanded_prefixes_data_export: NotRequired[StorageLensExpandedPrefixesDataExport]

A container that configures your S3 Storage Lens expanded prefixes metrics report.

id instance-attribute

A container for the Amazon S3 Storage Lens configuration ID.

include instance-attribute

include: NotRequired[Include]

A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.

is_enabled instance-attribute

is_enabled: IsEnabled

A container for whether the S3 Storage Lens configuration is enabled.

prefix_delimiter instance-attribute

prefix_delimiter: NotRequired[StorageLensPrefixLevelDelimiter]

A container for all prefix delimiters that are used for object keys in this S3 Storage Lens configuration. The prefix delimiters determine how S3 Storage Lens counts prefix depth, by separating the hierarchical levels in object keys.

  • If either a prefix delimiter or existing delimiter is undefined, Amazon S3 uses the delimiter that’s defined.

  • If both the prefix delimiter and existing delimiter are undefined, S3 uses / as the default delimiter.

  • When custom delimiters are used, both the prefix delimiter and existing delimiter must specify the same special character. Otherwise, your request results in an error.

storage_lens_arn instance-attribute

storage_lens_arn: NotRequired[StorageLensArn]

The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name