ElementalInference / Client / get_dictionary

get_dictionary

ElementalInference.Client.get_dictionary(**kwargs)

Retrieves information about the specified dictionary.

See also: AWS API Documentation

Request Syntax

response = client.get_dictionary(
    id='string'
)
Parameters:

id (string) –

[REQUIRED]

The ID of the dictionary to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    'id': 'string',
    'language': 'eng'|'fra'|'ita'|'deu'|'spa'|'por',
    'status': 'CREATING'|'AVAILABLE'|'REFERENCED'|'DELETING'|'DELETED',
    'references': [
        'string',
    ],
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • name (string) –

      The name of the dictionary.

    • arn (string) –

      The ARN of the dictionary.

    • id (string) –

      The ID of the dictionary.

    • language (string) –

      The language of the dictionary.

    • status (string) –

      The current status of the dictionary.

    • references (list) –

      A list of feed IDs that reference this dictionary.

      • (string) –

    • tags (dict) –

      The tags associated with the dictionary.

      • (string) –

        • (string) –

Exceptions