DataZone / Client / get_data_product

get_data_product

DataZone.Client.get_data_product(**kwargs)

Gets the data product.

See also: AWS API Documentation

Request Syntax

response = client.get_data_product(
    domainIdentifier='string',
    identifier='string',
    revision='string'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain where the data product lives.

• identifier (string) –

  [REQUIRED]

  The ID of the data product.

• revision (string) – The revision of the data product.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'firstRevisionCreatedAt': datetime(2015, 1, 1),
    'firstRevisionCreatedBy': 'string',
    'formsOutput': [
        {
            'content': 'string',
            'formName': 'string',
            'typeName': 'string',
            'typeRevision': 'string'
        },
    ],
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'items': [
        {
            'glossaryTerms': [
                'string',
            ],
            'identifier': 'string',
            'itemType': 'ASSET',
            'revision': 'string'
        },
    ],
    'name': 'string',
    'owningProjectId': 'string',
    'revision': 'string',
    'status': 'CREATED'|'CREATING'|'CREATE_FAILED'
}

Response Structure

• (dict) –

  • createdAt (datetime) –

    The timestamp at which the data product is created.

  • createdBy (string) –

    The user who created the data product.

  • description (string) –

    The description of the data product.

  • domainId (string) –

    The ID of the domain where the data product lives.

  • firstRevisionCreatedAt (datetime) –

    The timestamp at which the first revision of the data product is created.

  • firstRevisionCreatedBy (string) –

    The user who created the first revision of the data product.

  • formsOutput (list) –

    The metadata forms of the data product.

    • (dict) –

      The details of a metadata form.

      • content (string) –

        The content of the metadata form.

      • formName (string) –

        The name of the metadata form.

      • typeName (string) –

        The name of the metadata form type.

      • typeRevision (string) –

        The revision of the metadata form type.

  • glossaryTerms (list) –

    The glossary terms of the data product.

    • (string) –

  • id (string) –

    The ID of the data product.

  • items (list) –

    The data assets of the data product.

    • (dict) –

      The data product.

      • glossaryTerms (list) –

        The glossary terms of the data product.

        • (string) –

      • identifier (string) –

        The ID of the data product.

      • itemType (string) –

        The type of the data product.

      • revision (string) –

        The revision of the data product.

  • name (string) –

    The name of the data product.

  • owningProjectId (string) –

    The ID of the owning project of the data product.

  • revision (string) –

    The revision of the data product.

  • status (string) –

    The status of the data product.

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