DataZone / Client / create_glossary

create_glossary

DataZone.Client.create_glossary(**kwargs)

Creates an Amazon DataZone business glossary.

Specifies that this is a create glossary policy.

A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly.

Prerequisites:

  • Domain must exist and be in an active state.

  • Owning project must exist and be accessible by the caller.

  • The glossary name must be unique within the domain.

See also: AWS API Documentation

Request Syntax

response = client.create_glossary(
    clientToken='string',
    description='string',
    domainIdentifier='string',
    name='string',
    owningProjectIdentifier='string',
    status='DISABLED'|'ENABLED',
    usageRestrictions=[
        'ASSET_GOVERNED_TERMS',
    ]
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • description (string) – The description of this business glossary.

  • domainIdentifier (string) –

    [REQUIRED]

    The ID of the Amazon DataZone domain in which this business glossary is created.

  • name (string) –

    [REQUIRED]

    The name of this business glossary.

  • owningProjectIdentifier (string) –

    [REQUIRED]

    The ID of the project that currently owns business glossary.

  • status (string) – The status of this business glossary.

  • usageRestrictions (list) –

    The usage restriction of the restricted glossary.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'description': 'string',
    'domainId': 'string',
    'id': 'string',
    'name': 'string',
    'owningProjectId': 'string',
    'status': 'DISABLED'|'ENABLED',
    'usageRestrictions': [
        'ASSET_GOVERNED_TERMS',
    ]
}

Response Structure

  • (dict) –

    • description (string) –

      The description of this business glossary.

    • domainId (string) –

      The ID of the Amazon DataZone domain in which this business glossary is created.

    • id (string) –

      The ID of this business glossary.

    • name (string) –

      The name of this business glossary.

    • owningProjectId (string) –

      The ID of the project that currently owns this business glossary.

    • status (string) –

      The status of this business glossary.

    • usageRestrictions (list) –

      The usage restriction of the restricted glossary.

      • (string) –

Exceptions