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

Contents

Description

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 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: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 more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

Synopsis

Creating a Request

data ListBucketMetricsConfigurations Source #

See: newListBucketMetricsConfigurations smart constructor.

Constructors

ListBucketMetricsConfigurations'

Fields

continuationToken :: Maybe Text
The marker that is used to continue a metrics 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 metrics configurations to retrieve.

Instances

Instances details

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

newListBucketMetricsConfigurations Source #

Arguments

:: BucketName	`ListBucketMetricsConfigurations`
-> ListBucketMetricsConfigurations

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

ListBucketMetricsConfigurations, listBucketMetricsConfigurations_continuationToken - The marker that is used to continue a metrics 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:ListBucketMetricsConfigurations', listBucketMetricsConfigurations_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).

ListBucketMetricsConfigurations, listBucketMetricsConfigurations_bucket - The name of the bucket containing the metrics configurations to retrieve.

Request Lenses

listBucketMetricsConfigurations_continuationToken :: Lens' ListBucketMetricsConfigurations (Maybe Text) Source #

The marker that is used to continue a metrics 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.

listBucketMetricsConfigurations_expectedBucketOwner :: Lens' ListBucketMetricsConfigurations (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).

listBucketMetricsConfigurations_bucket :: Lens' ListBucketMetricsConfigurations BucketName Source #

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

Destructuring the Response

data ListBucketMetricsConfigurationsResponse Source #

See: newListBucketMetricsConfigurationsResponse smart constructor.

Constructors

ListBucketMetricsConfigurationsResponse'

Fields

continuationToken :: Maybe Text
The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.
isTruncated :: Maybe Bool
Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
metricsConfigurationList :: Maybe [MetricsConfiguration]
The list of metrics configurations for a bucket.
nextContinuationToken :: Maybe Text
The marker used to continue a metrics 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListBucketMetricsConfigurationsResponse Source #

Arguments

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

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

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

ListBucketMetricsConfigurationsResponse, listBucketMetricsConfigurationsResponse_isTruncated - Indicates whether the returned list of metrics 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:metricsConfigurationList:ListBucketMetricsConfigurationsResponse', listBucketMetricsConfigurationsResponse_metricsConfigurationList - The list of metrics configurations for a bucket.

$sel:nextContinuationToken:ListBucketMetricsConfigurationsResponse', listBucketMetricsConfigurationsResponse_nextContinuationToken - The marker used to continue a metrics 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:httpStatus:ListBucketMetricsConfigurationsResponse', listBucketMetricsConfigurationsResponse_httpStatus - The response's http status code.

Response Lenses

listBucketMetricsConfigurationsResponse_continuationToken :: Lens' ListBucketMetricsConfigurationsResponse (Maybe Text) Source #

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

listBucketMetricsConfigurationsResponse_isTruncated :: Lens' ListBucketMetricsConfigurationsResponse (Maybe Bool) Source #

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

listBucketMetricsConfigurationsResponse_metricsConfigurationList :: Lens' ListBucketMetricsConfigurationsResponse (Maybe [MetricsConfiguration]) Source #

The list of metrics configurations for a bucket.

listBucketMetricsConfigurationsResponse_nextContinuationToken :: Lens' ListBucketMetricsConfigurationsResponse (Maybe Text) Source #

The marker used to continue a metrics 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.

listBucketMetricsConfigurationsResponse_httpStatus :: Lens' ListBucketMetricsConfigurationsResponse Int Source #

The response's http status code.