Connect / Client / delete_vocabulary

delete_vocabulary#

Connect.Client.delete_vocabulary(**kwargs)#

Deletes the vocabulary that has the given identifier.

See also: AWS API Documentation

Request Syntax

response = client.delete_vocabulary(
    InstanceId='string',
    VocabularyId='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

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

  • VocabularyId (string) –

    [REQUIRED]

    The identifier of the custom vocabulary.

Return type:

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.

Exceptions