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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration 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 CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

Synopsis

Creating a Request

data GetBucketMetricsConfiguration Source #

See: newGetBucketMetricsConfiguration smart constructor.

Constructors

GetBucketMetricsConfiguration'
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 containing the metrics configuration to retrieve. id :: Text The ID used to identify the metrics configuration.

Instances

Instances details

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

newGetBucketMetricsConfiguration Source #

Arguments

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

Create a value of GetBucketMetricsConfiguration 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:GetBucketMetricsConfiguration', getBucketMetricsConfiguration_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:GetBucketMetricsConfiguration', getBucketMetricsConfiguration_bucket - The name of the bucket containing the metrics configuration to retrieve.

$sel:id:GetBucketMetricsConfiguration', getBucketMetricsConfiguration_id - The ID used to identify the metrics configuration.

Request Lenses

getBucketMetricsConfiguration_expectedBucketOwner :: Lens' GetBucketMetricsConfiguration (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.

getBucketMetricsConfiguration_bucket :: Lens' GetBucketMetricsConfiguration BucketName Source #

The name of the bucket containing the metrics configuration to retrieve.

getBucketMetricsConfiguration_id :: Lens' GetBucketMetricsConfiguration Text Source #

The ID used to identify the metrics configuration.

Destructuring the Response

data GetBucketMetricsConfigurationResponse Source #

See: newGetBucketMetricsConfigurationResponse smart constructor.

Constructors

GetBucketMetricsConfigurationResponse'
Fields metricsConfiguration :: Maybe MetricsConfiguration Specifies the metrics configuration. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetBucketMetricsConfigurationResponse Source #

Arguments

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

Create a value of GetBucketMetricsConfigurationResponse 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:metricsConfiguration:GetBucketMetricsConfigurationResponse', getBucketMetricsConfigurationResponse_metricsConfiguration - Specifies the metrics configuration.

$sel:httpStatus:GetBucketMetricsConfigurationResponse', getBucketMetricsConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

getBucketMetricsConfigurationResponse_metricsConfiguration :: Lens' GetBucketMetricsConfigurationResponse (Maybe MetricsConfiguration) Source #

Specifies the metrics configuration.

getBucketMetricsConfigurationResponse_httpStatus :: Lens' GetBucketMetricsConfigurationResponse Int Source #

The response's http status code.