Search Vocabularies

connect_search_vocabularies

R Documentation

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

Description¶

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

Usage¶

connect_search_vocabularies(InstanceId, MaxResults, NextToken, State,
  NameStartsWith, LanguageCode)

Arguments¶

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

MaxResults

The maximum number of results to return per page.

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.

State

The current state of the custom vocabulary.

NameStartsWith

The starting pattern of the name of the vocabulary.

LanguageCode

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

Value¶

A list with the following syntax:

list(
  VocabularySummaryList = list(
    list(
      Name = "string",
      Id = "string",
      Arn = "string",
      LanguageCode = "ar-AE"|"de-CH"|"de-DE"|"en-AB"|"en-AU"|"en-GB"|"en-IE"|"en-IN"|"en-US"|"en-WL"|"es-ES"|"es-US"|"fr-CA"|"fr-FR"|"hi-IN"|"it-IT"|"ja-JP"|"ko-KR"|"pt-BR"|"pt-PT"|"zh-CN"|"en-NZ"|"en-ZA"|"ca-ES"|"da-DK"|"fi-FI"|"id-ID"|"ms-MY"|"nl-NL"|"no-NO"|"pl-PL"|"sv-SE"|"tl-PH",
      State = "CREATION_IN_PROGRESS"|"ACTIVE"|"CREATION_FAILED"|"DELETE_IN_PROGRESS",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      FailureReason = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$search_vocabularies(
  InstanceId = "string",
  MaxResults = 123,
  NextToken = "string",
  State = "CREATION_IN_PROGRESS"|"ACTIVE"|"CREATION_FAILED"|"DELETE_IN_PROGRESS",
  NameStartsWith = "string",
  LanguageCode = "ar-AE"|"de-CH"|"de-DE"|"en-AB"|"en-AU"|"en-GB"|"en-IE"|"en-IN"|"en-US"|"en-WL"|"es-ES"|"es-US"|"fr-CA"|"fr-FR"|"hi-IN"|"it-IT"|"ja-JP"|"ko-KR"|"pt-BR"|"pt-PT"|"zh-CN"|"en-NZ"|"en-ZA"|"ca-ES"|"da-DK"|"fi-FI"|"id-ID"|"ms-MY"|"nl-NL"|"no-NO"|"pl-PL"|"sv-SE"|"tl-PH"
)