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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Synopsis

data BatchGetCollection = BatchGetCollection' {
- ids :: Maybe (NonEmpty Text)
- names :: Maybe (NonEmpty Text)
}
newBatchGetCollection :: BatchGetCollection
batchGetCollection_ids :: Lens' BatchGetCollection (Maybe (NonEmpty Text))
batchGetCollection_names :: Lens' BatchGetCollection (Maybe (NonEmpty Text))
data BatchGetCollectionResponse = BatchGetCollectionResponse' {
- collectionDetails :: Maybe [CollectionDetail]
- collectionErrorDetails :: Maybe [CollectionErrorDetail]
- httpStatus :: Int
}
newBatchGetCollectionResponse :: Int -> BatchGetCollectionResponse
batchGetCollectionResponse_collectionDetails :: Lens' BatchGetCollectionResponse (Maybe [CollectionDetail])
batchGetCollectionResponse_collectionErrorDetails :: Lens' BatchGetCollectionResponse (Maybe [CollectionErrorDetail])
batchGetCollectionResponse_httpStatus :: Lens' BatchGetCollectionResponse Int

Creating a Request

data BatchGetCollection Source #

See: newBatchGetCollection smart constructor.

Constructors

BatchGetCollection'
Fields ids :: Maybe (NonEmpty Text) A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API. names :: Maybe (NonEmpty Text) A list of collection names. You can't provide names and IDs in the same request.

Instances

Instances details

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

newBatchGetCollection :: BatchGetCollection Source #

Create a value of BatchGetCollection 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:ids:BatchGetCollection', batchGetCollection_ids - A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

$sel:names:BatchGetCollection', batchGetCollection_names - A list of collection names. You can't provide names and IDs in the same request.

Request Lenses

batchGetCollection_ids :: Lens' BatchGetCollection (Maybe (NonEmpty Text)) Source #

A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

batchGetCollection_names :: Lens' BatchGetCollection (Maybe (NonEmpty Text)) Source #

A list of collection names. You can't provide names and IDs in the same request.

Destructuring the Response

data BatchGetCollectionResponse Source #

See: newBatchGetCollectionResponse smart constructor.

Constructors

BatchGetCollectionResponse'
Fields collectionDetails :: Maybe [CollectionDetail] Details about each collection. collectionErrorDetails :: Maybe [CollectionErrorDetail] Error information for the request. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newBatchGetCollectionResponse Source #

Arguments

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

Create a value of BatchGetCollectionResponse 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:collectionDetails:BatchGetCollectionResponse', batchGetCollectionResponse_collectionDetails - Details about each collection.

$sel:collectionErrorDetails:BatchGetCollectionResponse', batchGetCollectionResponse_collectionErrorDetails - Error information for the request.

$sel:httpStatus:BatchGetCollectionResponse', batchGetCollectionResponse_httpStatus - The response's http status code.

Response Lenses

batchGetCollectionResponse_collectionDetails :: Lens' BatchGetCollectionResponse (Maybe [CollectionDetail]) Source #

Details about each collection.

batchGetCollectionResponse_collectionErrorDetails :: Lens' BatchGetCollectionResponse (Maybe [CollectionErrorDetail]) Source #

Error information for the request.

batchGetCollectionResponse_httpStatus :: Lens' BatchGetCollectionResponse Int Source #

The response's http status code.