S3 / Client / get_bucket_inventory_configuration

get_bucket_inventory_configuration

S3.Client.get_bucket_inventory_configuration(**kwargs)

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

Note

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format ``https://s3express-control.region-code.amazonaws.com/bucket-name ``. Virtual-hosted-style requests aren’t supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.

Permissions

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner 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.

  • General purpose bucket permissions - The s3:GetInventoryConfiguration permission is required in a policy. For more information about general purpose buckets permissions, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetInventoryConfiguration permission in an IAM identity-based policy instead of a bucket policy. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

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

The following operations are related to GetBucketInventoryConfiguration:

Warning

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

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.

    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name ``. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format ``bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

  • Id (string) –

    [REQUIRED]

    The ID used to identify the inventory configuration.

  • ExpectedBucketOwner (string) –

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    Note

    For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

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'|'ObjectAccessControlList'|'ObjectOwner'|'LifecycleExpirationDate',
        ],
        '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 Key Management Service (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.

        Note

        The following optional fields are supported for directory buckets Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | EncryptionStatus | BucketKeyStatus | ChecksumAlgorithm | LifecycleExpirationDate. Throws MalformedXML error if unsupported optional field is provided.

        • (string) –

      • Schedule (dict) –

        Specifies the schedule for generating inventory results.

        • Frequency (string) –

          Specifies how frequently inventory results are produced.