S3 / Client / get_bucket_inventory_configuration

get_bucket_inventory_configuration#

S3.Client.get_bucket_inventory_configuration(**kwargs)#

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

See also: AWS API Documentation

Request Syntax

response = client.get_bucket_inventory_configuration(
    Bucket='string',
    Id='string',
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    The name of the bucket containing the inventory configuration to retrieve.

  • Id (string) –

    [REQUIRED]

    The ID used to identify the inventory configuration.

  • ExpectedBucketOwner (string) – The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Return type:

dict

Returns:

Response Syntax

{
    'InventoryConfiguration': {
        'Destination': {
            'S3BucketDestination': {
                'AccountId': 'string',
                'Bucket': 'string',
                'Format': 'CSV'|'ORC'|'Parquet',
                'Prefix': 'string',
                'Encryption': {
                    'SSES3': {},
                    'SSEKMS': {
                        'KeyId': 'string'
                    }
                }
            }
        },
        'IsEnabled': True|False,
        'Filter': {
            'Prefix': 'string'
        },
        'Id': 'string',
        'IncludedObjectVersions': 'All'|'Current',
        'OptionalFields': [
            'Size'|'LastModifiedDate'|'StorageClass'|'ETag'|'IsMultipartUploaded'|'ReplicationStatus'|'EncryptionStatus'|'ObjectLockRetainUntilDate'|'ObjectLockMode'|'ObjectLockLegalHoldStatus'|'IntelligentTieringAccessTier'|'BucketKeyStatus'|'ChecksumAlgorithm',
        ],
        'Schedule': {
            'Frequency': 'Daily'|'Weekly'
        }
    }
}

Response Structure

  • (dict) –

    • InventoryConfiguration (dict) –

      Specifies the inventory configuration.

      • Destination (dict) –

        Contains information about where to publish the inventory results.

        • S3BucketDestination (dict) –

          Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

          • AccountId (string) –

            The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

            Note

            Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

          • Bucket (string) –

            The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

          • Format (string) –

            Specifies the output format of the inventory results.

          • Prefix (string) –

            The prefix that is prepended to all inventory results.

          • Encryption (dict) –

            Contains the type of server-side encryption used to encrypt the inventory results.

            • SSES3 (dict) –

              Specifies the use of SSE-S3 to encrypt delivered inventory reports.

            • SSEKMS (dict) –

              Specifies the use of SSE-KMS to encrypt delivered inventory reports.

              • KeyId (string) –

                Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key to use for encrypting inventory reports.

      • IsEnabled (boolean) –

        Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

      • Filter (dict) –

        Specifies an inventory filter. The inventory only includes objects that meet the filter’s criteria.

        • Prefix (string) –

          The prefix that an object must have to be included in the inventory results.

      • Id (string) –

        The ID used to identify the inventory configuration.

      • IncludedObjectVersions (string) –

        Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

      • OptionalFields (list) –

        Contains the optional fields that are included in the inventory results.

        • (string) –

      • Schedule (dict) –

        Specifies the schedule for generating inventory results.

        • Frequency (string) –

          Specifies how frequently inventory results are produced.