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.OpenSearchServerless.ListCollections

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Make sure to include an empty request body {} if you don't include any collection filters in the request.

Synopsis

data ListCollections = ListCollections' {
- collectionFilters :: Maybe CollectionFilters
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListCollections :: ListCollections
listCollections_collectionFilters :: Lens' ListCollections (Maybe CollectionFilters)
listCollections_maxResults :: Lens' ListCollections (Maybe Natural)
listCollections_nextToken :: Lens' ListCollections (Maybe Text)
data ListCollectionsResponse = ListCollectionsResponse' {
- collectionSummaries :: Maybe [CollectionSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListCollectionsResponse :: Int -> ListCollectionsResponse
listCollectionsResponse_collectionSummaries :: Lens' ListCollectionsResponse (Maybe [CollectionSummary])
listCollectionsResponse_nextToken :: Lens' ListCollectionsResponse (Maybe Text)
listCollectionsResponse_httpStatus :: Lens' ListCollectionsResponse Int

Creating a Request

data ListCollections Source #

See: newListCollections smart constructor.

Constructors

ListCollections'

Fields

collectionFilters :: Maybe CollectionFilters
List of filter names and values that you can use for requests.
maxResults :: Maybe Natural
The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.
nextToken :: Maybe Text
If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

Instances

Instances details

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

newListCollections :: ListCollections Source #

Create a value of ListCollections 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:collectionFilters:ListCollections', listCollections_collectionFilters - List of filter names and values that you can use for requests.

$sel:maxResults:ListCollections', listCollections_maxResults - The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

ListCollections, listCollections_nextToken - If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

Request Lenses

listCollections_collectionFilters :: Lens' ListCollections (Maybe CollectionFilters) Source #

List of filter names and values that you can use for requests.

listCollections_maxResults :: Lens' ListCollections (Maybe Natural) Source #

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

listCollections_nextToken :: Lens' ListCollections (Maybe Text) Source #

If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

Destructuring the Response

data ListCollectionsResponse Source #

See: newListCollectionsResponse smart constructor.

Constructors

ListCollectionsResponse'
Fields collectionSummaries :: Maybe [CollectionSummary] Details about each collection. nextToken :: Maybe Text When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListCollectionsResponse Source #

Arguments

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

Create a value of ListCollectionsResponse 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:collectionSummaries:ListCollectionsResponse', listCollectionsResponse_collectionSummaries - Details about each collection.

ListCollections, listCollectionsResponse_nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:httpStatus:ListCollectionsResponse', listCollectionsResponse_httpStatus - The response's http status code.

Response Lenses

listCollectionsResponse_collectionSummaries :: Lens' ListCollectionsResponse (Maybe [CollectionSummary]) Source #

Details about each collection.

listCollectionsResponse_nextToken :: Lens' ListCollectionsResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

listCollectionsResponse_httpStatus :: Lens' ListCollectionsResponse Int Source #

The response's http status code.