DataZone / Client / create_asset_revision

create_asset_revision#

DataZone.Client.create_asset_revision(**kwargs)#

Creates a revision of the asset.

See also: AWS API Documentation

Request Syntax

response = client.create_asset_revision(
    clientToken='string',
    description='string',
    domainIdentifier='string',
    formsInput=[
        {
            'content': 'string',
            'formName': 'string',
            'typeIdentifier': 'string',
            'typeRevision': 'string'
        },
    ],
    glossaryTerms=[
        'string',
    ],
    identifier='string',
    name='string',
    predictionConfiguration={
        'businessNameGeneration': {
            'enabled': True|False
        }
    },
    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) – The revised description of the asset.

  • domainIdentifier (string) –

    [REQUIRED]

    The unique identifier of the domain where the asset is being revised.

  • formsInput (list) –

    The metadata forms to be attached to the asset as part of asset revision.

    • (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 to be attached to the asset as part of asset revision.

    • (string) –

  • identifier (string) –

    [REQUIRED]

    The identifier of the asset.

  • name (string) –

    [REQUIRED]

    Te revised name of the 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.

  • typeRevision (string) – The revision type of the asset.

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 revision occured.

    • createdBy (string) –

      The Amazon DataZone user who performed the asset revision.

    • description (string) –

      The revised asset description.

    • domainId (string) –

      The unique identifier of the Amazon DataZone domain where the asset was revised.

    • externalIdentifier (string) –

      The external identifier of the asset.

    • firstRevisionCreatedAt (datetime) –

      The timestamp of when the first asset revision occured.

    • firstRevisionCreatedBy (string) –

      The Amazon DataZone user who performed the first asset revision.

    • formsOutput (list) –

      The metadata forms that were attached to the asset as part of the asset revision.

      • (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 were attached to the asset as part of asset revision.

      • (string) –

    • id (string) –

      The unique identifier of the asset revision.

    • 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 revised name of the asset.

    • owningProjectId (string) –

      The unique identifier of the revised project that owns the 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 were attached to the asset as part of the asset revision.

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

    • typeRevision (string) –

      The revision type of the asset.

Exceptions