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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

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 in the Amazon S3 User Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.

Related Resources

Synopsis

Creating a Request

data GetBucketAnalyticsConfiguration Source #

See: newGetBucketAnalyticsConfiguration smart constructor.

Constructors

GetBucketAnalyticsConfiguration'
Fields 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 an analytics configuration is retrieved. id :: Text The ID that identifies the analytics configuration.

Instances

Instances details

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

newGetBucketAnalyticsConfiguration Source #

Arguments

:: BucketName	`$sel:bucket:GetBucketAnalyticsConfiguration'`
-> Text	`$sel:id:GetBucketAnalyticsConfiguration'`
-> GetBucketAnalyticsConfiguration

Create a value of GetBucketAnalyticsConfiguration 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:expectedBucketOwner:GetBucketAnalyticsConfiguration', getBucketAnalyticsConfiguration_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:GetBucketAnalyticsConfiguration', getBucketAnalyticsConfiguration_bucket - The name of the bucket from which an analytics configuration is retrieved.

$sel:id:GetBucketAnalyticsConfiguration', getBucketAnalyticsConfiguration_id - The ID that identifies the analytics configuration.

Request Lenses

getBucketAnalyticsConfiguration_expectedBucketOwner :: Lens' GetBucketAnalyticsConfiguration (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.

getBucketAnalyticsConfiguration_bucket :: Lens' GetBucketAnalyticsConfiguration BucketName Source #

The name of the bucket from which an analytics configuration is retrieved.

getBucketAnalyticsConfiguration_id :: Lens' GetBucketAnalyticsConfiguration Text Source #

The ID that identifies the analytics configuration.

Destructuring the Response

data GetBucketAnalyticsConfigurationResponse Source #

See: newGetBucketAnalyticsConfigurationResponse smart constructor.

Constructors

GetBucketAnalyticsConfigurationResponse'
Fields analyticsConfiguration :: Maybe AnalyticsConfiguration The configuration and any analyses for the analytics filter. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetBucketAnalyticsConfigurationResponse Source #

Arguments

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

Create a value of GetBucketAnalyticsConfigurationResponse 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:analyticsConfiguration:GetBucketAnalyticsConfigurationResponse', getBucketAnalyticsConfigurationResponse_analyticsConfiguration - The configuration and any analyses for the analytics filter.

$sel:httpStatus:GetBucketAnalyticsConfigurationResponse', getBucketAnalyticsConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

getBucketAnalyticsConfigurationResponse_analyticsConfiguration :: Lens' GetBucketAnalyticsConfigurationResponse (Maybe AnalyticsConfiguration) Source #

The configuration and any analyses for the analytics filter.

getBucketAnalyticsConfigurationResponse_httpStatus :: Lens' GetBucketAnalyticsConfigurationResponse Int Source #

The response's http status code.