AWS API Changes

2022/01/25 - Amazon Connect Service - 6 new api methods

Changes This release adds support for custom vocabularies to be used with Contact Lens. Custom vocabularies improve transcription accuracy for one or more specific words.

AssociateDefaultVocabulary (new)

Link ¶

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

See also: AWS API Documentation

Request Syntax

client.associate_default_vocabulary(
    InstanceId='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',
    VocabularyId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

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

type LanguageCode

string

param LanguageCode

[REQUIRED]

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

type VocabularyId

string

param VocabularyId

The identifier of the custom vocabulary. If this is empty, the default is set to none.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DeleteVocabulary (new)

Link ¶

Deletes the vocabulary that has the given identifier.

See also: AWS API Documentation

Request Syntax

client.delete_vocabulary(
    InstanceId='string',
    VocabularyId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

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

type VocabularyId

string

param VocabularyId

[REQUIRED]

The identifier of the custom vocabulary.

rtype

dict

returns

Response Syntax

{
    'VocabularyArn': 'string',
    'VocabularyId': 'string',
    'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS'
}

Response Structure

(dict) --
- VocabularyArn (string) --
  
  The Amazon Resource Name (ARN) of the custom vocabulary.
- VocabularyId (string) --
  
  The identifier of the custom vocabulary.
- State (string) --
  
  The current state of the custom vocabulary.

ListDefaultVocabularies (new)

Link ¶

Lists the default vocabularies for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_default_vocabularies(
    InstanceId='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',
    MaxResults=123,
    NextToken='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

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

type LanguageCode

string

param LanguageCode

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

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

type NextToken

string

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

rtype

dict

returns

Response Syntax

{
    'DefaultVocabularyList': [
        {
            'InstanceId': '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',
            'VocabularyId': 'string',
            'VocabularyName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- DefaultVocabularyList (list) --
  
  A list of default vocabularies.
  - (dict) --
    
    Contains information about a default vocabulary.
    - InstanceId (string) --
      
      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
    - LanguageCode (string) --
      
      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    - VocabularyId (string) --
      
      The identifier of the custom vocabulary.
    - VocabularyName (string) --
      
      A unique name of the custom vocabulary.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

DescribeVocabulary (new)

Link ¶

Describes the specified vocabulary.

See also: AWS API Documentation

Request Syntax

client.describe_vocabulary(
    InstanceId='string',
    VocabularyId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

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

type VocabularyId

string

param VocabularyId

[REQUIRED]

The identifier of the custom vocabulary.

rtype

dict

returns

Response Syntax

{
    'Vocabulary': {
        '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',
        'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS',
        'LastModifiedTime': datetime(2015, 1, 1),
        'FailureReason': 'string',
        'Content': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- Vocabulary (dict) --
  
  A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.
  - Name (string) --
    
    A unique name of the custom vocabulary.
  - Id (string) --
    
    The identifier of the custom vocabulary.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the custom vocabulary.
  - LanguageCode (string) --
    
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
  - State (string) --
    
    The current state of the custom vocabulary.
  - LastModifiedTime (datetime) --
    
    The timestamp when the custom vocabulary was last modified.
  - FailureReason (string) --
    
    The reason why the custom vocabulary was not created.
  - Content (string) --
    
    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. For more information, see Create a custom vocabulary using a table .
  - Tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --

CreateVocabulary (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.create_vocabulary(
    ClientToken='string',
    InstanceId='string',
    VocabularyName='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',
    Content='string',
    Tags={
        'string': 'string'
    }
)

type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

This field is autopopulated if not provided.

type InstanceId

string

param InstanceId

[REQUIRED]

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

type VocabularyName

string

param VocabularyName

[REQUIRED]

A unique name of the custom vocabulary.

type LanguageCode

string

param LanguageCode

[REQUIRED]

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

type Content

string

param Content

[REQUIRED]

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 .

type Tags

dict

param Tags

The tags used to organize, track, or control access for this resource.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'VocabularyArn': 'string',
    'VocabularyId': 'string',
    'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS'
}

Response Structure

(dict) --
- VocabularyArn (string) --
  
  The Amazon Resource Name (ARN) of the custom vocabulary.
- VocabularyId (string) --
  
  The identifier of the custom vocabulary.
- State (string) --
  
  The current state of the custom vocabulary.

SearchVocabularies (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.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'
)

type InstanceId

string

param InstanceId

[REQUIRED]

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

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

type NextToken

string

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

type State

string

param State

The current state of the custom vocabulary.

type NameStartsWith

string

param NameStartsWith

The starting pattern of the name of the vocabulary.

type LanguageCode

string

param LanguageCode

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

rtype

dict

returns

Response Syntax

{
    'VocabularySummaryList': [
        {
            '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',
            'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS',
            'LastModifiedTime': datetime(2015, 1, 1),
            'FailureReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VocabularySummaryList (list) --
  
  The list of the available custom vocabularies.
  - (dict) --
    
    Contains summary information about the custom vocabulary.
    - Name (string) --
      
      A unique name of the custom vocabulary.
    - Id (string) --
      
      The identifier of the custom vocabulary.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the custom vocabulary.
    - LanguageCode (string) --
      
      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    - State (string) --
      
      The current state of the custom vocabulary.
    - LastModifiedTime (datetime) --
      
      The timestamp when the custom vocabulary was last modified.
    - FailureReason (string) --
      
      The reason why the custom vocabulary was not created.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.