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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

This operation returns paginated results.

Synopsis

data SearchVocabularies = SearchVocabularies' {
- languageCode :: Maybe VocabularyLanguageCode
- maxResults :: Maybe Natural
- nameStartsWith :: Maybe Text
- nextToken :: Maybe Text
- state :: Maybe VocabularyState
- instanceId :: Text
}
newSearchVocabularies :: Text -> SearchVocabularies
searchVocabularies_languageCode :: Lens' SearchVocabularies (Maybe VocabularyLanguageCode)
searchVocabularies_maxResults :: Lens' SearchVocabularies (Maybe Natural)
searchVocabularies_nameStartsWith :: Lens' SearchVocabularies (Maybe Text)
searchVocabularies_nextToken :: Lens' SearchVocabularies (Maybe Text)
searchVocabularies_state :: Lens' SearchVocabularies (Maybe VocabularyState)
searchVocabularies_instanceId :: Lens' SearchVocabularies Text
data SearchVocabulariesResponse = SearchVocabulariesResponse' {
- nextToken :: Maybe Text
- vocabularySummaryList :: Maybe [VocabularySummary]
- httpStatus :: Int
}
newSearchVocabulariesResponse :: Int -> SearchVocabulariesResponse
searchVocabulariesResponse_nextToken :: Lens' SearchVocabulariesResponse (Maybe Text)
searchVocabulariesResponse_vocabularySummaryList :: Lens' SearchVocabulariesResponse (Maybe [VocabularySummary])
searchVocabulariesResponse_httpStatus :: Lens' SearchVocabulariesResponse Int

Creating a Request

data SearchVocabularies Source #

See: newSearchVocabularies smart constructor.

Constructors

SearchVocabularies'

Fields

languageCode :: Maybe VocabularyLanguageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
maxResults :: Maybe Natural
The maximum number of results to return per page.
nameStartsWith :: Maybe Text
The starting pattern of the name of the vocabulary.
nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
state :: Maybe VocabularyState
The current state of the custom vocabulary.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

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

newSearchVocabularies Source #

Arguments

:: Text	`SearchVocabularies`
-> SearchVocabularies

Create a value of SearchVocabularies 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:

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

$sel:maxResults:SearchVocabularies', searchVocabularies_maxResults - The maximum number of results to return per page.

$sel:nameStartsWith:SearchVocabularies', searchVocabularies_nameStartsWith - The starting pattern of the name of the vocabulary.

SearchVocabularies, searchVocabularies_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SearchVocabularies, searchVocabularies_state - The current state of the custom vocabulary.

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

Request Lenses

searchVocabularies_languageCode :: Lens' SearchVocabularies (Maybe VocabularyLanguageCode) Source #

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

searchVocabularies_maxResults :: Lens' SearchVocabularies (Maybe Natural) Source #

The maximum number of results to return per page.

searchVocabularies_nameStartsWith :: Lens' SearchVocabularies (Maybe Text) Source #

The starting pattern of the name of the vocabulary.

searchVocabularies_nextToken :: Lens' SearchVocabularies (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

searchVocabularies_state :: Lens' SearchVocabularies (Maybe VocabularyState) Source #

The current state of the custom vocabulary.

searchVocabularies_instanceId :: Lens' SearchVocabularies Text Source #

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

Destructuring the Response

data SearchVocabulariesResponse Source #

See: newSearchVocabulariesResponse smart constructor.

Constructors

SearchVocabulariesResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. vocabularySummaryList :: Maybe [VocabularySummary] The list of the available custom vocabularies. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newSearchVocabulariesResponse Source #

Arguments

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

Create a value of SearchVocabulariesResponse 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:

SearchVocabularies, searchVocabulariesResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:vocabularySummaryList:SearchVocabulariesResponse', searchVocabulariesResponse_vocabularySummaryList - The list of the available custom vocabularies.

$sel:httpStatus:SearchVocabulariesResponse', searchVocabulariesResponse_httpStatus - The response's http status code.

Response Lenses

searchVocabulariesResponse_nextToken :: Lens' SearchVocabulariesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

searchVocabulariesResponse_vocabularySummaryList :: Lens' SearchVocabulariesResponse (Maybe [VocabularySummary]) Source #

The list of the available custom vocabularies.

searchVocabulariesResponse_httpStatus :: Lens' SearchVocabulariesResponse Int Source #

The response's http status code.