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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

This operation returns paginated results.

Synopsis

data SearchResources = SearchResources' {
- bucketCriteria :: Maybe SearchResourcesBucketCriteria
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- sortCriteria :: Maybe SearchResourcesSortCriteria
}
newSearchResources :: SearchResources
searchResources_bucketCriteria :: Lens' SearchResources (Maybe SearchResourcesBucketCriteria)
searchResources_maxResults :: Lens' SearchResources (Maybe Int)
searchResources_nextToken :: Lens' SearchResources (Maybe Text)
searchResources_sortCriteria :: Lens' SearchResources (Maybe SearchResourcesSortCriteria)
data SearchResourcesResponse = SearchResourcesResponse' {
- matchingResources :: Maybe [MatchingResource]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newSearchResourcesResponse :: Int -> SearchResourcesResponse
searchResourcesResponse_matchingResources :: Lens' SearchResourcesResponse (Maybe [MatchingResource])
searchResourcesResponse_nextToken :: Lens' SearchResourcesResponse (Maybe Text)
searchResourcesResponse_httpStatus :: Lens' SearchResourcesResponse Int

Creating a Request

data SearchResources Source #

See: newSearchResources smart constructor.

Constructors

SearchResources'

Fields

bucketCriteria :: Maybe SearchResourcesBucketCriteria
The filter conditions that determine which S3 buckets to include or exclude from 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 SearchResourcesSortCriteria
The criteria to use to sort the results.

Instances

Instances details

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

newSearchResources :: SearchResources Source #

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

SearchResources, searchResources_bucketCriteria - The filter conditions that determine which S3 buckets to include or exclude from the query results.

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

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

$sel:sortCriteria:SearchResources', searchResources_sortCriteria - The criteria to use to sort the results.

Request Lenses

searchResources_bucketCriteria :: Lens' SearchResources (Maybe SearchResourcesBucketCriteria) Source #

The filter conditions that determine which S3 buckets to include or exclude from the query results.

searchResources_maxResults :: Lens' SearchResources (Maybe Int) Source #

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

searchResources_nextToken :: Lens' SearchResources (Maybe Text) Source #

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

searchResources_sortCriteria :: Lens' SearchResources (Maybe SearchResourcesSortCriteria) Source #

The criteria to use to sort the results.

Destructuring the Response

data SearchResourcesResponse Source #

See: newSearchResourcesResponse smart constructor.

Constructors

SearchResourcesResponse'
Fields matchingResources :: Maybe [MatchingResource] An array of objects, one for each resource 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 SearchResourcesResponse Source #
Instance details Defined in Amazonka.MacieV2.SearchResources Associated Types type Rep SearchResourcesResponse :: Type -> Type # Methods from :: SearchResourcesResponse -> Rep SearchResourcesResponse x # to :: Rep SearchResourcesResponse x -> SearchResourcesResponse #
Read SearchResourcesResponse Source #
Instance details Defined in Amazonka.MacieV2.SearchResources Methods readsPrec :: Int -> ReadS SearchResourcesResponse # readList :: ReadS [SearchResourcesResponse] # readPrec :: ReadPrec SearchResourcesResponse # readListPrec :: ReadPrec [SearchResourcesResponse] #
Show SearchResourcesResponse Source #
Instance details Defined in Amazonka.MacieV2.SearchResources Methods showsPrec :: Int -> SearchResourcesResponse -> ShowS # show :: SearchResourcesResponse -> String # showList :: [SearchResourcesResponse] -> ShowS #
NFData SearchResourcesResponse Source #
Instance details Defined in Amazonka.MacieV2.SearchResources Methods rnf :: SearchResourcesResponse -> () #
Eq SearchResourcesResponse Source #
Instance details Defined in Amazonka.MacieV2.SearchResources Methods (==) :: SearchResourcesResponse -> SearchResourcesResponse -> Bool # (/=) :: SearchResourcesResponse -> SearchResourcesResponse -> Bool #
type Rep SearchResourcesResponse Source #
Instance details Defined in Amazonka.MacieV2.SearchResources type Rep SearchResourcesResponse = D1 ('MetaData "SearchResourcesResponse" "Amazonka.MacieV2.SearchResources" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "SearchResourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "matchingResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MatchingResource])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchResourcesResponse Source #

Arguments

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

Create a value of SearchResourcesResponse 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:matchingResources:SearchResourcesResponse', searchResourcesResponse_matchingResources - An array of objects, one for each resource that matches the filter criteria specified in the request.

SearchResources, searchResourcesResponse_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:SearchResourcesResponse', searchResourcesResponse_httpStatus - The response's http status code.

Response Lenses

searchResourcesResponse_matchingResources :: Lens' SearchResourcesResponse (Maybe [MatchingResource]) Source #

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

searchResourcesResponse_nextToken :: Lens' SearchResourcesResponse (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.

searchResourcesResponse_httpStatus :: Lens' SearchResourcesResponse Int Source #

The response's http status code.