Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.S3.ListBucketInventoryConfigurations

Contents

Description

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

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

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

The following operations are related to ListBucketInventoryConfigurations:

Synopsis

Creating a Request

data ListBucketInventoryConfigurations Source #

See: newListBucketInventoryConfigurations smart constructor.

Constructors

ListBucketInventoryConfigurations'

Fields

continuationToken :: Maybe Text
The marker 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.
expectedBucketOwner :: Maybe Text
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
bucket :: BucketName
The name of the bucket containing the inventory configurations to retrieve.

Instances

Instances details

ToHeaders ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods toHeaders :: ListBucketInventoryConfigurations -> [Header] #
ToPath ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods toPath :: ListBucketInventoryConfigurations -> ByteString #
ToQuery ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods toQuery :: ListBucketInventoryConfigurations -> QueryString #
AWSRequest ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Associated Types type AWSResponse ListBucketInventoryConfigurations # Methods request :: (Service -> Service) -> ListBucketInventoryConfigurations -> Request ListBucketInventoryConfigurations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBucketInventoryConfigurations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBucketInventoryConfigurations))) #
Generic ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Associated Types type Rep ListBucketInventoryConfigurations :: Type -> Type # Methods from :: ListBucketInventoryConfigurations -> Rep ListBucketInventoryConfigurations x # to :: Rep ListBucketInventoryConfigurations x -> ListBucketInventoryConfigurations #
Read ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods readsPrec :: Int -> ReadS ListBucketInventoryConfigurations # readList :: ReadS [ListBucketInventoryConfigurations] # readPrec :: ReadPrec ListBucketInventoryConfigurations # readListPrec :: ReadPrec [ListBucketInventoryConfigurations] #
Show ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods showsPrec :: Int -> ListBucketInventoryConfigurations -> ShowS # show :: ListBucketInventoryConfigurations -> String # showList :: [ListBucketInventoryConfigurations] -> ShowS #
NFData ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods rnf :: ListBucketInventoryConfigurations -> () #
Eq ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods (==) :: ListBucketInventoryConfigurations -> ListBucketInventoryConfigurations -> Bool # (/=) :: ListBucketInventoryConfigurations -> ListBucketInventoryConfigurations -> Bool #
Hashable ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods hashWithSalt :: Int -> ListBucketInventoryConfigurations -> Int # hash :: ListBucketInventoryConfigurations -> Int #
type AWSResponse ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations type AWSResponse ListBucketInventoryConfigurations = ListBucketInventoryConfigurationsResponse
type Rep ListBucketInventoryConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations type Rep ListBucketInventoryConfigurations = D1 ('MetaData "ListBucketInventoryConfigurations" "Amazonka.S3.ListBucketInventoryConfigurations" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "ListBucketInventoryConfigurations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "continuationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName))))

newListBucketInventoryConfigurations Source #

Arguments

:: BucketName	`ListBucketInventoryConfigurations`
-> ListBucketInventoryConfigurations

Create a value of ListBucketInventoryConfigurations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListBucketInventoryConfigurations, listBucketInventoryConfigurations_continuationToken - The marker 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.

$sel:expectedBucketOwner:ListBucketInventoryConfigurations', listBucketInventoryConfigurations_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

ListBucketInventoryConfigurations, listBucketInventoryConfigurations_bucket - The name of the bucket containing the inventory configurations to retrieve.

Request Lenses

listBucketInventoryConfigurations_continuationToken :: Lens' ListBucketInventoryConfigurations (Maybe Text) Source #

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

listBucketInventoryConfigurations_expectedBucketOwner :: Lens' ListBucketInventoryConfigurations (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

listBucketInventoryConfigurations_bucket :: Lens' ListBucketInventoryConfigurations BucketName Source #

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

Destructuring the Response

data ListBucketInventoryConfigurationsResponse Source #

See: newListBucketInventoryConfigurationsResponse smart constructor.

Constructors

ListBucketInventoryConfigurationsResponse'

Fields

continuationToken :: Maybe Text
If sent in the request, the marker that is used as a starting point for this inventory configuration list response.
inventoryConfigurationList :: Maybe [InventoryConfiguration]
The list of inventory configurations for a bucket.
isTruncated :: Maybe Bool
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.
nextContinuationToken :: Maybe Text
The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListBucketInventoryConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Associated Types type Rep ListBucketInventoryConfigurationsResponse :: Type -> Type # Methods from :: ListBucketInventoryConfigurationsResponse -> Rep ListBucketInventoryConfigurationsResponse x # to :: Rep ListBucketInventoryConfigurationsResponse x -> ListBucketInventoryConfigurationsResponse #
Show ListBucketInventoryConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods showsPrec :: Int -> ListBucketInventoryConfigurationsResponse -> ShowS # show :: ListBucketInventoryConfigurationsResponse -> String # showList :: [ListBucketInventoryConfigurationsResponse] -> ShowS #
NFData ListBucketInventoryConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods rnf :: ListBucketInventoryConfigurationsResponse -> () #
Eq ListBucketInventoryConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations Methods (==) :: ListBucketInventoryConfigurationsResponse -> ListBucketInventoryConfigurationsResponse -> Bool # (/=) :: ListBucketInventoryConfigurationsResponse -> ListBucketInventoryConfigurationsResponse -> Bool #
type Rep ListBucketInventoryConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketInventoryConfigurations type Rep ListBucketInventoryConfigurationsResponse = D1 ('MetaData "ListBucketInventoryConfigurationsResponse" "Amazonka.S3.ListBucketInventoryConfigurations" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "ListBucketInventoryConfigurationsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "continuationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "inventoryConfigurationList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InventoryConfiguration]))) :: (S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "nextContinuationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListBucketInventoryConfigurationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListBucketInventoryConfigurationsResponse'`
-> ListBucketInventoryConfigurationsResponse

Create a value of ListBucketInventoryConfigurationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListBucketInventoryConfigurations, listBucketInventoryConfigurationsResponse_continuationToken - If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

$sel:inventoryConfigurationList:ListBucketInventoryConfigurationsResponse', listBucketInventoryConfigurationsResponse_inventoryConfigurationList - The list of inventory configurations for a bucket.

ListBucketInventoryConfigurationsResponse, listBucketInventoryConfigurationsResponse_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.

$sel:nextContinuationToken:ListBucketInventoryConfigurationsResponse', listBucketInventoryConfigurationsResponse_nextContinuationToken - The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

$sel:httpStatus:ListBucketInventoryConfigurationsResponse', listBucketInventoryConfigurationsResponse_httpStatus - The response's http status code.

Response Lenses

listBucketInventoryConfigurationsResponse_continuationToken :: Lens' ListBucketInventoryConfigurationsResponse (Maybe Text) Source #

If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

listBucketInventoryConfigurationsResponse_inventoryConfigurationList :: Lens' ListBucketInventoryConfigurationsResponse (Maybe [InventoryConfiguration]) Source #

The list of inventory configurations for a bucket.

listBucketInventoryConfigurationsResponse_isTruncated :: Lens' ListBucketInventoryConfigurationsResponse (Maybe Bool) Source #

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.

listBucketInventoryConfigurationsResponse_nextContinuationToken :: Lens' ListBucketInventoryConfigurationsResponse (Maybe Text) Source #

The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

listBucketInventoryConfigurationsResponse_httpStatus :: Lens' ListBucketInventoryConfigurationsResponse Int Source #

The response's http status code.