Amazon DataZone

2024/08/05 - Amazon DataZone - 5 new 15 updated api methods

Changes  This releases Data Product feature. Data Products allow grouping data assets into cohesive, self-contained units for ease of publishing for data producers, and ease of finding and accessing for data consumers.

GetDataProduct (new) Link ¶

Gets the data product.

See also: AWS API Documentation

Request Syntax

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

string

param domainIdentifier

[REQUIRED]

The ID of the domain where the data product lives.

type identifier

string

param identifier

[REQUIRED]

The ID of the data product.

type revision

string

param revision

The revision of the data product.

rtype

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.

CreateDataProductRevision (new) Link ¶

Creates a data product revision.

See also: AWS API Documentation

Request Syntax

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

string

param clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

This field is autopopulated if not provided.

type description

string

param description

The description of the data product revision.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

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

type formsInput

list

param formsInput

The metadata forms of the data product 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.

type glossaryTerms

list

param glossaryTerms

The glossary terms of the data product revision.

  • (string) --

type identifier

string

param identifier

[REQUIRED]

The ID of the data product revision.

type items

list

param items

The data assets of the data product revision.

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

type name

string

param name

[REQUIRED]

The name of the data product revision.

rtype

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 revision is created.

    • createdBy (string) --

      The user who created the data product revision.

    • description (string) --

      The description of the data product revision.

    • domainId (string) --

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

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

      • (string) --

    • id (string) --

      The ID of the data product revision.

    • items (list) --

      The data assets of the data product revision.

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

    • owningProjectId (string) --

      The ID of the owning project of the data product revision.

    • revision (string) --

      The revision of the data product revision.

    • status (string) --

      The status of the data product revision.

DeleteDataProduct (new) Link ¶

Deletes an data product in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.delete_data_product(
    domainIdentifier='string',
    identifier='string'
)
type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the Amazon DataZone domain in which the data product is deleted.

type identifier

string

param identifier

[REQUIRED]

The identifier of the data product that is deleted.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListDataProductRevisions (new) Link ¶

Lists data product revisions.

See also: AWS API Documentation

Request Syntax

client.list_data_product_revisions(
    domainIdentifier='string',
    identifier='string',
    maxResults=123,
    nextToken='string'
)
type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the domain of the data product revisions that you want to list.

type identifier

string

param identifier

[REQUIRED]

The ID of the data product revision.

type maxResults

integer

param maxResults

The maximum number of asset filters to return in a single call to ListDataProductRevisions . When the number of data product revisions to be listed is greater than the value of MaxResults , the response contains a NextToken value that you can use in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

type nextToken

string

param nextToken

When the number of data product revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data product revisions, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'domainId': 'string',
            'id': 'string',
            'revision': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      The results of the ListDataProductRevisions action.

      • (dict) --

        The data product revision.

        • createdAt (datetime) --

          The timestamp at which the data product revision was created.

        • createdBy (string) --

          The user who created the data product revision.

        • domainId (string) --

          The ID of the domain where the data product revision lives.

        • id (string) --

          The ID of the data product revision.

        • revision (string) --

          The data product revision.

    • nextToken (string) --

      When the number of data product revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data product revisions, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

CreateDataProduct (new) Link ¶

Creates a data product.

See also: AWS API Documentation

Request Syntax

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'
)
type clientToken

string

param clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

This field is autopopulated if not provided.

type description

string

param description

The description of the data product.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

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

type formsInput

list

param formsInput

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.

type glossaryTerms

list

param glossaryTerms

The glossary terms of the data product.

  • (string) --

type items

list

param items

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.

type name

string

param name

[REQUIRED]

The name of the data product.

type owningProjectIdentifier

string

param owningProjectIdentifier

[REQUIRED]

The ID of the owning project of the data product.

rtype

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.

AcceptSubscriptionRequest (updated) Link ¶
Changes (response)
{'subscribedListings': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                       'entityRevision': 'string',
                                                                       'entityType': 'string'}],
                                                    'description': 'string',
                                                    'entityId': 'string',
                                                    'entityRevision': 'string',
                                                    'glossaryTerms': [{'name': 'string',
                                                                       'shortDescription': 'string'}],
                                                    'name': 'string'}}}}

Accepts a subscription request to a specific asset.

See also: AWS API Documentation

Request Syntax

client.accept_subscription_request(
    decisionComment='string',
    domainIdentifier='string',
    identifier='string'
)
type decisionComment

string

param decisionComment

A description that specifies the reason for accepting the specified subscription request.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The Amazon DataZone domain where the specified subscription request is being accepted.

type identifier

string

param identifier

[REQUIRED]

The unique identifier of the subscription request that is to be accepted.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'decisionComment': 'string',
    'domainId': 'string',
    'id': 'string',
    'requestReason': 'string',
    'reviewerId': 'string',
    'status': 'PENDING'|'ACCEPTED'|'REJECTED',
    'subscribedListings': [
        {
            'description': 'string',
            'id': 'string',
            'item': {
                'assetListing': {
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'entityType': 'string',
                    'forms': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ]
                },
                'productListing': {
                    'assetListings': [
                        {
                            'entityId': 'string',
                            'entityRevision': 'string',
                            'entityType': 'string'
                        },
                    ],
                    'description': 'string',
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ],
                    'name': 'string'
                }
            },
            'name': 'string',
            'ownerProjectId': 'string',
            'ownerProjectName': 'string',
            'revision': 'string'
        },
    ],
    'subscribedPrincipals': [
        {
            'project': {
                'id': 'string',
                'name': 'string'
            }
        },
    ],
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp that specifies when the subscription request was accepted.

    • createdBy (string) --

      Specifies the Amazon DataZone user that accepted the specified subscription request.

    • decisionComment (string) --

      Specifies the reason for accepting the subscription request.

    • domainId (string) --

      The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted.

    • id (string) --

      The identifier of the subscription request.

    • requestReason (string) --

      Specifies the reason for requesting a subscription to the asset.

    • reviewerId (string) --

      Specifes the ID of the Amazon DataZone user who reviewed the subscription request.

    • status (string) --

      Specifies the status of the subscription request.

    • subscribedListings (list) --

      Specifies the asset for which the subscription request was created.

      • (dict) --

        The details of the published asset for which the subscription grant is created.

        • description (string) --

          The description of the published asset for which the subscription grant is created.

        • id (string) --

          The identifier of the published asset for which the subscription grant is created.

        • item (dict) --

          The published asset for which the subscription grant is created.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • entityId (string) --

              The identifier of the published asset for which the subscription grant is created.

            • entityRevision (string) --

              The revision of the published asset for which the subscription grant is created.

            • entityType (string) --

              The type of the published asset for which the subscription grant is created.

            • forms (string) --

              The forms attached to the published asset for which the subscription grant is created.

            • glossaryTerms (list) --

              The glossary terms attached to the published asset for which the subscription grant is created.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

          • productListing (dict) --

            The data product listing.

            • assetListings (list) --

              The data assets of the data product listing.

              • (dict) --

                The listing of the asset in a data product.

                • entityId (string) --

                  The entity ID of the listing of the asset in a data product.

                • entityRevision (string) --

                  The entity revision of the listing of the asset in a data product.

                • entityType (string) --

                  The entity type of the listing of the asset in a data product.

            • description (string) --

              The description of the data product listing.

            • entityId (string) --

              The ID of the data product listing.

            • entityRevision (string) --

              The revision of the data product listing.

            • glossaryTerms (list) --

              The glossary terms of the data product listing.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

            • name (string) --

              The name of the data product listing.

        • name (string) --

          The name of the published asset for which the subscription grant is created.

        • ownerProjectId (string) --

          The identifier of the project of the published asset for which the subscription grant is created.

        • ownerProjectName (string) --

          The name of the project that owns the published asset for which the subscription grant is created.

        • revision (string) --

          The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipals (list) --

      Specifies the Amazon DataZone users who are subscribed to the asset specified in the subscription request.

      • (dict) --

        The principal that has the subscription grant for the asset.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • project (dict) --

          The project that has the subscription grant.

          • id (string) --

            The identifier of the project that has the subscription grant.

          • name (string) --

            The name of the project that has the subscription grant.

    • updatedAt (datetime) --

      Specifies the timestamp when subscription request was updated.

    • updatedBy (string) --

      Specifies the Amazon DataZone user who updated the subscription request.

CancelSubscription (updated) Link ¶
Changes (response)
{'subscribedListing': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                      'entityRevision': 'string',
                                                                      'entityType': 'string'}],
                                                   'description': 'string',
                                                   'entityId': 'string',
                                                   'entityRevision': 'string',
                                                   'glossaryTerms': [{'name': 'string',
                                                                      'shortDescription': 'string'}],
                                                   'name': 'string'}}}}

Cancels the subscription to the specified asset.

See also: AWS API Documentation

Request Syntax

client.cancel_subscription(
    domainIdentifier='string',
    identifier='string'
)
type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.

type identifier

string

param identifier

[REQUIRED]

The unique identifier of the subscription that is being cancelled.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'domainId': 'string',
    'id': 'string',
    'retainPermissions': True|False,
    'status': 'APPROVED'|'REVOKED'|'CANCELLED',
    'subscribedListing': {
        'description': 'string',
        'id': 'string',
        'item': {
            'assetListing': {
                'entityId': 'string',
                'entityRevision': 'string',
                'entityType': 'string',
                'forms': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ]
            },
            'productListing': {
                'assetListings': [
                    {
                        'entityId': 'string',
                        'entityRevision': 'string',
                        'entityType': 'string'
                    },
                ],
                'description': 'string',
                'entityId': 'string',
                'entityRevision': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ],
                'name': 'string'
            }
        },
        'name': 'string',
        'ownerProjectId': 'string',
        'ownerProjectName': 'string',
        'revision': 'string'
    },
    'subscribedPrincipal': {
        'project': {
            'id': 'string',
            'name': 'string'
        }
    },
    'subscriptionRequestId': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp that specifies when the request to cancel the subscription was created.

    • createdBy (string) --

      Specifies the Amazon DataZone user who is cancelling the subscription.

    • domainId (string) --

      The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.

    • id (string) --

      The identifier of the subscription.

    • retainPermissions (boolean) --

      Specifies whether the permissions to the asset are retained after the subscription is cancelled.

    • status (string) --

      The status of the request to cancel the subscription.

    • subscribedListing (dict) --

      The asset to which a subscription is being cancelled.

      • description (string) --

        The description of the published asset for which the subscription grant is created.

      • id (string) --

        The identifier of the published asset for which the subscription grant is created.

      • item (dict) --

        The published asset for which the subscription grant is created.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • assetListing (dict) --

          The asset for which the subscription grant is created.

          • entityId (string) --

            The identifier of the published asset for which the subscription grant is created.

          • entityRevision (string) --

            The revision of the published asset for which the subscription grant is created.

          • entityType (string) --

            The type of the published asset for which the subscription grant is created.

          • forms (string) --

            The forms attached to the published asset for which the subscription grant is created.

          • glossaryTerms (list) --

            The glossary terms attached to the published asset for which the subscription grant is created.

            • (dict) --

              Details of a glossary term attached to the inventory asset.

              • name (string) --

                The name of a glossary term attached to the inventory asset.

              • shortDescription (string) --

                The shoft description of a glossary term attached to the inventory asset.

        • productListing (dict) --

          The data product listing.

          • assetListings (list) --

            The data assets of the data product listing.

            • (dict) --

              The listing of the asset in a data product.

              • entityId (string) --

                The entity ID of the listing of the asset in a data product.

              • entityRevision (string) --

                The entity revision of the listing of the asset in a data product.

              • entityType (string) --

                The entity type of the listing of the asset in a data product.

          • description (string) --

            The description of the data product listing.

          • entityId (string) --

            The ID of the data product listing.

          • entityRevision (string) --

            The revision of the data product listing.

          • glossaryTerms (list) --

            The glossary terms of the data product listing.

            • (dict) --

              Details of a glossary term attached to the inventory asset.

              • name (string) --

                The name of a glossary term attached to the inventory asset.

              • shortDescription (string) --

                The shoft description of a glossary term attached to the inventory asset.

          • name (string) --

            The name of the data product listing.

      • name (string) --

        The name of the published asset for which the subscription grant is created.

      • ownerProjectId (string) --

        The identifier of the project of the published asset for which the subscription grant is created.

      • ownerProjectName (string) --

        The name of the project that owns the published asset for which the subscription grant is created.

      • revision (string) --

        The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipal (dict) --

      The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      • project (dict) --

        The project that has the subscription grant.

        • id (string) --

          The identifier of the project that has the subscription grant.

        • name (string) --

          The name of the project that has the subscription grant.

    • subscriptionRequestId (string) --

      The unique ID of the subscripton request for the subscription that is being cancelled.

    • updatedAt (datetime) --

      The timestamp that specifies when the subscription was cancelled.

    • updatedBy (string) --

      The Amazon DataZone user that cancelled the subscription.

CreateListingChangeSet (updated) Link ¶
Changes (request)
{'entityType': {'DATA_PRODUCT'}}

Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.

See also: AWS API Documentation

Request Syntax

client.create_listing_change_set(
    action='PUBLISH'|'UNPUBLISH',
    clientToken='string',
    domainIdentifier='string',
    entityIdentifier='string',
    entityRevision='string',
    entityType='ASSET'|'DATA_PRODUCT'
)
type action

string

param action

[REQUIRED]

Specifies whether to publish or unpublish a listing.

type clientToken

string

param clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

This field is autopopulated if not provided.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the Amazon DataZone domain.

type entityIdentifier

string

param entityIdentifier

[REQUIRED]

The ID of the asset.

type entityRevision

string

param entityRevision

The revision of an asset.

type entityType

string

param entityType

[REQUIRED]

The type of an entity.

rtype

dict

returns

Response Syntax

{
    'listingId': 'string',
    'listingRevision': 'string',
    'status': 'CREATING'|'ACTIVE'|'INACTIVE'
}

Response Structure

  • (dict) --

    • listingId (string) --

      The ID of the listing (a record of an asset at a given time).

    • listingRevision (string) --

      The revision of a listing.

    • status (string) --

      Specifies the status of the listing.

CreateSubscriptionRequest (updated) Link ¶
Changes (response)
{'subscribedListings': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                       'entityRevision': 'string',
                                                                       'entityType': 'string'}],
                                                    'description': 'string',
                                                    'entityId': 'string',
                                                    'entityRevision': 'string',
                                                    'glossaryTerms': [{'name': 'string',
                                                                       'shortDescription': 'string'}],
                                                    'name': 'string'}}}}

Creates a subscription request in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.create_subscription_request(
    clientToken='string',
    domainIdentifier='string',
    requestReason='string',
    subscribedListings=[
        {
            'identifier': 'string'
        },
    ],
    subscribedPrincipals=[
        {
            'project': {
                'identifier': 'string'
            }
        },
    ]
)
type clientToken

string

param clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

This field is autopopulated if not provided.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the Amazon DataZone domain in which the subscription request is created.

type requestReason

string

param requestReason

[REQUIRED]

The reason for the subscription request.

type subscribedListings

list

param subscribedListings

[REQUIRED]

The published asset for which the subscription grant is to be created.

  • (dict) --

    The published asset for which the subscription grant is to be created.

    • identifier (string) -- [REQUIRED]

      The identifier of the published asset for which the subscription grant is to be created.

type subscribedPrincipals

list

param subscribedPrincipals

[REQUIRED]

The Amazon DataZone principals for whom the subscription request is created.

  • (dict) --

    The principal that is to be given a subscriptiong grant.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: project.

    • project (dict) --

      The project that is to be given a subscription grant.

      • identifier (string) --

        The identifier of the project that is to be given a subscription grant.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'decisionComment': 'string',
    'domainId': 'string',
    'id': 'string',
    'requestReason': 'string',
    'reviewerId': 'string',
    'status': 'PENDING'|'ACCEPTED'|'REJECTED',
    'subscribedListings': [
        {
            'description': 'string',
            'id': 'string',
            'item': {
                'assetListing': {
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'entityType': 'string',
                    'forms': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ]
                },
                'productListing': {
                    'assetListings': [
                        {
                            'entityId': 'string',
                            'entityRevision': 'string',
                            'entityType': 'string'
                        },
                    ],
                    'description': 'string',
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ],
                    'name': 'string'
                }
            },
            'name': 'string',
            'ownerProjectId': 'string',
            'ownerProjectName': 'string',
            'revision': 'string'
        },
    ],
    'subscribedPrincipals': [
        {
            'project': {
                'id': 'string',
                'name': 'string'
            }
        },
    ],
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      A timestamp of when the subscription request is created.

    • createdBy (string) --

      The Amazon DataZone user who created the subscription request.

    • decisionComment (string) --

      The decision comment of the subscription request.

    • domainId (string) --

      The ID of the Amazon DataZone domain in whcih the subscription request is created.

    • id (string) --

      The ID of the subscription request.

    • requestReason (string) --

      The reason for the subscription request.

    • reviewerId (string) --

      The ID of the reviewer of the subscription request.

    • status (string) --

      The status of the subscription request.

    • subscribedListings (list) --

      The published asset for which the subscription grant is to be created.

      • (dict) --

        The details of the published asset for which the subscription grant is created.

        • description (string) --

          The description of the published asset for which the subscription grant is created.

        • id (string) --

          The identifier of the published asset for which the subscription grant is created.

        • item (dict) --

          The published asset for which the subscription grant is created.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • entityId (string) --

              The identifier of the published asset for which the subscription grant is created.

            • entityRevision (string) --

              The revision of the published asset for which the subscription grant is created.

            • entityType (string) --

              The type of the published asset for which the subscription grant is created.

            • forms (string) --

              The forms attached to the published asset for which the subscription grant is created.

            • glossaryTerms (list) --

              The glossary terms attached to the published asset for which the subscription grant is created.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

          • productListing (dict) --

            The data product listing.

            • assetListings (list) --

              The data assets of the data product listing.

              • (dict) --

                The listing of the asset in a data product.

                • entityId (string) --

                  The entity ID of the listing of the asset in a data product.

                • entityRevision (string) --

                  The entity revision of the listing of the asset in a data product.

                • entityType (string) --

                  The entity type of the listing of the asset in a data product.

            • description (string) --

              The description of the data product listing.

            • entityId (string) --

              The ID of the data product listing.

            • entityRevision (string) --

              The revision of the data product listing.

            • glossaryTerms (list) --

              The glossary terms of the data product listing.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

            • name (string) --

              The name of the data product listing.

        • name (string) --

          The name of the published asset for which the subscription grant is created.

        • ownerProjectId (string) --

          The identifier of the project of the published asset for which the subscription grant is created.

        • ownerProjectName (string) --

          The name of the project that owns the published asset for which the subscription grant is created.

        • revision (string) --

          The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipals (list) --

      The subscribed principals of the subscription request.

      • (dict) --

        The principal that has the subscription grant for the asset.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • project (dict) --

          The project that has the subscription grant.

          • id (string) --

            The identifier of the project that has the subscription grant.

          • name (string) --

            The name of the project that has the subscription grant.

    • updatedAt (datetime) --

      The timestamp of when the subscription request was updated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the subscription request.

GetListing (updated) Link ¶
Changes (response)
{'item': {'dataProductListing': {'createdAt': 'timestamp',
                                 'dataProductId': 'string',
                                 'dataProductRevision': 'string',
                                 'forms': 'string',
                                 'glossaryTerms': [{'name': 'string',
                                                    'shortDescription': 'string'}],
                                 'items': [{'glossaryTerms': [{'name': 'string',
                                                               'shortDescription': 'string'}],
                                            'listingId': 'string',
                                            'listingRevision': 'string'}],
                                 'owningProjectId': 'string'}}}

Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.

See also: AWS API Documentation

Request Syntax

client.get_listing(
    domainIdentifier='string',
    identifier='string',
    listingRevision='string'
)
type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the Amazon DataZone domain.

type identifier

string

param identifier

[REQUIRED]

The ID of the listing.

type listingRevision

string

param listingRevision

The revision of the listing.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'id': 'string',
    'item': {
        'assetListing': {
            'assetId': 'string',
            'assetRevision': 'string',
            'assetType': 'string',
            'createdAt': datetime(2015, 1, 1),
            'forms': 'string',
            'glossaryTerms': [
                {
                    'name': 'string',
                    'shortDescription': 'string'
                },
            ],
            'latestTimeSeriesDataPointForms': [
                {
                    'contentSummary': 'string',
                    'formName': 'string',
                    'id': 'string',
                    'timestamp': datetime(2015, 1, 1),
                    'typeIdentifier': 'string',
                    'typeRevision': 'string'
                },
            ],
            'owningProjectId': 'string'
        },
        'dataProductListing': {
            'createdAt': datetime(2015, 1, 1),
            'dataProductId': 'string',
            'dataProductRevision': 'string',
            'forms': 'string',
            'glossaryTerms': [
                {
                    'name': 'string',
                    'shortDescription': 'string'
                },
            ],
            'items': [
                {
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ],
                    'listingId': 'string',
                    'listingRevision': 'string'
                },
            ],
            'owningProjectId': 'string'
        }
    },
    'listingRevision': 'string',
    'name': 'string',
    'status': 'CREATING'|'ACTIVE'|'INACTIVE',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp of when the listing was created.

    • createdBy (string) --

      The Amazon DataZone user who created the listing.

    • description (string) --

      The description of the listing.

    • domainId (string) --

      The ID of the Amazon DataZone domain.

    • id (string) --

      The ID of the listing.

    • item (dict) --

      The details of a listing.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, dataProductListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      • assetListing (dict) --

        An asset published in an Amazon DataZone catalog.

        • assetId (string) --

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

        • assetRevision (string) --

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

        • assetType (string) --

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

        • createdAt (datetime) --

          The timestamp of when an asset published in an Amazon DataZone catalog was created.

        • forms (string) --

          The metadata forms attached to an asset published in an Amazon DataZone catalog.

        • glossaryTerms (list) --

          The glossary terms attached to an asset published in an Amazon DataZone catalog.

          • (dict) --

            Details of a glossary term attached to the inventory asset.

            • name (string) --

              The name of a glossary term attached to the inventory asset.

            • shortDescription (string) --

              The shoft description of a glossary term attached to the inventory asset.

        • latestTimeSeriesDataPointForms (list) --

          The latest time series data points forms included in the additional attributes of an 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.

        • owningProjectId (string) --

          The identifier of the project where an asset published in an Amazon DataZone catalog exists.

      • dataProductListing (dict) --

        The data product listing.

        • createdAt (datetime) --

          The timestamp at which the data product listing was created.

        • dataProductId (string) --

          The ID of the data product listing.

        • dataProductRevision (string) --

          The revision of the data product listing.

        • forms (string) --

          The metadata forms of the data product listing.

        • glossaryTerms (list) --

          The glossary terms of the data product listing.

          • (dict) --

            Details of a glossary term attached to the inventory asset.

            • name (string) --

              The name of a glossary term attached to the inventory asset.

            • shortDescription (string) --

              The shoft description of a glossary term attached to the inventory asset.

        • items (list) --

          The data assets of the data product listing.

          • (dict) --

            The summary of the listing of the data product.

            • glossaryTerms (list) --

              The glossary terms of the data product.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

            • listingId (string) --

              The ID of the data product listing.

            • listingRevision (string) --

              The revision of the data product listing.

        • owningProjectId (string) --

          The ID of the owning project of the data product listing.

    • listingRevision (string) --

      The revision of a listing.

    • name (string) --

      The name of the listing.

    • status (string) --

      The status of the listing.

    • updatedAt (datetime) --

      The timestamp of when the listing was updated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the listing.

GetSubscription (updated) Link ¶
Changes (response)
{'subscribedListing': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                      'entityRevision': 'string',
                                                                      'entityType': 'string'}],
                                                   'description': 'string',
                                                   'entityId': 'string',
                                                   'entityRevision': 'string',
                                                   'glossaryTerms': [{'name': 'string',
                                                                      'shortDescription': 'string'}],
                                                   'name': 'string'}}}}

Gets a subscription in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.get_subscription(
    domainIdentifier='string',
    identifier='string'
)
type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the Amazon DataZone domain in which the subscription exists.

type identifier

string

param identifier

[REQUIRED]

The ID of the subscription.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'domainId': 'string',
    'id': 'string',
    'retainPermissions': True|False,
    'status': 'APPROVED'|'REVOKED'|'CANCELLED',
    'subscribedListing': {
        'description': 'string',
        'id': 'string',
        'item': {
            'assetListing': {
                'entityId': 'string',
                'entityRevision': 'string',
                'entityType': 'string',
                'forms': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ]
            },
            'productListing': {
                'assetListings': [
                    {
                        'entityId': 'string',
                        'entityRevision': 'string',
                        'entityType': 'string'
                    },
                ],
                'description': 'string',
                'entityId': 'string',
                'entityRevision': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ],
                'name': 'string'
            }
        },
        'name': 'string',
        'ownerProjectId': 'string',
        'ownerProjectName': 'string',
        'revision': 'string'
    },
    'subscribedPrincipal': {
        'project': {
            'id': 'string',
            'name': 'string'
        }
    },
    'subscriptionRequestId': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp of when the subscription was created.

    • createdBy (string) --

      The Amazon DataZone user who created the subscription.

    • domainId (string) --

      The ID of the Amazon DataZone domain in which the subscription exists.

    • id (string) --

      The ID of the subscription.

    • retainPermissions (boolean) --

      The retain permissions of the subscription.

    • status (string) --

      The status of the subscription.

    • subscribedListing (dict) --

      The details of the published asset for which the subscription grant is created.

      • description (string) --

        The description of the published asset for which the subscription grant is created.

      • id (string) --

        The identifier of the published asset for which the subscription grant is created.

      • item (dict) --

        The published asset for which the subscription grant is created.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • assetListing (dict) --

          The asset for which the subscription grant is created.

          • entityId (string) --

            The identifier of the published asset for which the subscription grant is created.

          • entityRevision (string) --

            The revision of the published asset for which the subscription grant is created.

          • entityType (string) --

            The type of the published asset for which the subscription grant is created.

          • forms (string) --

            The forms attached to the published asset for which the subscription grant is created.

          • glossaryTerms (list) --

            The glossary terms attached to the published asset for which the subscription grant is created.

            • (dict) --

              Details of a glossary term attached to the inventory asset.

              • name (string) --

                The name of a glossary term attached to the inventory asset.

              • shortDescription (string) --

                The shoft description of a glossary term attached to the inventory asset.

        • productListing (dict) --

          The data product listing.

          • assetListings (list) --

            The data assets of the data product listing.

            • (dict) --

              The listing of the asset in a data product.

              • entityId (string) --

                The entity ID of the listing of the asset in a data product.

              • entityRevision (string) --

                The entity revision of the listing of the asset in a data product.

              • entityType (string) --

                The entity type of the listing of the asset in a data product.

          • description (string) --

            The description of the data product listing.

          • entityId (string) --

            The ID of the data product listing.

          • entityRevision (string) --

            The revision of the data product listing.

          • glossaryTerms (list) --

            The glossary terms of the data product listing.

            • (dict) --

              Details of a glossary term attached to the inventory asset.

              • name (string) --

                The name of a glossary term attached to the inventory asset.

              • shortDescription (string) --

                The shoft description of a glossary term attached to the inventory asset.

          • name (string) --

            The name of the data product listing.

      • name (string) --

        The name of the published asset for which the subscription grant is created.

      • ownerProjectId (string) --

        The identifier of the project of the published asset for which the subscription grant is created.

      • ownerProjectName (string) --

        The name of the project that owns the published asset for which the subscription grant is created.

      • revision (string) --

        The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipal (dict) --

      The principal that owns the subscription.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      • project (dict) --

        The project that has the subscription grant.

        • id (string) --

          The identifier of the project that has the subscription grant.

        • name (string) --

          The name of the project that has the subscription grant.

    • subscriptionRequestId (string) --

      The ID of the subscription request.

    • updatedAt (datetime) --

      The timestamp of when the subscription was updated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the subscription.

GetSubscriptionRequestDetails (updated) Link ¶
Changes (response)
{'subscribedListings': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                       'entityRevision': 'string',
                                                                       'entityType': 'string'}],
                                                    'description': 'string',
                                                    'entityId': 'string',
                                                    'entityRevision': 'string',
                                                    'glossaryTerms': [{'name': 'string',
                                                                       'shortDescription': 'string'}],
                                                    'name': 'string'}}}}

Gets the details of the specified subscription request.

See also: AWS API Documentation

Request Syntax

client.get_subscription_request_details(
    domainIdentifier='string',
    identifier='string'
)
type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The identifier of the Amazon DataZone domain in which to get the subscription request details.

type identifier

string

param identifier

[REQUIRED]

The identifier of the subscription request the details of which to get.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'decisionComment': 'string',
    'domainId': 'string',
    'id': 'string',
    'requestReason': 'string',
    'reviewerId': 'string',
    'status': 'PENDING'|'ACCEPTED'|'REJECTED',
    'subscribedListings': [
        {
            'description': 'string',
            'id': 'string',
            'item': {
                'assetListing': {
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'entityType': 'string',
                    'forms': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ]
                },
                'productListing': {
                    'assetListings': [
                        {
                            'entityId': 'string',
                            'entityRevision': 'string',
                            'entityType': 'string'
                        },
                    ],
                    'description': 'string',
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ],
                    'name': 'string'
                }
            },
            'name': 'string',
            'ownerProjectId': 'string',
            'ownerProjectName': 'string',
            'revision': 'string'
        },
    ],
    'subscribedPrincipals': [
        {
            'project': {
                'id': 'string',
                'name': 'string'
            }
        },
    ],
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp of when the specified subscription request was created.

    • createdBy (string) --

      The Amazon DataZone user who created the subscription request.

    • decisionComment (string) --

      The decision comment of the subscription request.

    • domainId (string) --

      The Amazon DataZone domain of the subscription request.

    • id (string) --

      The identifier of the subscription request.

    • requestReason (string) --

      The reason for the subscription request.

    • reviewerId (string) --

      The identifier of the Amazon DataZone user who reviewed the subscription request.

    • status (string) --

      The status of the subscription request.

    • subscribedListings (list) --

      The subscribed listings in the subscription request.

      • (dict) --

        The details of the published asset for which the subscription grant is created.

        • description (string) --

          The description of the published asset for which the subscription grant is created.

        • id (string) --

          The identifier of the published asset for which the subscription grant is created.

        • item (dict) --

          The published asset for which the subscription grant is created.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • entityId (string) --

              The identifier of the published asset for which the subscription grant is created.

            • entityRevision (string) --

              The revision of the published asset for which the subscription grant is created.

            • entityType (string) --

              The type of the published asset for which the subscription grant is created.

            • forms (string) --

              The forms attached to the published asset for which the subscription grant is created.

            • glossaryTerms (list) --

              The glossary terms attached to the published asset for which the subscription grant is created.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

          • productListing (dict) --

            The data product listing.

            • assetListings (list) --

              The data assets of the data product listing.

              • (dict) --

                The listing of the asset in a data product.

                • entityId (string) --

                  The entity ID of the listing of the asset in a data product.

                • entityRevision (string) --

                  The entity revision of the listing of the asset in a data product.

                • entityType (string) --

                  The entity type of the listing of the asset in a data product.

            • description (string) --

              The description of the data product listing.

            • entityId (string) --

              The ID of the data product listing.

            • entityRevision (string) --

              The revision of the data product listing.

            • glossaryTerms (list) --

              The glossary terms of the data product listing.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

            • name (string) --

              The name of the data product listing.

        • name (string) --

          The name of the published asset for which the subscription grant is created.

        • ownerProjectId (string) --

          The identifier of the project of the published asset for which the subscription grant is created.

        • ownerProjectName (string) --

          The name of the project that owns the published asset for which the subscription grant is created.

        • revision (string) --

          The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipals (list) --

      The subscribed principals in the subscription request.

      • (dict) --

        The principal that has the subscription grant for the asset.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • project (dict) --

          The project that has the subscription grant.

          • id (string) --

            The identifier of the project that has the subscription grant.

          • name (string) --

            The name of the project that has the subscription grant.

    • updatedAt (datetime) --

      The timestamp of when the subscription request was updated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the subscription request.

ListSubscriptionGrants (updated) Link ¶
Changes (request)
{'owningProjectId': 'string'}

Lists subscription grants.

See also: AWS API Documentation

Request Syntax

client.list_subscription_grants(
    domainIdentifier='string',
    environmentId='string',
    maxResults=123,
    nextToken='string',
    owningProjectId='string',
    sortBy='CREATED_AT'|'UPDATED_AT',
    sortOrder='ASCENDING'|'DESCENDING',
    subscribedListingId='string',
    subscriptionId='string',
    subscriptionTargetId='string'
)
type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The identifier of the Amazon DataZone domain.

type environmentId

string

param environmentId

The identifier of the Amazon DataZone environment.

type maxResults

integer

param maxResults

The maximum number of subscription grants to return in a single call to ListSubscriptionGrants . When the number of subscription grants to be listed is greater than the value of MaxResults , the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

type nextToken

string

param nextToken

When the number of subscription grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription grants, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

type owningProjectId

string

param owningProjectId

The ID of the owning project of the subscription grants.

type sortBy

string

param sortBy

Specifies the way of sorting the results of this action.

type sortOrder

string

param sortOrder

Specifies the sort order of this action.

type subscribedListingId

string

param subscribedListingId

The identifier of the subscribed listing.

type subscriptionId

string

param subscriptionId

The identifier of the subscription.

type subscriptionTargetId

string

param subscriptionTargetId

The identifier of the subscription target.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'assets': [
                {
                    'assetId': 'string',
                    'assetRevision': 'string',
                    'failureCause': {
                        'message': 'string'
                    },
                    'failureTimestamp': datetime(2015, 1, 1),
                    'grantedTimestamp': datetime(2015, 1, 1),
                    'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED',
                    'targetName': 'string'
                },
            ],
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'domainId': 'string',
            'grantedEntity': {
                'listing': {
                    'id': 'string',
                    'revision': 'string'
                }
            },
            'id': 'string',
            'status': 'PENDING'|'IN_PROGRESS'|'GRANT_FAILED'|'REVOKE_FAILED'|'GRANT_AND_REVOKE_FAILED'|'COMPLETED'|'INACCESSIBLE',
            'subscriptionId': 'string',
            'subscriptionTargetId': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      The results of the ListSubscriptionGrants action.

      • (dict) --

        The details of the subscription grant.

        • assets (list) --

          The assets included in the subscription grant.

          • (dict) --

            The details of the asset for which the subscription grant is created.

            • assetId (string) --

              The identifier of the asset for which the subscription grant is created.

            • assetRevision (string) --

              The revision of the asset for which the subscription grant is created.

            • failureCause (dict) --

              The failure cause included in the details of the asset for which the subscription grant is created.

              • message (string) --

                The description of the error message.

            • failureTimestamp (datetime) --

              The failure timestamp included in the details of the asset for which the subscription grant is created.

            • grantedTimestamp (datetime) --

              The timestamp of when the subscription grant to the asset is created.

            • status (string) --

              The status of the asset for which the subscription grant is created.

            • targetName (string) --

              The target name of the asset for which the subscription grant is created.

        • createdAt (datetime) --

          The timestamp of when a subscription grant was created.

        • createdBy (string) --

          The datazone user who created the subscription grant.

        • domainId (string) --

          The identifier of the Amazon DataZone domain in which a subscription grant exists.

        • grantedEntity (dict) --

          The entity to which the subscription is granted.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: listing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • listing (dict) --

            The listing for which a subscription is granted.

            • id (string) --

              An identifier of a revision of an asset published in a Amazon DataZone catalog.

            • revision (string) --

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

        • id (string) --

          The identifier of the subscription grant.

        • status (string) --

          The status of the subscription grant.

        • subscriptionId (string) --

          The ID of the subscription.

        • subscriptionTargetId (string) --

          The identifier of the target of the subscription grant.

        • updatedAt (datetime) --

          The timestampf of when the subscription grant was updated.

        • updatedBy (string) --

          The Amazon DataZone user who updated the subscription grant.

    • nextToken (string) --

      When the number of subscription grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription grants, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

ListSubscriptionRequests (updated) Link ¶
Changes (response)
{'items': {'subscribedListings': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                                 'entityRevision': 'string',
                                                                                 'entityType': 'string'}],
                                                              'description': 'string',
                                                              'entityId': 'string',
                                                              'entityRevision': 'string',
                                                              'glossaryTerms': [{'name': 'string',
                                                                                 'shortDescription': 'string'}],
                                                              'name': 'string'}}}}}

Lists Amazon DataZone subscription requests.

See also: AWS API Documentation

Request Syntax

client.list_subscription_requests(
    approverProjectId='string',
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    owningProjectId='string',
    sortBy='CREATED_AT'|'UPDATED_AT',
    sortOrder='ASCENDING'|'DESCENDING',
    status='PENDING'|'ACCEPTED'|'REJECTED',
    subscribedListingId='string'
)
type approverProjectId

string

param approverProjectId

The identifier of the subscription request approver's project.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The identifier of the Amazon DataZone domain.

type maxResults

integer

param maxResults

The maximum number of subscription requests to return in a single call to ListSubscriptionRequests . When the number of subscription requests to be listed is greater than the value of MaxResults , the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

type nextToken

string

param nextToken

When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

type owningProjectId

string

param owningProjectId

The identifier of the project for the subscription requests.

type sortBy

string

param sortBy

Specifies the way to sort the results of this action.

type sortOrder

string

param sortOrder

Specifies the sort order for the results of this action.

type status

string

param status

Specifies the status of the subscription requests.

Note

This is not a required parameter, but if not specified, by default, Amazon DataZone returns only PENDING subscription requests.

type subscribedListingId

string

param subscribedListingId

The identifier of the subscribed listing.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'decisionComment': 'string',
            'domainId': 'string',
            'id': 'string',
            'requestReason': 'string',
            'reviewerId': 'string',
            'status': 'PENDING'|'ACCEPTED'|'REJECTED',
            'subscribedListings': [
                {
                    'description': 'string',
                    'id': 'string',
                    'item': {
                        'assetListing': {
                            'entityId': 'string',
                            'entityRevision': 'string',
                            'entityType': 'string',
                            'forms': 'string',
                            'glossaryTerms': [
                                {
                                    'name': 'string',
                                    'shortDescription': 'string'
                                },
                            ]
                        },
                        'productListing': {
                            'assetListings': [
                                {
                                    'entityId': 'string',
                                    'entityRevision': 'string',
                                    'entityType': 'string'
                                },
                            ],
                            'description': 'string',
                            'entityId': 'string',
                            'entityRevision': 'string',
                            'glossaryTerms': [
                                {
                                    'name': 'string',
                                    'shortDescription': 'string'
                                },
                            ],
                            'name': 'string'
                        }
                    },
                    'name': 'string',
                    'ownerProjectId': 'string',
                    'ownerProjectName': 'string',
                    'revision': 'string'
                },
            ],
            'subscribedPrincipals': [
                {
                    'project': {
                        'id': 'string',
                        'name': 'string'
                    }
                },
            ],
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      The results of the ListSubscriptionRequests action.

      • (dict) --

        The details of the subscription request.

        • createdAt (datetime) --

          The timestamp of when a subscription request was created.

        • createdBy (string) --

          The Amazon DataZone user who created the subscription request.

        • decisionComment (string) --

          The decision comment of the subscription request.

        • domainId (string) --

          The identifier of the Amazon DataZone domain in which a subscription request exists.

        • id (string) --

          The identifier of the subscription request.

        • requestReason (string) --

          The reason for the subscription request.

        • reviewerId (string) --

          The identifier of the subscription request reviewer.

        • status (string) --

          The status of the subscription request.

        • subscribedListings (list) --

          The listings included in the subscription request.

          • (dict) --

            The details of the published asset for which the subscription grant is created.

            • description (string) --

              The description of the published asset for which the subscription grant is created.

            • id (string) --

              The identifier of the published asset for which the subscription grant is created.

            • item (dict) --

              The published asset for which the subscription grant is created.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              • assetListing (dict) --

                The asset for which the subscription grant is created.

                • entityId (string) --

                  The identifier of the published asset for which the subscription grant is created.

                • entityRevision (string) --

                  The revision of the published asset for which the subscription grant is created.

                • entityType (string) --

                  The type of the published asset for which the subscription grant is created.

                • forms (string) --

                  The forms attached to the published asset for which the subscription grant is created.

                • glossaryTerms (list) --

                  The glossary terms attached to the published asset for which the subscription grant is created.

                  • (dict) --

                    Details of a glossary term attached to the inventory asset.

                    • name (string) --

                      The name of a glossary term attached to the inventory asset.

                    • shortDescription (string) --

                      The shoft description of a glossary term attached to the inventory asset.

              • productListing (dict) --

                The data product listing.

                • assetListings (list) --

                  The data assets of the data product listing.

                  • (dict) --

                    The listing of the asset in a data product.

                    • entityId (string) --

                      The entity ID of the listing of the asset in a data product.

                    • entityRevision (string) --

                      The entity revision of the listing of the asset in a data product.

                    • entityType (string) --

                      The entity type of the listing of the asset in a data product.

                • description (string) --

                  The description of the data product listing.

                • entityId (string) --

                  The ID of the data product listing.

                • entityRevision (string) --

                  The revision of the data product listing.

                • glossaryTerms (list) --

                  The glossary terms of the data product listing.

                  • (dict) --

                    Details of a glossary term attached to the inventory asset.

                    • name (string) --

                      The name of a glossary term attached to the inventory asset.

                    • shortDescription (string) --

                      The shoft description of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of the data product listing.

            • name (string) --

              The name of the published asset for which the subscription grant is created.

            • ownerProjectId (string) --

              The identifier of the project of the published asset for which the subscription grant is created.

            • ownerProjectName (string) --

              The name of the project that owns the published asset for which the subscription grant is created.

            • revision (string) --

              The revision of the published asset for which the subscription grant is created.

        • subscribedPrincipals (list) --

          The principals included in the subscription request.

          • (dict) --

            The principal that has the subscription grant for the asset.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            • project (dict) --

              The project that has the subscription grant.

              • id (string) --

                The identifier of the project that has the subscription grant.

              • name (string) --

                The name of the project that has the subscription grant.

        • updatedAt (datetime) --

          The timestamp of when the subscription request was updated.

        • updatedBy (string) --

          The identifier of the Amazon DataZone user who updated the subscription request.

    • nextToken (string) --

      When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

ListSubscriptions (updated) Link ¶
Changes (response)
{'items': {'subscribedListing': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                                'entityRevision': 'string',
                                                                                'entityType': 'string'}],
                                                             'description': 'string',
                                                             'entityId': 'string',
                                                             'entityRevision': 'string',
                                                             'glossaryTerms': [{'name': 'string',
                                                                                'shortDescription': 'string'}],
                                                             'name': 'string'}}}}}

Lists subscriptions in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.list_subscriptions(
    approverProjectId='string',
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    owningProjectId='string',
    sortBy='CREATED_AT'|'UPDATED_AT',
    sortOrder='ASCENDING'|'DESCENDING',
    status='APPROVED'|'REVOKED'|'CANCELLED',
    subscribedListingId='string',
    subscriptionRequestIdentifier='string'
)
type approverProjectId

string

param approverProjectId

The identifier of the project for the subscription's approver.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The identifier of the Amazon DataZone domain.

type maxResults

integer

param maxResults

The maximum number of subscriptions to return in a single call to ListSubscriptions . When the number of subscriptions to be listed is greater than the value of MaxResults , the response contains a NextToken value that you can use in a subsequent call to ListSubscriptions to list the next set of Subscriptions.

type nextToken

string

param nextToken

When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

type owningProjectId

string

param owningProjectId

The identifier of the owning project.

type sortBy

string

param sortBy

Specifies the way in which the results of this action are to be sorted.

type sortOrder

string

param sortOrder

Specifies the sort order for the results of this action.

type status

string

param status

The status of the subscriptions that you want to list.

Note

This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

type subscribedListingId

string

param subscribedListingId

The identifier of the subscribed listing for the subscriptions that you want to list.

type subscriptionRequestIdentifier

string

param subscriptionRequestIdentifier

The identifier of the subscription request for the subscriptions that you want to list.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'domainId': 'string',
            'id': 'string',
            'retainPermissions': True|False,
            'status': 'APPROVED'|'REVOKED'|'CANCELLED',
            'subscribedListing': {
                'description': 'string',
                'id': 'string',
                'item': {
                    'assetListing': {
                        'entityId': 'string',
                        'entityRevision': 'string',
                        'entityType': 'string',
                        'forms': 'string',
                        'glossaryTerms': [
                            {
                                'name': 'string',
                                'shortDescription': 'string'
                            },
                        ]
                    },
                    'productListing': {
                        'assetListings': [
                            {
                                'entityId': 'string',
                                'entityRevision': 'string',
                                'entityType': 'string'
                            },
                        ],
                        'description': 'string',
                        'entityId': 'string',
                        'entityRevision': 'string',
                        'glossaryTerms': [
                            {
                                'name': 'string',
                                'shortDescription': 'string'
                            },
                        ],
                        'name': 'string'
                    }
                },
                'name': 'string',
                'ownerProjectId': 'string',
                'ownerProjectName': 'string',
                'revision': 'string'
            },
            'subscribedPrincipal': {
                'project': {
                    'id': 'string',
                    'name': 'string'
                }
            },
            'subscriptionRequestId': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      The results of the ListSubscriptions action.

      • (dict) --

        The details of the subscription.

        • createdAt (datetime) --

          The timestamp of when the subscription was created.

        • createdBy (string) --

          The Amazon DataZone user who created the subscription.

        • domainId (string) --

          The identifier of the Amazon DataZone domain in which a subscription exists.

        • id (string) --

          The identifier of the subscription.

        • retainPermissions (boolean) --

          The retain permissions included in the subscription.

        • status (string) --

          The status of the subscription.

        • subscribedListing (dict) --

          The listing included in the subscription.

          • description (string) --

            The description of the published asset for which the subscription grant is created.

          • id (string) --

            The identifier of the published asset for which the subscription grant is created.

          • item (dict) --

            The published asset for which the subscription grant is created.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            • assetListing (dict) --

              The asset for which the subscription grant is created.

              • entityId (string) --

                The identifier of the published asset for which the subscription grant is created.

              • entityRevision (string) --

                The revision of the published asset for which the subscription grant is created.

              • entityType (string) --

                The type of the published asset for which the subscription grant is created.

              • forms (string) --

                The forms attached to the published asset for which the subscription grant is created.

              • glossaryTerms (list) --

                The glossary terms attached to the published asset for which the subscription grant is created.

                • (dict) --

                  Details of a glossary term attached to the inventory asset.

                  • name (string) --

                    The name of a glossary term attached to the inventory asset.

                  • shortDescription (string) --

                    The shoft description of a glossary term attached to the inventory asset.

            • productListing (dict) --

              The data product listing.

              • assetListings (list) --

                The data assets of the data product listing.

                • (dict) --

                  The listing of the asset in a data product.

                  • entityId (string) --

                    The entity ID of the listing of the asset in a data product.

                  • entityRevision (string) --

                    The entity revision of the listing of the asset in a data product.

                  • entityType (string) --

                    The entity type of the listing of the asset in a data product.

              • description (string) --

                The description of the data product listing.

              • entityId (string) --

                The ID of the data product listing.

              • entityRevision (string) --

                The revision of the data product listing.

              • glossaryTerms (list) --

                The glossary terms of the data product listing.

                • (dict) --

                  Details of a glossary term attached to the inventory asset.

                  • name (string) --

                    The name of a glossary term attached to the inventory asset.

                  • shortDescription (string) --

                    The shoft description of a glossary term attached to the inventory asset.

              • name (string) --

                The name of the data product listing.

          • name (string) --

            The name of the published asset for which the subscription grant is created.

          • ownerProjectId (string) --

            The identifier of the project of the published asset for which the subscription grant is created.

          • ownerProjectName (string) --

            The name of the project that owns the published asset for which the subscription grant is created.

          • revision (string) --

            The revision of the published asset for which the subscription grant is created.

        • subscribedPrincipal (dict) --

          The principal included in the subscription.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • project (dict) --

            The project that has the subscription grant.

            • id (string) --

              The identifier of the project that has the subscription grant.

            • name (string) --

              The name of the project that has the subscription grant.

        • subscriptionRequestId (string) --

          The identifier of the subscription request for the subscription.

        • updatedAt (datetime) --

          The timestamp of when the subscription was updated.

        • updatedBy (string) --

          The Amazon DataZone user who updated the subscription.

    • nextToken (string) --

      When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

RejectSubscriptionRequest (updated) Link ¶
Changes (response)
{'subscribedListings': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                       'entityRevision': 'string',
                                                                       'entityType': 'string'}],
                                                    'description': 'string',
                                                    'entityId': 'string',
                                                    'entityRevision': 'string',
                                                    'glossaryTerms': [{'name': 'string',
                                                                       'shortDescription': 'string'}],
                                                    'name': 'string'}}}}

Rejects the specified subscription request.

See also: AWS API Documentation

Request Syntax

client.reject_subscription_request(
    decisionComment='string',
    domainIdentifier='string',
    identifier='string'
)
type decisionComment

string

param decisionComment

The decision comment of the rejected subscription request.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The identifier of the Amazon DataZone domain in which the subscription request was rejected.

type identifier

string

param identifier

[REQUIRED]

The identifier of the subscription request that was rejected.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'decisionComment': 'string',
    'domainId': 'string',
    'id': 'string',
    'requestReason': 'string',
    'reviewerId': 'string',
    'status': 'PENDING'|'ACCEPTED'|'REJECTED',
    'subscribedListings': [
        {
            'description': 'string',
            'id': 'string',
            'item': {
                'assetListing': {
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'entityType': 'string',
                    'forms': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ]
                },
                'productListing': {
                    'assetListings': [
                        {
                            'entityId': 'string',
                            'entityRevision': 'string',
                            'entityType': 'string'
                        },
                    ],
                    'description': 'string',
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ],
                    'name': 'string'
                }
            },
            'name': 'string',
            'ownerProjectId': 'string',
            'ownerProjectName': 'string',
            'revision': 'string'
        },
    ],
    'subscribedPrincipals': [
        {
            'project': {
                'id': 'string',
                'name': 'string'
            }
        },
    ],
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp of when the subscription request was rejected.

    • createdBy (string) --

      The timestamp of when the subscription request was rejected.

    • decisionComment (string) --

      The decision comment of the rejected subscription request.

    • domainId (string) --

      The identifier of the Amazon DataZone domain in which the subscription request was rejected.

    • id (string) --

      The identifier of the subscription request that was rejected.

    • requestReason (string) --

      The reason for the subscription request.

    • reviewerId (string) --

      The identifier of the subscription request reviewer.

    • status (string) --

      The status of the subscription request.

    • subscribedListings (list) --

      The subscribed listings of the subscription request.

      • (dict) --

        The details of the published asset for which the subscription grant is created.

        • description (string) --

          The description of the published asset for which the subscription grant is created.

        • id (string) --

          The identifier of the published asset for which the subscription grant is created.

        • item (dict) --

          The published asset for which the subscription grant is created.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • entityId (string) --

              The identifier of the published asset for which the subscription grant is created.

            • entityRevision (string) --

              The revision of the published asset for which the subscription grant is created.

            • entityType (string) --

              The type of the published asset for which the subscription grant is created.

            • forms (string) --

              The forms attached to the published asset for which the subscription grant is created.

            • glossaryTerms (list) --

              The glossary terms attached to the published asset for which the subscription grant is created.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

          • productListing (dict) --

            The data product listing.

            • assetListings (list) --

              The data assets of the data product listing.

              • (dict) --

                The listing of the asset in a data product.

                • entityId (string) --

                  The entity ID of the listing of the asset in a data product.

                • entityRevision (string) --

                  The entity revision of the listing of the asset in a data product.

                • entityType (string) --

                  The entity type of the listing of the asset in a data product.

            • description (string) --

              The description of the data product listing.

            • entityId (string) --

              The ID of the data product listing.

            • entityRevision (string) --

              The revision of the data product listing.

            • glossaryTerms (list) --

              The glossary terms of the data product listing.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

            • name (string) --

              The name of the data product listing.

        • name (string) --

          The name of the published asset for which the subscription grant is created.

        • ownerProjectId (string) --

          The identifier of the project of the published asset for which the subscription grant is created.

        • ownerProjectName (string) --

          The name of the project that owns the published asset for which the subscription grant is created.

        • revision (string) --

          The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipals (list) --

      The subscribed principals of the subscription request.

      • (dict) --

        The principal that has the subscription grant for the asset.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • project (dict) --

          The project that has the subscription grant.

          • id (string) --

            The identifier of the project that has the subscription grant.

          • name (string) --

            The name of the project that has the subscription grant.

    • updatedAt (datetime) --

      The timestamp of when the subscription request was updated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the subscription request.

RevokeSubscription (updated) Link ¶
Changes (response)
{'subscribedListing': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                      'entityRevision': 'string',
                                                                      'entityType': 'string'}],
                                                   'description': 'string',
                                                   'entityId': 'string',
                                                   'entityRevision': 'string',
                                                   'glossaryTerms': [{'name': 'string',
                                                                      'shortDescription': 'string'}],
                                                   'name': 'string'}}}}

Revokes a specified subscription in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.revoke_subscription(
    domainIdentifier='string',
    identifier='string',
    retainPermissions=True|False
)
type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

type identifier

string

param identifier

[REQUIRED]

The identifier of the revoked subscription.

type retainPermissions

boolean

param retainPermissions

Specifies whether permissions are retained when the subscription is revoked.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'domainId': 'string',
    'id': 'string',
    'retainPermissions': True|False,
    'status': 'APPROVED'|'REVOKED'|'CANCELLED',
    'subscribedListing': {
        'description': 'string',
        'id': 'string',
        'item': {
            'assetListing': {
                'entityId': 'string',
                'entityRevision': 'string',
                'entityType': 'string',
                'forms': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ]
            },
            'productListing': {
                'assetListings': [
                    {
                        'entityId': 'string',
                        'entityRevision': 'string',
                        'entityType': 'string'
                    },
                ],
                'description': 'string',
                'entityId': 'string',
                'entityRevision': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ],
                'name': 'string'
            }
        },
        'name': 'string',
        'ownerProjectId': 'string',
        'ownerProjectName': 'string',
        'revision': 'string'
    },
    'subscribedPrincipal': {
        'project': {
            'id': 'string',
            'name': 'string'
        }
    },
    'subscriptionRequestId': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp of when the subscription was revoked.

    • createdBy (string) --

      The identifier of the user who revoked the subscription.

    • domainId (string) --

      The identifier of the Amazon DataZone domain where you want to revoke a subscription.

    • id (string) --

      The identifier of the revoked subscription.

    • retainPermissions (boolean) --

      Specifies whether permissions are retained when the subscription is revoked.

    • status (string) --

      The status of the revoked subscription.

    • subscribedListing (dict) --

      The subscribed listing of the revoked subscription.

      • description (string) --

        The description of the published asset for which the subscription grant is created.

      • id (string) --

        The identifier of the published asset for which the subscription grant is created.

      • item (dict) --

        The published asset for which the subscription grant is created.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • assetListing (dict) --

          The asset for which the subscription grant is created.

          • entityId (string) --

            The identifier of the published asset for which the subscription grant is created.

          • entityRevision (string) --

            The revision of the published asset for which the subscription grant is created.

          • entityType (string) --

            The type of the published asset for which the subscription grant is created.

          • forms (string) --

            The forms attached to the published asset for which the subscription grant is created.

          • glossaryTerms (list) --

            The glossary terms attached to the published asset for which the subscription grant is created.

            • (dict) --

              Details of a glossary term attached to the inventory asset.

              • name (string) --

                The name of a glossary term attached to the inventory asset.

              • shortDescription (string) --

                The shoft description of a glossary term attached to the inventory asset.

        • productListing (dict) --

          The data product listing.

          • assetListings (list) --

            The data assets of the data product listing.

            • (dict) --

              The listing of the asset in a data product.

              • entityId (string) --

                The entity ID of the listing of the asset in a data product.

              • entityRevision (string) --

                The entity revision of the listing of the asset in a data product.

              • entityType (string) --

                The entity type of the listing of the asset in a data product.

          • description (string) --

            The description of the data product listing.

          • entityId (string) --

            The ID of the data product listing.

          • entityRevision (string) --

            The revision of the data product listing.

          • glossaryTerms (list) --

            The glossary terms of the data product listing.

            • (dict) --

              Details of a glossary term attached to the inventory asset.

              • name (string) --

                The name of a glossary term attached to the inventory asset.

              • shortDescription (string) --

                The shoft description of a glossary term attached to the inventory asset.

          • name (string) --

            The name of the data product listing.

      • name (string) --

        The name of the published asset for which the subscription grant is created.

      • ownerProjectId (string) --

        The identifier of the project of the published asset for which the subscription grant is created.

      • ownerProjectName (string) --

        The name of the project that owns the published asset for which the subscription grant is created.

      • revision (string) --

        The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipal (dict) --

      The subscribed principal of the revoked subscription.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      • project (dict) --

        The project that has the subscription grant.

        • id (string) --

          The identifier of the project that has the subscription grant.

        • name (string) --

          The name of the project that has the subscription grant.

    • subscriptionRequestId (string) --

      The identifier of the subscription request for the revoked subscription.

    • updatedAt (datetime) --

      The timestamp of when the subscription was revoked.

    • updatedBy (string) --

      The Amazon DataZone user who revoked the subscription.

SearchListings (updated) Link ¶
Changes (response)
{'items': {'dataProductListing': {'additionalAttributes': {'forms': 'string'},
                                  'createdAt': 'timestamp',
                                  'description': 'string',
                                  'entityId': 'string',
                                  'entityRevision': 'string',
                                  'glossaryTerms': [{'name': 'string',
                                                     'shortDescription': 'string'}],
                                  'items': [{'glossaryTerms': [{'name': 'string',
                                                                'shortDescription': 'string'}],
                                             'listingId': 'string',
                                             'listingRevision': 'string'}],
                                  'listingCreatedBy': 'string',
                                  'listingId': 'string',
                                  'listingRevision': 'string',
                                  'listingUpdatedBy': 'string',
                                  'name': 'string',
                                  'owningProjectId': 'string'}}}

Searches listings (records of an asset at a given time) in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.search_listings(
    additionalAttributes=[
        'FORMS'|'TIME_SERIES_DATA_POINT_FORMS',
    ],
    domainIdentifier='string',
    filters={
        'and': [
            {'... recursive ...'},
        ],
        'filter': {
            'attribute': 'string',
            'value': 'string'
        },
        'or': [
            {'... recursive ...'},
        ]
    },
    maxResults=123,
    nextToken='string',
    searchIn=[
        {
            'attribute': 'string'
        },
    ],
    searchText='string',
    sort={
        'attribute': 'string',
        'order': 'ASCENDING'|'DESCENDING'
    }
)
type additionalAttributes

list

param additionalAttributes

Specifies additional attributes for the search.

  • (string) --

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The identifier of the domain in which to search listings.

type filters

dict

param filters

Specifies the filters for the search of listings.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

  • and (list) --

    The 'and' search filter clause in Amazon DataZone.

    • (dict) --

      A search filter clause in Amazon DataZone.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

  • filter (dict) --

    A search filter in Amazon DataZone.

    • attribute (string) -- [REQUIRED]

      A search filter attribute in Amazon DataZone.

    • value (string) -- [REQUIRED]

      A search filter value in Amazon DataZone.

  • or (list) --

    The 'or' search filter clause in Amazon DataZone.

    • (dict) --

      A search filter clause in Amazon DataZone.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

type maxResults

integer

param maxResults

The maximum number of results to return in a single call to SearchListings . When the number of results to be listed is greater than the value of MaxResults , the response contains a NextToken value that you can use in a subsequent call to SearchListings to list the next set of results.

type nextToken

string

param nextToken

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.

type searchIn

list

param searchIn

The details of the search.

  • (dict) --

    The details of the search.

    • attribute (string) -- [REQUIRED]

      The search attribute.

type searchText

string

param searchText

Specifies the text for which to search.

type sort

dict

param sort

Specifies the way for sorting the search results.

  • attribute (string) -- [REQUIRED]

    The attribute detail of the way to sort search results.

  • order (string) --

    The order detail of the wya to sort search results.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'assetListing': {
                'additionalAttributes': {
                    'forms': 'string',
                    'latestTimeSeriesDataPointForms': [
                        {
                            'contentSummary': 'string',
                            'formName': 'string',
                            'id': 'string',
                            'timestamp': datetime(2015, 1, 1),
                            'typeIdentifier': 'string',
                            'typeRevision': 'string'
                        },
                    ]
                },
                'createdAt': datetime(2015, 1, 1),
                'description': 'string',
                'entityId': 'string',
                'entityRevision': 'string',
                'entityType': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ],
                'listingCreatedBy': 'string',
                'listingId': 'string',
                'listingRevision': 'string',
                'listingUpdatedBy': 'string',
                'name': 'string',
                'owningProjectId': 'string'
            },
            'dataProductListing': {
                'additionalAttributes': {
                    'forms': 'string'
                },
                'createdAt': datetime(2015, 1, 1),
                'description': 'string',
                'entityId': 'string',
                'entityRevision': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ],
                'items': [
                    {
                        'glossaryTerms': [
                            {
                                'name': 'string',
                                'shortDescription': 'string'
                            },
                        ],
                        'listingId': 'string',
                        'listingRevision': 'string'
                    },
                ],
                'listingCreatedBy': 'string',
                'listingId': 'string',
                'listingRevision': 'string',
                'listingUpdatedBy': 'string',
                'name': 'string',
                'owningProjectId': 'string'
            }
        },
    ],
    'nextToken': 'string',
    'totalMatchCount': 123
}

Response Structure

  • (dict) --

    • items (list) --

      The results of the SearchListings action.

      • (dict) --

        The details of the results of the SearchListings action.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, dataProductListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • assetListing (dict) --

          The asset listing included in the results of the SearchListings action.

          • additionalAttributes (dict) --

            The additional attributes of an asset published in an Amazon DataZone catalog.

            • forms (string) --

              The metadata forms that form additional attributes of the metadata asset.

            • latestTimeSeriesDataPointForms (list) --

              The latest time series data points forms included in the additional attributes of an 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.

          • createdAt (datetime) --

            The timestamp of when an asset published in an Amazon DataZone catalog was created.

          • description (string) --

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

          • entityId (string) --

            The identifier of the inventory asset.

          • entityRevision (string) --

            The revision of the inventory asset.

          • entityType (string) --

            The type of the inventory asset.

          • glossaryTerms (list) --

            Glossary terms attached to the inventory asset.

            • (dict) --

              Details of a glossary term attached to the inventory asset.

              • name (string) --

                The name of a glossary term attached to the inventory asset.

              • shortDescription (string) --

                The shoft description of a glossary term attached to the inventory asset.

          • listingCreatedBy (string) --

            The Amazon DataZone user who created the listing.

          • listingId (string) --

            The identifier of the listing (asset published in Amazon DataZone catalog).

          • listingRevision (string) --

            The revision of the listing (asset published in Amazon DataZone catalog).

          • listingUpdatedBy (string) --

            The Amazon DataZone user who updated the listing.

          • name (string) --

            The name of the inventory asset.

          • owningProjectId (string) --

            The identifier of the project that owns the inventory asset.

        • dataProductListing (dict) --

          The data product listing.

          • additionalAttributes (dict) --

            The additional attributes of the asset of the data product.

            • forms (string) --

              The metadata forms of the asset of the data product.

          • createdAt (datetime) --

            The timestamp at which the asset of the data product listing was created.

          • description (string) --

            The description of the asset of the asset of the data product.

          • entityId (string) --

            The entity ID of the asset of the asset of the data product.

          • entityRevision (string) --

            The revision of the asset of the asset of the data product.

          • glossaryTerms (list) --

            The glossary terms of the asset of the asset of the data product.

            • (dict) --

              Details of a glossary term attached to the inventory asset.

              • name (string) --

                The name of a glossary term attached to the inventory asset.

              • shortDescription (string) --

                The shoft description of a glossary term attached to the inventory asset.

          • items (list) --

            The data of the asset of the data product.

            • (dict) --

              The results of the data product summary.

              • glossaryTerms (list) --

                The glossary terms of the data product listing.

                • (dict) --

                  Details of a glossary term attached to the inventory asset.

                  • name (string) --

                    The name of a glossary term attached to the inventory asset.

                  • shortDescription (string) --

                    The shoft description of a glossary term attached to the inventory asset.

              • listingId (string) --

                The ID of the data product listing.

              • listingRevision (string) --

                The revision of the data product listing.

          • listingCreatedBy (string) --

            The timestamp at which the listing was created.

          • listingId (string) --

            The ID of the listing.

          • listingRevision (string) --

            The revision of the listing.

          • listingUpdatedBy (string) --

            The user who updated the listing.

          • name (string) --

            The name of the asset of the data product.

          • owningProjectId (string) --

            The ID of the owning project of the asset of the data product.

    • nextToken (string) --

      When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.

    • totalMatchCount (integer) --

      Total number of search results.

UpdateSubscriptionRequest (updated) Link ¶
Changes (response)
{'subscribedListings': {'item': {'productListing': {'assetListings': [{'entityId': 'string',
                                                                       'entityRevision': 'string',
                                                                       'entityType': 'string'}],
                                                    'description': 'string',
                                                    'entityId': 'string',
                                                    'entityRevision': 'string',
                                                    'glossaryTerms': [{'name': 'string',
                                                                       'shortDescription': 'string'}],
                                                    'name': 'string'}}}}

Updates a specified subscription request in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.update_subscription_request(
    domainIdentifier='string',
    identifier='string',
    requestReason='string'
)
type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The identifier of the Amazon DataZone domain in which a subscription request is to be updated.

type identifier

string

param identifier

[REQUIRED]

The identifier of the subscription request that is to be updated.

type requestReason

string

param requestReason

[REQUIRED]

The reason for the UpdateSubscriptionRequest action.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'decisionComment': 'string',
    'domainId': 'string',
    'id': 'string',
    'requestReason': 'string',
    'reviewerId': 'string',
    'status': 'PENDING'|'ACCEPTED'|'REJECTED',
    'subscribedListings': [
        {
            'description': 'string',
            'id': 'string',
            'item': {
                'assetListing': {
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'entityType': 'string',
                    'forms': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ]
                },
                'productListing': {
                    'assetListings': [
                        {
                            'entityId': 'string',
                            'entityRevision': 'string',
                            'entityType': 'string'
                        },
                    ],
                    'description': 'string',
                    'entityId': 'string',
                    'entityRevision': 'string',
                    'glossaryTerms': [
                        {
                            'name': 'string',
                            'shortDescription': 'string'
                        },
                    ],
                    'name': 'string'
                }
            },
            'name': 'string',
            'ownerProjectId': 'string',
            'ownerProjectName': 'string',
            'revision': 'string'
        },
    ],
    'subscribedPrincipals': [
        {
            'project': {
                'id': 'string',
                'name': 'string'
            }
        },
    ],
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp of when the subscription request was created.

    • createdBy (string) --

      The Amazon DataZone user who created the subscription request.

    • decisionComment (string) --

      The decision comment of the UpdateSubscriptionRequest action.

    • domainId (string) --

      The identifier of the Amazon DataZone domain in which a subscription request is to be updated.

    • id (string) --

      The identifier of the subscription request that is to be updated.

    • requestReason (string) --

      The reason for the UpdateSubscriptionRequest action.

    • reviewerId (string) --

      The identifier of the Amazon DataZone user who reviews the subscription request.

    • status (string) --

      The status of the subscription request.

    • subscribedListings (list) --

      The subscribed listings of the subscription request.

      • (dict) --

        The details of the published asset for which the subscription grant is created.

        • description (string) --

          The description of the published asset for which the subscription grant is created.

        • id (string) --

          The identifier of the published asset for which the subscription grant is created.

        • item (dict) --

          The published asset for which the subscription grant is created.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • entityId (string) --

              The identifier of the published asset for which the subscription grant is created.

            • entityRevision (string) --

              The revision of the published asset for which the subscription grant is created.

            • entityType (string) --

              The type of the published asset for which the subscription grant is created.

            • forms (string) --

              The forms attached to the published asset for which the subscription grant is created.

            • glossaryTerms (list) --

              The glossary terms attached to the published asset for which the subscription grant is created.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

          • productListing (dict) --

            The data product listing.

            • assetListings (list) --

              The data assets of the data product listing.

              • (dict) --

                The listing of the asset in a data product.

                • entityId (string) --

                  The entity ID of the listing of the asset in a data product.

                • entityRevision (string) --

                  The entity revision of the listing of the asset in a data product.

                • entityType (string) --

                  The entity type of the listing of the asset in a data product.

            • description (string) --

              The description of the data product listing.

            • entityId (string) --

              The ID of the data product listing.

            • entityRevision (string) --

              The revision of the data product listing.

            • glossaryTerms (list) --

              The glossary terms of the data product listing.

              • (dict) --

                Details of a glossary term attached to the inventory asset.

                • name (string) --

                  The name of a glossary term attached to the inventory asset.

                • shortDescription (string) --

                  The shoft description of a glossary term attached to the inventory asset.

            • name (string) --

              The name of the data product listing.

        • name (string) --

          The name of the published asset for which the subscription grant is created.

        • ownerProjectId (string) --

          The identifier of the project of the published asset for which the subscription grant is created.

        • ownerProjectName (string) --

          The name of the project that owns the published asset for which the subscription grant is created.

        • revision (string) --

          The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipals (list) --

      The subscribed principals of the subscription request.

      • (dict) --

        The principal that has the subscription grant for the asset.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • project (dict) --

          The project that has the subscription grant.

          • id (string) --

            The identifier of the project that has the subscription grant.

          • name (string) --

            The name of the project that has the subscription grant.

    • updatedAt (datetime) --

      The timestamp of when the subscription request was updated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the subscription request.