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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Synopsis

data CreateCollection = CreateCollection' {
- clientToken :: Maybe Text
- description :: Maybe Text
- tags :: Maybe [Tag]
- type' :: Maybe CollectionType
- name :: Text
}
newCreateCollection :: Text -> CreateCollection
createCollection_clientToken :: Lens' CreateCollection (Maybe Text)
createCollection_description :: Lens' CreateCollection (Maybe Text)
createCollection_tags :: Lens' CreateCollection (Maybe [Tag])
createCollection_type :: Lens' CreateCollection (Maybe CollectionType)
createCollection_name :: Lens' CreateCollection Text
data CreateCollectionResponse = CreateCollectionResponse' {
- createCollectionDetail :: Maybe CreateCollectionDetail
- httpStatus :: Int
}
newCreateCollectionResponse :: Int -> CreateCollectionResponse
createCollectionResponse_createCollectionDetail :: Lens' CreateCollectionResponse (Maybe CreateCollectionDetail)
createCollectionResponse_httpStatus :: Lens' CreateCollectionResponse Int

Creating a Request

data CreateCollection Source #

See: newCreateCollection smart constructor.

Constructors

CreateCollection'
Fields clientToken :: Maybe Text Unique, case-sensitive identifier to ensure idempotency of the request. description :: Maybe Text Description of the collection. tags :: Maybe [Tag] An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection. type' :: Maybe CollectionType The type of collection. name :: Text Name of the collection.

Instances

Instances details

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

newCreateCollection Source #

Arguments

:: Text	`CreateCollection`
-> CreateCollection

Create a value of CreateCollection 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:clientToken:CreateCollection', createCollection_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

CreateCollection, createCollection_description - Description of the collection.

$sel:tags:CreateCollection', createCollection_tags - An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

CreateCollection, createCollection_type - The type of collection.

CreateCollection, createCollection_name - Name of the collection.

Request Lenses

createCollection_clientToken :: Lens' CreateCollection (Maybe Text) Source #

Unique, case-sensitive identifier to ensure idempotency of the request.

createCollection_description :: Lens' CreateCollection (Maybe Text) Source #

Description of the collection.

createCollection_tags :: Lens' CreateCollection (Maybe [Tag]) Source #

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

createCollection_type :: Lens' CreateCollection (Maybe CollectionType) Source #

The type of collection.

createCollection_name :: Lens' CreateCollection Text Source #

Name of the collection.

Destructuring the Response

data CreateCollectionResponse Source #

See: newCreateCollectionResponse smart constructor.

Constructors

CreateCollectionResponse'
Fields createCollectionDetail :: Maybe CreateCollectionDetail Details about the collection. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateCollectionResponse Source #

Arguments

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

Create a value of CreateCollectionResponse 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:createCollectionDetail:CreateCollectionResponse', createCollectionResponse_createCollectionDetail - Details about the collection.

$sel:httpStatus:CreateCollectionResponse', createCollectionResponse_httpStatus - The response's http status code.

Response Lenses

createCollectionResponse_createCollectionDetail :: Lens' CreateCollectionResponse (Maybe CreateCollectionDetail) Source #

Details about the collection.

createCollectionResponse_httpStatus :: Lens' CreateCollectionResponse Int Source #

The response's http status code.