DataZone / Client / get_glossary

get_glossary#

DataZone.Client.get_glossary(**kwargs)#

Gets a business glossary in Amazon DataZone.

Request Syntax

response = client.get_glossary(
    domainIdentifier='string',
    identifier='string'
)

Parameters:

domainIdentifier (string) –
[REQUIRED]

The ID of the Amazon DataZone domain in which this business glossary exists.
identifier (string) –
[REQUIRED]

The ID of the business glossary.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'id': 'string',
    'name': 'string',
    'owningProjectId': 'string',
    'status': 'DISABLED'|'ENABLED',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

(dict) –
- createdAt (datetime) –
  
  The timestamp of when this business glossary was created.
- createdBy (string) –
  
  The Amazon DataZone user who created this business glossary.
- description (string) –
  
  The description of the business glossary.
- domainId (string) –
  
  The ID of the Amazon DataZone domain in which this business glossary exists.
- id (string) –
  
  The ID of the business glossary.
- name (string) –
  
  The name of the business glossary.
- owningProjectId (string) –
  
  The ID of the project that owns this business glossary.
- status (string) –
  
  The status of the business glossary.
- updatedAt (datetime) –
  
  The timestamp of when the business glossary was updated.
- updatedBy (string) –
  
  The Amazon DataZone user who updated the business glossary.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException