Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . s3api ]



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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--bucket <value>
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--bucket (string)

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

--id (string)

The ID used to identify the inventory configuration.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


InventoryConfiguration -> (structure)

Specifies the inventory configuration.

Destination -> (structure)

Contains information about where to publish the inventory results.

S3BucketDestination -> (structure)

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

AccountId -> (string)

The ID of the account that owns the destination bucket.

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 -> (structure)

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

SSES3 -> (structure)

Specifies the use of SSE-S3 to encrypt delievered Inventory reports.

SSEKMS -> (structure)

Specifies the use of SSE-KMS to encrypt delievered Inventory reports.

KeyId -> (string)

Specifies the ID of the AWS Key Management Service (KMS) master encryption key to use for encrypting Inventory reports.

IsEnabled -> (boolean)

Specifies whether the inventory is enabled or disabled.

Filter -> (structure)

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)

Specifies which object version(s) to included in the inventory results.

OptionalFields -> (list)

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


Schedule -> (structure)

Specifies the schedule for generating inventory results.

Frequency -> (string)

Specifies how frequently inventory results are produced.