Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3.ListBucketAnalyticsConfigurations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the analytics 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. You should 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 will be 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:GetAnalyticsConfiguration 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 Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

Synopsis

Creating a Request

data ListBucketAnalyticsConfigurations Source #

See: newListBucketAnalyticsConfigurations smart constructor.

Constructors

ListBucketAnalyticsConfigurations'

Fields

continuationToken :: Maybe Text
The ContinuationToken that represents a placeholder from where this request should begin.
expectedBucketOwner :: Maybe Text
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
bucket :: BucketName
The name of the bucket from which analytics configurations are retrieved.

Instances

Instances details

Eq ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods (==) :: ListBucketAnalyticsConfigurations -> ListBucketAnalyticsConfigurations -> Bool # (/=) :: ListBucketAnalyticsConfigurations -> ListBucketAnalyticsConfigurations -> Bool #
Read ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods readsPrec :: Int -> ReadS ListBucketAnalyticsConfigurations # readList :: ReadS [ListBucketAnalyticsConfigurations] # readPrec :: ReadPrec ListBucketAnalyticsConfigurations # readListPrec :: ReadPrec [ListBucketAnalyticsConfigurations] #
Show ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods showsPrec :: Int -> ListBucketAnalyticsConfigurations -> ShowS # show :: ListBucketAnalyticsConfigurations -> String # showList :: [ListBucketAnalyticsConfigurations] -> ShowS #
Generic ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Associated Types type Rep ListBucketAnalyticsConfigurations :: Type -> Type # Methods from :: ListBucketAnalyticsConfigurations -> Rep ListBucketAnalyticsConfigurations x # to :: Rep ListBucketAnalyticsConfigurations x -> ListBucketAnalyticsConfigurations #
NFData ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods rnf :: ListBucketAnalyticsConfigurations -> () #
Hashable ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods hashWithSalt :: Int -> ListBucketAnalyticsConfigurations -> Int # hash :: ListBucketAnalyticsConfigurations -> Int #
AWSRequest ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Associated Types type AWSResponse ListBucketAnalyticsConfigurations # Methods request :: ListBucketAnalyticsConfigurations -> Request ListBucketAnalyticsConfigurations # response :: MonadResource m => Logger -> Service -> Proxy ListBucketAnalyticsConfigurations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBucketAnalyticsConfigurations))) #
ToHeaders ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods toHeaders :: ListBucketAnalyticsConfigurations -> [Header] #
ToPath ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods toPath :: ListBucketAnalyticsConfigurations -> ByteString #
ToQuery ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods toQuery :: ListBucketAnalyticsConfigurations -> QueryString #
type Rep ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations type Rep ListBucketAnalyticsConfigurations = D1 ('MetaData "ListBucketAnalyticsConfigurations" "Amazonka.S3.ListBucketAnalyticsConfigurations" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "ListBucketAnalyticsConfigurations'" '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))))
type AWSResponse ListBucketAnalyticsConfigurations Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations type AWSResponse ListBucketAnalyticsConfigurations = ListBucketAnalyticsConfigurationsResponse

newListBucketAnalyticsConfigurations Source #

Arguments

:: BucketName	`$sel:bucket:ListBucketAnalyticsConfigurations'`
-> ListBucketAnalyticsConfigurations

Create a value of ListBucketAnalyticsConfigurations 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:

$sel:continuationToken:ListBucketAnalyticsConfigurations', listBucketAnalyticsConfigurations_continuationToken - The ContinuationToken that represents a placeholder from where this request should begin.

$sel:expectedBucketOwner:ListBucketAnalyticsConfigurations', listBucketAnalyticsConfigurations_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

$sel:bucket:ListBucketAnalyticsConfigurations', listBucketAnalyticsConfigurations_bucket - The name of the bucket from which analytics configurations are retrieved.

Request Lenses

listBucketAnalyticsConfigurations_continuationToken :: Lens' ListBucketAnalyticsConfigurations (Maybe Text) Source #

The ContinuationToken that represents a placeholder from where this request should begin.

listBucketAnalyticsConfigurations_expectedBucketOwner :: Lens' ListBucketAnalyticsConfigurations (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

listBucketAnalyticsConfigurations_bucket :: Lens' ListBucketAnalyticsConfigurations BucketName Source #

The name of the bucket from which analytics configurations are retrieved.

Destructuring the Response

data ListBucketAnalyticsConfigurationsResponse Source #

See: newListBucketAnalyticsConfigurationsResponse smart constructor.

Constructors

ListBucketAnalyticsConfigurationsResponse'

Fields

analyticsConfigurationList :: Maybe [AnalyticsConfiguration]
The list of analytics configurations for a bucket.
continuationToken :: Maybe Text
The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.
nextContinuationToken :: Maybe Text
NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.
isTruncated :: Maybe Bool
Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListBucketAnalyticsConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods (==) :: ListBucketAnalyticsConfigurationsResponse -> ListBucketAnalyticsConfigurationsResponse -> Bool # (/=) :: ListBucketAnalyticsConfigurationsResponse -> ListBucketAnalyticsConfigurationsResponse -> Bool #
Read ListBucketAnalyticsConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods readsPrec :: Int -> ReadS ListBucketAnalyticsConfigurationsResponse # readList :: ReadS [ListBucketAnalyticsConfigurationsResponse] # readPrec :: ReadPrec ListBucketAnalyticsConfigurationsResponse # readListPrec :: ReadPrec [ListBucketAnalyticsConfigurationsResponse] #
Show ListBucketAnalyticsConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods showsPrec :: Int -> ListBucketAnalyticsConfigurationsResponse -> ShowS # show :: ListBucketAnalyticsConfigurationsResponse -> String # showList :: [ListBucketAnalyticsConfigurationsResponse] -> ShowS #
Generic ListBucketAnalyticsConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Associated Types type Rep ListBucketAnalyticsConfigurationsResponse :: Type -> Type # Methods from :: ListBucketAnalyticsConfigurationsResponse -> Rep ListBucketAnalyticsConfigurationsResponse x # to :: Rep ListBucketAnalyticsConfigurationsResponse x -> ListBucketAnalyticsConfigurationsResponse #
NFData ListBucketAnalyticsConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations Methods rnf :: ListBucketAnalyticsConfigurationsResponse -> () #
type Rep ListBucketAnalyticsConfigurationsResponse Source #
Instance details Defined in Amazonka.S3.ListBucketAnalyticsConfigurations type Rep ListBucketAnalyticsConfigurationsResponse = D1 ('MetaData "ListBucketAnalyticsConfigurationsResponse" "Amazonka.S3.ListBucketAnalyticsConfigurations" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "ListBucketAnalyticsConfigurationsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "analyticsConfigurationList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AnalyticsConfiguration])) :: S1 ('MetaSel ('Just "continuationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextContinuationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListBucketAnalyticsConfigurationsResponse Source #

Arguments

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

Create a value of ListBucketAnalyticsConfigurationsResponse 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:

$sel:analyticsConfigurationList:ListBucketAnalyticsConfigurationsResponse', listBucketAnalyticsConfigurationsResponse_analyticsConfigurationList - The list of analytics configurations for a bucket.

$sel:continuationToken:ListBucketAnalyticsConfigurations', listBucketAnalyticsConfigurationsResponse_continuationToken - The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.

$sel:nextContinuationToken:ListBucketAnalyticsConfigurationsResponse', listBucketAnalyticsConfigurationsResponse_nextContinuationToken - NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.

$sel:isTruncated:ListBucketAnalyticsConfigurationsResponse', listBucketAnalyticsConfigurationsResponse_isTruncated - Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

$sel:httpStatus:ListBucketAnalyticsConfigurationsResponse', listBucketAnalyticsConfigurationsResponse_httpStatus - The response's http status code.

Response Lenses

listBucketAnalyticsConfigurationsResponse_analyticsConfigurationList :: Lens' ListBucketAnalyticsConfigurationsResponse (Maybe [AnalyticsConfiguration]) Source #

The list of analytics configurations for a bucket.

listBucketAnalyticsConfigurationsResponse_continuationToken :: Lens' ListBucketAnalyticsConfigurationsResponse (Maybe Text) Source #

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

listBucketAnalyticsConfigurationsResponse_nextContinuationToken :: Lens' ListBucketAnalyticsConfigurationsResponse (Maybe Text) Source #

NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.

listBucketAnalyticsConfigurationsResponse_isTruncated :: Lens' ListBucketAnalyticsConfigurationsResponse (Maybe Bool) Source #

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

listBucketAnalyticsConfigurationsResponse_httpStatus :: Lens' ListBucketAnalyticsConfigurationsResponse Int Source #

The response's http status code.