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 |
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' {}
- 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' {}
- 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.
CreateVocabulary' | |
|
Instances
:: Text | |
-> Text | |
-> VocabularyLanguageCode | |
-> Text | |
-> 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.
CreateVocabularyResponse' | |
|
Instances
newCreateVocabularyResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> VocabularyState | |
-> 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.