DataZone / Client / get_asset

get_asset#

DataZone.Client.get_asset(**kwargs)#

Gets an Amazon DataZone asset.

See also: AWS API Documentation

Request Syntax

response = client.get_asset(
    domainIdentifier='string',
    identifier='string',
    revision='string'
)
Parameters:
  • domainIdentifier (string) –

    [REQUIRED]

    The ID of the Amazon DataZone domain to which the asset belongs.

  • identifier (string) –

    [REQUIRED]

    The ID of the Amazon DataZone asset.

  • revision (string) – The revision of the Amazon DataZone 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',
    '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 who created the asset.

    • description (string) –

      The description of the Amazon DataZone asset.

    • domainId (string) –

      The ID of the Amazon DataZone domain to which the asset belongs.

    • externalIdentifier (string) –

      The external ID of the asset.

    • firstRevisionCreatedAt (datetime) –

      The timestamp of when the first revision of the asset was created.

    • firstRevisionCreatedBy (string) –

      The Amazon DataZone user who created the first revision of the asset.

    • formsOutput (list) –

      The metadata forms attached to the 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 business glossary terms attached to the asset.

      • (string) –

    • id (string) –

      The ID of the 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 listing of the asset.

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

    • owningProjectId (string) –

      The ID of the project that owns the asset.

    • readOnlyFormsOutput (list) –

      The read-only metadata forms attached to the 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 ID of the asset type.

    • typeRevision (string) –

      The revision of the asset type.

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