Table Of Contents


User Guide

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

[ aws . s3api ]



Adds 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>
--inventory-configuration <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--bucket (string)

The name of the bucket where the inventory configuration will be stored.

--id (string)

The ID used to identify the inventory configuration.

--inventory-configuration (structure)

Specifies the inventory configuration.

JSON Syntax:

  "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", ...],
  "Schedule": {
    "Frequency": "Daily"|"Weekly"

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