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.MacieV2.DescribeBuckets

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.

This operation returns paginated results.

Synopsis

data DescribeBuckets = DescribeBuckets' {
- criteria :: Maybe (HashMap Text BucketCriteriaAdditionalProperties)
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- sortCriteria :: Maybe BucketSortCriteria
}
newDescribeBuckets :: DescribeBuckets
describeBuckets_criteria :: Lens' DescribeBuckets (Maybe (HashMap Text BucketCriteriaAdditionalProperties))
describeBuckets_maxResults :: Lens' DescribeBuckets (Maybe Int)
describeBuckets_nextToken :: Lens' DescribeBuckets (Maybe Text)
describeBuckets_sortCriteria :: Lens' DescribeBuckets (Maybe BucketSortCriteria)
data DescribeBucketsResponse = DescribeBucketsResponse' {
- buckets :: Maybe [BucketMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeBucketsResponse :: Int -> DescribeBucketsResponse
describeBucketsResponse_buckets :: Lens' DescribeBucketsResponse (Maybe [BucketMetadata])
describeBucketsResponse_nextToken :: Lens' DescribeBucketsResponse (Maybe Text)
describeBucketsResponse_httpStatus :: Lens' DescribeBucketsResponse Int

Creating a Request

data DescribeBuckets Source #

See: newDescribeBuckets smart constructor.

Constructors

DescribeBuckets'

Fields

criteria :: Maybe (HashMap Text BucketCriteriaAdditionalProperties)
The criteria to use to filter the query results.
maxResults :: Maybe Int
The maximum number of items to include in each page of the response. The default value is 50.
nextToken :: Maybe Text
The nextToken string that specifies which page of results to return in a paginated response.
sortCriteria :: Maybe BucketSortCriteria
The criteria to use to sort the query results.

Instances

Instances details

ToJSON DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods toJSON :: DescribeBuckets -> Value # toEncoding :: DescribeBuckets -> Encoding # toJSONList :: [DescribeBuckets] -> Value # toEncodingList :: [DescribeBuckets] -> Encoding #
ToHeaders DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods toHeaders :: DescribeBuckets -> [Header] #
ToPath DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods toPath :: DescribeBuckets -> ByteString #
ToQuery DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods toQuery :: DescribeBuckets -> QueryString #
AWSPager DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods page :: DescribeBuckets -> AWSResponse DescribeBuckets -> Maybe DescribeBuckets #
AWSRequest DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Associated Types type AWSResponse DescribeBuckets # Methods request :: (Service -> Service) -> DescribeBuckets -> Request DescribeBuckets # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBuckets -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBuckets))) #
Generic DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Associated Types type Rep DescribeBuckets :: Type -> Type # Methods from :: DescribeBuckets -> Rep DescribeBuckets x # to :: Rep DescribeBuckets x -> DescribeBuckets #
Read DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods readsPrec :: Int -> ReadS DescribeBuckets # readList :: ReadS [DescribeBuckets] # readPrec :: ReadPrec DescribeBuckets # readListPrec :: ReadPrec [DescribeBuckets] #
Show DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods showsPrec :: Int -> DescribeBuckets -> ShowS # show :: DescribeBuckets -> String # showList :: [DescribeBuckets] -> ShowS #
NFData DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods rnf :: DescribeBuckets -> () #
Eq DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods (==) :: DescribeBuckets -> DescribeBuckets -> Bool # (/=) :: DescribeBuckets -> DescribeBuckets -> Bool #
Hashable DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods hashWithSalt :: Int -> DescribeBuckets -> Int # hash :: DescribeBuckets -> Int #
type AWSResponse DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets type AWSResponse DescribeBuckets = DescribeBucketsResponse
type Rep DescribeBuckets Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets type Rep DescribeBuckets = D1 ('MetaData "DescribeBuckets" "Amazonka.MacieV2.DescribeBuckets" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "DescribeBuckets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "criteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text BucketCriteriaAdditionalProperties))) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketSortCriteria)))))

newDescribeBuckets :: DescribeBuckets Source #

Create a value of DescribeBuckets 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:criteria:DescribeBuckets', describeBuckets_criteria - The criteria to use to filter the query results.

$sel:maxResults:DescribeBuckets', describeBuckets_maxResults - The maximum number of items to include in each page of the response. The default value is 50.

DescribeBuckets, describeBuckets_nextToken - The nextToken string that specifies which page of results to return in a paginated response.

$sel:sortCriteria:DescribeBuckets', describeBuckets_sortCriteria - The criteria to use to sort the query results.

Request Lenses

describeBuckets_criteria :: Lens' DescribeBuckets (Maybe (HashMap Text BucketCriteriaAdditionalProperties)) Source #

The criteria to use to filter the query results.

describeBuckets_maxResults :: Lens' DescribeBuckets (Maybe Int) Source #

The maximum number of items to include in each page of the response. The default value is 50.

describeBuckets_nextToken :: Lens' DescribeBuckets (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

describeBuckets_sortCriteria :: Lens' DescribeBuckets (Maybe BucketSortCriteria) Source #

The criteria to use to sort the query results.

Destructuring the Response

data DescribeBucketsResponse Source #

See: newDescribeBucketsResponse smart constructor.

Constructors

DescribeBucketsResponse'
Fields buckets :: Maybe [BucketMetadata] An array of objects, one for each bucket that matches the filter criteria specified in the request. nextToken :: Maybe Text The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeBucketsResponse Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Associated Types type Rep DescribeBucketsResponse :: Type -> Type # Methods from :: DescribeBucketsResponse -> Rep DescribeBucketsResponse x # to :: Rep DescribeBucketsResponse x -> DescribeBucketsResponse #
Read DescribeBucketsResponse Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods readsPrec :: Int -> ReadS DescribeBucketsResponse # readList :: ReadS [DescribeBucketsResponse] # readPrec :: ReadPrec DescribeBucketsResponse # readListPrec :: ReadPrec [DescribeBucketsResponse] #
Show DescribeBucketsResponse Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods showsPrec :: Int -> DescribeBucketsResponse -> ShowS # show :: DescribeBucketsResponse -> String # showList :: [DescribeBucketsResponse] -> ShowS #
NFData DescribeBucketsResponse Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods rnf :: DescribeBucketsResponse -> () #
Eq DescribeBucketsResponse Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets Methods (==) :: DescribeBucketsResponse -> DescribeBucketsResponse -> Bool # (/=) :: DescribeBucketsResponse -> DescribeBucketsResponse -> Bool #
type Rep DescribeBucketsResponse Source #
Instance details Defined in Amazonka.MacieV2.DescribeBuckets type Rep DescribeBucketsResponse = D1 ('MetaData "DescribeBucketsResponse" "Amazonka.MacieV2.DescribeBuckets" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "DescribeBucketsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "buckets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BucketMetadata])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeBucketsResponse Source #

Arguments

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

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

DescribeBucketsResponse, describeBucketsResponse_buckets - An array of objects, one for each bucket that matches the filter criteria specified in the request.

DescribeBuckets, describeBucketsResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:httpStatus:DescribeBucketsResponse', describeBucketsResponse_httpStatus - The response's http status code.

Response Lenses

describeBucketsResponse_buckets :: Lens' DescribeBucketsResponse (Maybe [BucketMetadata]) Source #

An array of objects, one for each bucket that matches the filter criteria specified in the request.

describeBucketsResponse_nextToken :: Lens' DescribeBucketsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

describeBucketsResponse_httpStatus :: Lens' DescribeBucketsResponse Int Source #

The response's http status code.