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.Connect.CreateVocabulary

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

Synopsis

data CreateVocabulary = CreateVocabulary' {
- clientToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- instanceId :: Text
- vocabularyName :: Text
- languageCode :: VocabularyLanguageCode
- content :: Text
}
newCreateVocabulary :: Text -> Text -> VocabularyLanguageCode -> Text -> CreateVocabulary
createVocabulary_clientToken :: Lens' CreateVocabulary (Maybe Text)
createVocabulary_tags :: Lens' CreateVocabulary (Maybe (HashMap Text Text))
createVocabulary_instanceId :: Lens' CreateVocabulary Text
createVocabulary_vocabularyName :: Lens' CreateVocabulary Text
createVocabulary_languageCode :: Lens' CreateVocabulary VocabularyLanguageCode
createVocabulary_content :: Lens' CreateVocabulary Text
data CreateVocabularyResponse = CreateVocabularyResponse' {
- httpStatus :: Int
- vocabularyArn :: Text
- vocabularyId :: Text
- state :: VocabularyState
}
newCreateVocabularyResponse :: Int -> Text -> Text -> VocabularyState -> CreateVocabularyResponse
createVocabularyResponse_httpStatus :: Lens' CreateVocabularyResponse Int
createVocabularyResponse_vocabularyArn :: Lens' CreateVocabularyResponse Text
createVocabularyResponse_vocabularyId :: Lens' CreateVocabularyResponse Text
createVocabularyResponse_state :: Lens' CreateVocabularyResponse VocabularyState

Creating a Request

data CreateVocabulary Source #

See: newCreateVocabulary smart constructor.

Constructors

CreateVocabulary'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
vocabularyName :: Text
A unique name of the custom vocabulary.
languageCode :: VocabularyLanguageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
content :: Text
The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

Instances

Instances details

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

newCreateVocabulary Source #

Arguments

:: Text	`CreateVocabulary`
-> Text	`CreateVocabulary`
-> VocabularyLanguageCode	`CreateVocabulary`
-> Text	`CreateVocabulary`
-> CreateVocabulary

Create a value of CreateVocabulary 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:CreateVocabulary', createVocabulary_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

CreateVocabulary, createVocabulary_tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

CreateVocabulary, createVocabulary_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

CreateVocabulary, createVocabulary_vocabularyName - A unique name of the custom vocabulary.

CreateVocabulary, createVocabulary_languageCode - The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

CreateVocabulary, createVocabulary_content - The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

Request Lenses

createVocabulary_clientToken :: Lens' CreateVocabulary (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

createVocabulary_tags :: Lens' CreateVocabulary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

createVocabulary_instanceId :: Lens' CreateVocabulary Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createVocabulary_vocabularyName :: Lens' CreateVocabulary Text Source #

A unique name of the custom vocabulary.

createVocabulary_languageCode :: Lens' CreateVocabulary VocabularyLanguageCode Source #

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

createVocabulary_content :: Lens' CreateVocabulary Text Source #

The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

Destructuring the Response

data CreateVocabularyResponse Source #

See: newCreateVocabularyResponse smart constructor.

Constructors

CreateVocabularyResponse'
Fields httpStatus :: Int The response's http status code. vocabularyArn :: Text The Amazon Resource Name (ARN) of the custom vocabulary. vocabularyId :: Text The identifier of the custom vocabulary. state :: VocabularyState The current state of the custom vocabulary.

Instances

Instances details

Generic CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Connect.CreateVocabulary Associated Types type Rep CreateVocabularyResponse :: Type -> Type # Methods from :: CreateVocabularyResponse -> Rep CreateVocabularyResponse x # to :: Rep CreateVocabularyResponse x -> CreateVocabularyResponse #
Read CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Connect.CreateVocabulary Methods readsPrec :: Int -> ReadS CreateVocabularyResponse # readList :: ReadS [CreateVocabularyResponse] # readPrec :: ReadPrec CreateVocabularyResponse # readListPrec :: ReadPrec [CreateVocabularyResponse] #
Show CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Connect.CreateVocabulary Methods showsPrec :: Int -> CreateVocabularyResponse -> ShowS # show :: CreateVocabularyResponse -> String # showList :: [CreateVocabularyResponse] -> ShowS #
NFData CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Connect.CreateVocabulary Methods rnf :: CreateVocabularyResponse -> () #
Eq CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Connect.CreateVocabulary Methods (==) :: CreateVocabularyResponse -> CreateVocabularyResponse -> Bool # (/=) :: CreateVocabularyResponse -> CreateVocabularyResponse -> Bool #
type Rep CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Connect.CreateVocabulary type Rep CreateVocabularyResponse = D1 ('MetaData "CreateVocabularyResponse" "Amazonka.Connect.CreateVocabulary" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "CreateVocabularyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "vocabularyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "vocabularyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VocabularyState))))

newCreateVocabularyResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateVocabularyResponse'`
-> Text	`$sel:vocabularyArn:CreateVocabularyResponse'`
-> Text	`CreateVocabularyResponse`
-> VocabularyState	`CreateVocabularyResponse`
-> CreateVocabularyResponse

Create a value of CreateVocabularyResponse 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:httpStatus:CreateVocabularyResponse', createVocabularyResponse_httpStatus - The response's http status code.

$sel:vocabularyArn:CreateVocabularyResponse', createVocabularyResponse_vocabularyArn - The Amazon Resource Name (ARN) of the custom vocabulary.

CreateVocabularyResponse, createVocabularyResponse_vocabularyId - The identifier of the custom vocabulary.

CreateVocabularyResponse, createVocabularyResponse_state - The current state of the custom vocabulary.

Response Lenses

createVocabularyResponse_httpStatus :: Lens' CreateVocabularyResponse Int Source #

The response's http status code.

createVocabularyResponse_vocabularyArn :: Lens' CreateVocabularyResponse Text Source #

The Amazon Resource Name (ARN) of the custom vocabulary.

createVocabularyResponse_vocabularyId :: Lens' CreateVocabularyResponse Text Source #

The identifier of the custom vocabulary.

createVocabularyResponse_state :: Lens' CreateVocabularyResponse VocabularyState Source #

The current state of the custom vocabulary.