DataZone / Client / create_data_product

create_data_product

DataZone.Client.create_data_product(**kwargs)

Creates a data product.

A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access controls. It’s designed to serve specific business needs or use cases, making it easier for users to find and consume data appropriately. Data products include important information about data quality, freshness, and usage guidelines, effectively bridging the gap between data producers and consumers while ensuring proper governance.

Prerequisites:

• The domain must exist and be accessible.

• The owning project must be valid and active.

• The name must be unique within the domain (no existing data product with the same name).

• User must have create permissions for data products in the project.

• The domain must have Amazon DataZone publishing enabled.

See also: AWS API Documentation

Request Syntax

response = client.create_data_product(
    clientToken='string',
    description='string',
    domainIdentifier='string',
    formsInput=[
        {
            'content': 'string',
            'formName': 'string',
            'typeIdentifier': 'string',
            'typeRevision': 'string'
        },
    ],
    glossaryTerms=[
        'string',
    ],
    items=[
        {
            'glossaryTerms': [
                'string',
            ],
            'identifier': 'string',
            'itemType': 'ASSET',
            'revision': 'string'
        },
    ],
    name='string',
    owningProjectIdentifier='string'
)

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 the data product.

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain where the data product is created.

• formsInput (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) – [REQUIRED]

      The name of the metadata form.

    • typeIdentifier (string) –

      The ID of the metadata form type.

    • typeRevision (string) –

      The revision of the metadata form type.

• glossaryTerms (list) –

  The glossary terms of the data product.

  • (string) –

• 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) – [REQUIRED]

      The ID of the data product.

    • itemType (string) – [REQUIRED]

      The type of the data product.

    • revision (string) –

      The revision of the data product.

• name (string) –

  [REQUIRED]

  The name of the data product.

• owningProjectIdentifier (string) –

  [REQUIRED]

  The ID of the owning project 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 was 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 was 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.ServiceQuotaExceededException

• DataZone.Client.exceptions.ConflictException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException