Get Bucket Inventory Configuration

s3_get_bucket_inventory_configuration

R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by directory buckets.

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 get_bucket_inventory_configuration:

• delete_bucket_inventory_configuration

• list_bucket_inventory_configurations

• put_bucket_inventory_configuration

Usage

s3_get_bucket_inventory_configuration(Bucket, Id, ExpectedBucketOwner)

Arguments

Bucket

[required] The name of the bucket containing the inventory configuration to retrieve.

Id

[required] The ID used to identify the inventory configuration.

ExpectedBucketOwner

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).

Value

A list with the following syntax:

list(
  InventoryConfiguration = list(
    Destination = list(
      S3BucketDestination = list(
        AccountId = "string",
        Bucket = "string",
        Format = "CSV"|"ORC"|"Parquet",
        Prefix = "string",
        Encryption = list(
          SSES3 = list(),
          SSEKMS = list(
            KeyId = "string"
          )
        )
      )
    ),
    IsEnabled = TRUE|FALSE,
    Filter = list(
      Prefix = "string"
    ),
    Id = "string",
    IncludedObjectVersions = "All"|"Current",
    OptionalFields = list(
      "Size"|"LastModifiedDate"|"StorageClass"|"ETag"|"IsMultipartUploaded"|"ReplicationStatus"|"EncryptionStatus"|"ObjectLockRetainUntilDate"|"ObjectLockMode"|"ObjectLockLegalHoldStatus"|"IntelligentTieringAccessTier"|"BucketKeyStatus"|"ChecksumAlgorithm"|"ObjectAccessControlList"|"ObjectOwner"
    ),
    Schedule = list(
      Frequency = "Daily"|"Weekly"
    )
  )
)

Request syntax

svc$get_bucket_inventory_configuration(
  Bucket = "string",
  Id = "string",
  ExpectedBucketOwner = "string"
)