Menu
Amazon Simple Storage Service
API Reference (API Version 2006-03-01)

List Bucket Inventory Configurations

Description

This implementation of the GET operation returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

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 in the Amazon Simple Storage Service Developer Guide.

For information about Amazon S3 inventory feature, see Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.

Requests

Syntax

Copy
GET /?inventory HTTP/1.1 Host: BucketName.s3.amazonaws.com Date: date Authorization: authorization string (see Authenticating Requests (AWS Signature Version 4))

Request Parameters

This implementation of GET uses the parameters in the following table.

Parameter Description Required
continuation-token

When the Amazon S3 response to this API call is truncated (that is, when the IsTruncated response element value is true), the response also includes the NextContinuationToken element. You can use the value of this element in the next request as the continuation-token to list the next page. The continuation token is an opaque value that Amazon S3 understands.

Type: String

Default: None

No

Request Elements

This implementation of the operation does not use request elements.

Request Headers

This implementation of the operation uses only request headers that are common to all operations. For more information, see Common Request Headers.

Responses

Response Headers

This implementation of the operation uses only response headers that are common to most responses. For more information, see Common Response Headers.

Response Elements

Name Description
ContinuationToken

The marker that is used as a starting point for this inventory configuration list response. This value is present if it was sent in the request.

Type: String

Ancestor: ListInventoryConfigurationsResult

IsTruncated

Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

Type: Boolean

Ancestor: ListInventoryConfigurationsResult

InventoryConfiguration

Contains the inventory configuration. For the XML structure, see GET Bucket Inventory.

Type: Container

Ancestor: ListInventoryConfigurationsResult

ListInventoryConfigurationsResult

The list of inventory configurations for a bucket.

Type: Container

NextContinuationToken

The marker that is used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

Type: String

Ancestor: ListInventoryConfigurationsResult

Special Errors

This implementation of the operation does not return special errors. For general information about Amazon S3 errors and a list of error codes, see Error Responses.

Examples

Example 1: Listing Inventory Configurations

The following request returns the inventory configurations in example-bucket.

Sample Request

Copy
GET /?inventory HTTP/1.1 Host: example-bucket.s3.amazonaws.com x-amz-date: 20160430T233541Z Authorization: authorization string Content-Type: text/plain

Sample Response

Copy
HTTP/1.1 200 OK x-amz-id-2: gyB+3jRPnrkN98ZajxHXr3u7EFM67bNgSAxexeEHndCX/7GRnfTXxReKUQF28IfP x-amz-request-id: 3B3C7C725673C630 Date: Sat, 30 Apr 2016 23:29:37 GMT Content-Type: application/xml Content-Length: length Connection: close Server: AmazonS3 <?xml version="1.0" encoding="UTF-8"?> <ListInventoryConfigurationsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <InventoryConfiguration> <Id>report1</Id> <IsEnabled>true</IsEnabled> <Destination> <S3BucketDestination> <Format>CSV</Format> <AccountId>123456789012</AccountId> <Bucket>arn:aws:s3:::destination-bucket</Bucket> <Prefix>prefix1</Prefix> </S3BucketDestination> </Destination> <Schedule> <Frequency>Daily</Frequency> </Schedule> <Filter> <Prefix>prefix/One</Prefix> </Filter> <IncludedObjectVersions>All</IncludedObjectVersions> <OptionalFields> <Field>Size</Field> <Field>LastModifiedDate</Field> <Field>ETag</Field> <Field>StorageClass</Field> <Field>IsMultipartUploaded</Field> <Field>ReplicationStatus</Field> </OptionalFields> </InventoryConfiguration> <InventoryConfiguration> <Id>report2</Id> <IsEnabled>true</IsEnabled> <Destination> <S3BucketDestination> <Format>CSV</Format> <AccountId>123456789012</AccountId> <Bucket>arn:aws:s3:::bucket2</Bucket> <Prefix>prefix2</Prefix> </S3BucketDestination> </Destination> <Schedule> <Frequency>Daily</Frequency> </Schedule> <Filter> <Prefix>prefix/Two</Prefix> </Filter> <IncludedObjectVersions>All</IncludedObjectVersions> <OptionalFields> <Field>Size</Field> <Field>LastModifiedDate</Field> <Field>ETag</Field> <Field>StorageClass</Field> <Field>IsMultipartUploaded</Field> <Field>ReplicationStatus</Field> </OptionalFields> </InventoryConfiguration> <InventoryConfiguration> <Id>report3</Id> <IsEnabled>true</IsEnabled> <Destination> <S3BucketDestination> <Format>CSV</Format> <AccountId>123456789012</AccountId> <Bucket>arn:aws:s3:::bucket3</Bucket> <Prefix>prefix3</Prefix> </S3BucketDestination> </Destination> <Schedule> <Frequency>Daily</Frequency> </Schedule> <Filter> <Prefix>prefix/Three</Prefix> </Filter> <IncludedObjectVersions>All</IncludedObjectVersions> <OptionalFields> <Field>Size</Field> <Field>LastModifiedDate</Field> <Field>ETag</Field> <Field>StorageClass</Field> <Field>IsMultipartUploaded</Field> <Field>ReplicationStatus</Field> </OptionalFields> </InventoryConfiguration> ... <IsTruncated>false</IsTruncated> <!-- If ContinuationToken was provided in the request. --> <ContinuationToken>...</ContinuationToken> <!-- if IsTruncated == true --> <IsTruncated>true</IsTruncated> <NextContinuationToken>...</NextContinuationToken> </ListBucketAnalyticsConfigurationResult> </ListInventoryConfigurationsResult>

For an example of using the ContinuationToken with a list, see Example 4: Using a Continuation Token.