ElementalInference / Client / list_dictionaries

list_dictionaries¶

ElementalInference.Client.list_dictionaries(**kwargs)¶

Lists the dictionaries in your account.

Request Syntax

response = client.list_dictionaries(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return per API request. Valid range: 1 to 100.
nextToken (string) – The token that identifies the next batch of results to return.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- dictionaries (list) –
  
  A list of DictionarySummary objects.
  - (dict) –
    
    Contains summary information about a dictionary. Used in the ListDictionaries response.
    - arn (string) –
      
      The ARN of the dictionary.
    - id (string) –
      
      The ID of the dictionary.
    - name (string) –
      
      The name of the dictionary.
    - language (string) –
      
      The language of the dictionary.
    - status (string) –
      
      The status of the dictionary.
- nextToken (string) –
  
  The token to use to retrieve the next batch of results.

Exceptions

ElementalInference.Client.exceptions.ValidationException
ElementalInference.Client.exceptions.InternalServerErrorException
ElementalInference.Client.exceptions.AccessDeniedException
ElementalInference.Client.exceptions.TooManyRequestException