DataZone / Client / create_asset

create_asset

DataZone.Client.create_asset(**kwargs)

Creates an asset in Amazon DataZone catalog.

See also: AWS API Documentation

Request Syntax

response = client.create_asset(
    clientToken='string',
    description='string',
    domainIdentifier='string',
    externalIdentifier='string',
    formsInput=[
        {
            'content': 'string',
            'formName': 'string',
            'typeIdentifier': 'string',
            'typeRevision': 'string'
        },
    ],
    glossaryTerms=[
        'string',
    ],
    name='string',
    owningProjectIdentifier='string',
    predictionConfiguration={
        'businessNameGeneration': {
            'enabled': True|False
        }
    },
    typeIdentifier='string',
    typeRevision='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) – Asset description.

• domainIdentifier (string) –

  [REQUIRED]

  Amazon DataZone domain where the asset is created.

• externalIdentifier (string) – The external identifier of the asset.

• formsInput (list) –

  Metadata forms attached to the asset.

  • (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) –

  Glossary terms attached to the asset.

  • (string) –

• name (string) –

  [REQUIRED]

  Asset name.

• owningProjectIdentifier (string) –

  [REQUIRED]

  The unique identifier of the project that owns this asset.

• predictionConfiguration (dict) –

  The configuration of the automatically generated business-friendly metadata for the asset.

  • businessNameGeneration (dict) –

    The business name generation mechanism.

    • enabled (boolean) –

      Specifies whether the business name generation is enabled.

• typeIdentifier (string) –

  [REQUIRED]

  The unique identifier of this asset’s type.

• typeRevision (string) – The revision of this asset’s type.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'externalIdentifier': 'string',
    'firstRevisionCreatedAt': datetime(2015, 1, 1),
    'firstRevisionCreatedBy': 'string',
    'formsOutput': [
        {
            'content': 'string',
            'formName': 'string',
            'typeName': 'string',
            'typeRevision': 'string'
        },
    ],
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'latestTimeSeriesDataPointFormsOutput': [
        {
            'contentSummary': 'string',
            'formName': 'string',
            'id': 'string',
            'timestamp': datetime(2015, 1, 1),
            'typeIdentifier': 'string',
            'typeRevision': 'string'
        },
    ],
    'listing': {
        'listingId': 'string',
        'listingStatus': 'CREATING'|'ACTIVE'|'INACTIVE'
    },
    'name': 'string',
    'owningProjectId': 'string',
    'predictionConfiguration': {
        'businessNameGeneration': {
            'enabled': True|False
        }
    },
    'readOnlyFormsOutput': [
        {
            'content': 'string',
            'formName': 'string',
            'typeName': 'string',
            'typeRevision': 'string'
        },
    ],
    'revision': 'string',
    'typeIdentifier': 'string',
    'typeRevision': 'string'
}

Response Structure

• (dict) –

  • createdAt (datetime) –

    The timestamp of when the asset was created.

  • createdBy (string) –

    The Amazon DataZone user that created this asset in the catalog.

  • description (string) –

    The description of the created asset.

  • domainId (string) –

    The ID of the Amazon DataZone domain in which the asset was created.

  • externalIdentifier (string) –

    The external identifier of the asset.

  • firstRevisionCreatedAt (datetime) –

    The timestamp of when the first revision of the asset took place.

  • firstRevisionCreatedBy (string) –

    The Amazon DataZone user that made the first revision of the asset.

  • formsOutput (list) –

    The metadata forms that are attached to the created asset.

    • (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 that are attached to the created asset.

    • (string) –

  • id (string) –

    The unique identifier of the created asset.

  • latestTimeSeriesDataPointFormsOutput (list) –

    The latest data point that was imported into the time series form for the asset.

    • (dict) –

      The summary of the time series data points form.

      • contentSummary (string) –

        The content of the summary of the time series data points form.

      • formName (string) –

        The name of the time series data points summary form.

      • id (string) –

        The ID of the time series data points summary form.

      • timestamp (datetime) –

        The timestamp of the time series data points summary form.

      • typeIdentifier (string) –

        The type ID of the time series data points summary form.

      • typeRevision (string) –

        The type revision of the time series data points summary form.

  • listing (dict) –

    The details of an asset published in an Amazon DataZone catalog.

    • listingId (string) –

      The identifier of an asset published in an Amazon DataZone catalog.

    • listingStatus (string) –

      The status of an asset published in an Amazon DataZone catalog.

  • name (string) –

    The name of the created asset.

  • owningProjectId (string) –

    The ID of the Amazon DataZone project that owns the created asset.

  • predictionConfiguration (dict) –

    The configuration of the automatically generated business-friendly metadata for the asset.

    • businessNameGeneration (dict) –

      The business name generation mechanism.

      • enabled (boolean) –

        Specifies whether the business name generation is enabled.

  • readOnlyFormsOutput (list) –

    The read-only metadata forms that are attached to the created asset.

    • (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.

  • revision (string) –

    The revision of the asset.

  • typeIdentifier (string) –

    The identifier of the created asset type.

  • typeRevision (string) –

    The revision type of the asset.

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