Amazon DataZone

2024/09/03 - Amazon DataZone - 15 updated api methods

Changes  Add support to let data publisher specify a subset of the data asset that a subscriber will have access to based on the asset filters provided, when accepting a subscription request.

AcceptSubscriptionRequest (updated) Link ¶
Changes (request, response)
Request
{'assetScopes': [{'assetId': 'string', 'filterIds': ['string']}]}
Response
{'subscribedListings': {'item': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                 'errorMessage': 'string',
                                                                 'filterIds': ['string'],
                                                                 'status': 'string'}}}}}

Accepts a subscription request to a specific asset.

See also: AWS API Documentation

Request Syntax

client.accept_subscription_request(
    assetScopes=[
        {
            'assetId': 'string',
            'filterIds': [
                'string',
            ]
        },
    ],
    decisionComment='string',
    domainIdentifier='string',
    identifier='string'
)
type assetScopes:

list

param assetScopes:

The asset scopes of the accept subscription request.

  • (dict) --

    The accepted asset scope.

    • assetId (string) -- [REQUIRED]

      The asset ID of the accepted asset scope.

    • filterIds (list) -- [REQUIRED]

      The filter IDs of the accepted asset scope.

      • (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': {
                    'assetScope': {
                        'assetId': 'string',
                        'errorMessage': 'string',
                        'filterIds': [
                            'string',
                        ],
                        'status': 'string'
                    },
                    '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.

          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • assetScope (dict) --

              The asset scope of the subscribed asset listing.

              • assetId (string) --

                The asset ID of the asset scope.

              • errorMessage (string) --

                The error message of the asset scope.

              • filterIds (list) --

                The filter IDs of the asset scope.

                • (string) --

              • status (string) --

                The status of the asset scope.

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

        • 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': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                'errorMessage': 'string',
                                                                'filterIds': ['string'],
                                                                'status': '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': {
                'assetScope': {
                    'assetId': 'string',
                    'errorMessage': 'string',
                    'filterIds': [
                        'string',
                    ],
                    'status': 'string'
                },
                '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.

        • assetListing (dict) --

          The asset for which the subscription grant is created.

          • assetScope (dict) --

            The asset scope of the subscribed asset listing.

            • assetId (string) --

              The asset ID of the asset scope.

            • errorMessage (string) --

              The error message of the asset scope.

            • filterIds (list) --

              The filter IDs of the asset scope.

              • (string) --

            • status (string) --

              The status of the asset scope.

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

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

CreateSubscriptionGrant (updated) Link ¶
Changes (response)
{'assets': {'assetScope': {'assetId': 'string',
                           'errorMessage': 'string',
                           'filterIds': ['string'],
                           'status': 'string'}}}

Creates a subsscription grant in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.create_subscription_grant(
    assetTargetNames=[
        {
            'assetId': 'string',
            'targetName': 'string'
        },
    ],
    clientToken='string',
    domainIdentifier='string',
    environmentIdentifier='string',
    grantedEntity={
        'listing': {
            'identifier': 'string',
            'revision': 'string'
        }
    },
    subscriptionTargetIdentifier='string'
)
type assetTargetNames:

list

param assetTargetNames:

The names of the assets for which the subscription grant is created.

  • (dict) --

    The name map for assets.

    • assetId (string) -- [REQUIRED]

      The identifier of the inventory asset.

    • targetName (string) -- [REQUIRED]

      The target name in the asset target name map.

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

type environmentIdentifier:

string

param environmentIdentifier:

[REQUIRED]

The ID of the environment in which the subscription grant is created.

type grantedEntity:

dict

param grantedEntity:

[REQUIRED]

The entity to which the subscription is to be granted.

  • listing (dict) --

    The listing for which a subscription is to be granted.

    • identifier (string) -- [REQUIRED]

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

    • revision (string) -- [REQUIRED]

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

type subscriptionTargetIdentifier:

string

param subscriptionTargetIdentifier:

[REQUIRED]

The ID of the subscription target for which the subscription grant is created.

rtype:

dict

returns:

Response Syntax

{
    'assets': [
        {
            'assetId': 'string',
            'assetRevision': 'string',
            'assetScope': {
                'assetId': 'string',
                'errorMessage': 'string',
                'filterIds': [
                    'string',
                ],
                'status': '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'
}

Response Structure

  • (dict) --

    • assets (list) --

      The assets for which the subscription grant is created.

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

        • assetScope (dict) --

          The asset scope of the subscribed asset.

          • assetId (string) --

            The asset ID of the asset scope.

          • errorMessage (string) --

            The error message of the asset scope.

          • filterIds (list) --

            The filter IDs of the asset scope.

            • (string) --

          • status (string) --

            The status of the asset scope.

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

      A timestamp of when the subscription grant is created.

    • createdBy (string) --

      The Amazon DataZone user who created the subscription grant.

    • domainId (string) --

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

    • grantedEntity (dict) --

      The entity to which the subscription is granted.

      • 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 ID of the subscription grant.

    • status (string) --

      The status of the subscription grant.

    • subscriptionId (string) --

      The identifier of the subscription grant.

    • subscriptionTargetId (string) --

      The ID of the subscription target for which the subscription grant is created.

    • updatedAt (datetime) --

      A timestamp of when the subscription grant was updated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the subscription grant.

CreateSubscriptionRequest (updated) Link ¶
Changes (response)
{'subscribedListings': {'item': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                 'errorMessage': 'string',
                                                                 'filterIds': ['string'],
                                                                 'status': '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.

    • 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': {
                    'assetScope': {
                        'assetId': 'string',
                        'errorMessage': 'string',
                        'filterIds': [
                            'string',
                        ],
                        'status': 'string'
                    },
                    '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.

          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • assetScope (dict) --

              The asset scope of the subscribed asset listing.

              • assetId (string) --

                The asset ID of the asset scope.

              • errorMessage (string) --

                The error message of the asset scope.

              • filterIds (list) --

                The filter IDs of the asset scope.

                • (string) --

              • status (string) --

                The status of the asset scope.

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

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

DeleteSubscriptionGrant (updated) Link ¶
Changes (response)
{'assets': {'assetScope': {'assetId': 'string',
                           'errorMessage': 'string',
                           'filterIds': ['string'],
                           'status': 'string'}}}

Deletes and subscription grant in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.delete_subscription_grant(
    domainIdentifier='string',
    identifier='string'
)
type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the Amazon DataZone domain where the subscription grant is deleted.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the subscription grant that is deleted.

rtype:

dict

returns:

Response Syntax

{
    'assets': [
        {
            'assetId': 'string',
            'assetRevision': 'string',
            'assetScope': {
                'assetId': 'string',
                'errorMessage': 'string',
                'filterIds': [
                    'string',
                ],
                'status': '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'
}

Response Structure

  • (dict) --

    • assets (list) --

      The assets for which the subsctiption grant that is deleted gave access.

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

        • assetScope (dict) --

          The asset scope of the subscribed asset.

          • assetId (string) --

            The asset ID of the asset scope.

          • errorMessage (string) --

            The error message of the asset scope.

          • filterIds (list) --

            The filter IDs of the asset scope.

            • (string) --

          • status (string) --

            The status of the asset scope.

        • 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 the subscription grant that is deleted was created.

    • createdBy (string) --

      The Amazon DataZone user who created the subscription grant that is deleted.

    • domainId (string) --

      The ID of the Amazon DataZone domain in which the subscription grant is deleted.

    • grantedEntity (dict) --

      The entity to which the subscription is deleted.

      • 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 ID of the subscription grant that is deleted.

    • status (string) --

      The status of the subscription grant that is deleted.

    • subscriptionId (string) --

      The identifier of the subsctiption whose subscription grant is to be deleted.

    • subscriptionTargetId (string) --

      The ID of the subscription target associated with the subscription grant that is deleted.

    • updatedAt (datetime) --

      The timestamp of when the subscription grant that is deleted was updated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the subscription grant that is deleted.

GetSubscription (updated) Link ¶
Changes (response)
{'subscribedListing': {'item': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                'errorMessage': 'string',
                                                                'filterIds': ['string'],
                                                                'status': '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': {
                'assetScope': {
                    'assetId': 'string',
                    'errorMessage': 'string',
                    'filterIds': [
                        'string',
                    ],
                    'status': 'string'
                },
                '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.

        • assetListing (dict) --

          The asset for which the subscription grant is created.

          • assetScope (dict) --

            The asset scope of the subscribed asset listing.

            • assetId (string) --

              The asset ID of the asset scope.

            • errorMessage (string) --

              The error message of the asset scope.

            • filterIds (list) --

              The filter IDs of the asset scope.

              • (string) --

            • status (string) --

              The status of the asset scope.

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

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

GetSubscriptionGrant (updated) Link ¶
Changes (response)
{'assets': {'assetScope': {'assetId': 'string',
                           'errorMessage': 'string',
                           'filterIds': ['string'],
                           'status': 'string'}}}

Gets the subscription grant in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.get_subscription_grant(
    domainIdentifier='string',
    identifier='string'
)
type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

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

type identifier:

string

param identifier:

[REQUIRED]

The ID of the subscription grant.

rtype:

dict

returns:

Response Syntax

{
    'assets': [
        {
            'assetId': 'string',
            'assetRevision': 'string',
            'assetScope': {
                'assetId': 'string',
                'errorMessage': 'string',
                'filterIds': [
                    'string',
                ],
                'status': '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'
}

Response Structure

  • (dict) --

    • assets (list) --

      The assets for which the subscription grant is created.

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

        • assetScope (dict) --

          The asset scope of the subscribed asset.

          • assetId (string) --

            The asset ID of the asset scope.

          • errorMessage (string) --

            The error message of the asset scope.

          • filterIds (list) --

            The filter IDs of the asset scope.

            • (string) --

          • status (string) --

            The status of the asset scope.

        • 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 the subscription grant is created.

    • createdBy (string) --

      The Amazon DataZone user who created the subscription grant.

    • domainId (string) --

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

    • grantedEntity (dict) --

      The entity to which the subscription is granted.

      • 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 ID of the subscription grant.

    • status (string) --

      The status of the subscription grant.

    • subscriptionId (string) --

      The identifier of the subscription.

    • subscriptionTargetId (string) --

      The subscription target ID associated with the subscription grant.

    • updatedAt (datetime) --

      The timestamp of when the subscription grant was upated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the subscription grant.

GetSubscriptionRequestDetails (updated) Link ¶
Changes (response)
{'subscribedListings': {'item': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                 'errorMessage': 'string',
                                                                 'filterIds': ['string'],
                                                                 'status': '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': {
                    'assetScope': {
                        'assetId': 'string',
                        'errorMessage': 'string',
                        'filterIds': [
                            'string',
                        ],
                        'status': 'string'
                    },
                    '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.

          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • assetScope (dict) --

              The asset scope of the subscribed asset listing.

              • assetId (string) --

                The asset ID of the asset scope.

              • errorMessage (string) --

                The error message of the asset scope.

              • filterIds (list) --

                The filter IDs of the asset scope.

                • (string) --

              • status (string) --

                The status of the asset scope.

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

        • 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 (response)
{'items': {'assets': {'assetScope': {'assetId': 'string',
                                     'errorMessage': 'string',
                                     'filterIds': ['string'],
                                     'status': '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',
                    'assetScope': {
                        'assetId': 'string',
                        'errorMessage': 'string',
                        'filterIds': [
                            'string',
                        ],
                        'status': '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.

            • assetScope (dict) --

              The asset scope of the subscribed asset.

              • assetId (string) --

                The asset ID of the asset scope.

              • errorMessage (string) --

                The error message of the asset scope.

              • filterIds (list) --

                The filter IDs of the asset scope.

                • (string) --

              • status (string) --

                The status of the asset scope.

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

          • 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': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                           'errorMessage': 'string',
                                                                           'filterIds': ['string'],
                                                                           'status': '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.

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': {
                            'assetScope': {
                                'assetId': 'string',
                                'errorMessage': 'string',
                                'filterIds': [
                                    'string',
                                ],
                                'status': 'string'
                            },
                            '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.

              • assetListing (dict) --

                The asset for which the subscription grant is created.

                • assetScope (dict) --

                  The asset scope of the subscribed asset listing.

                  • assetId (string) --

                    The asset ID of the asset scope.

                  • errorMessage (string) --

                    The error message of the asset scope.

                  • filterIds (list) --

                    The filter IDs of the asset scope.

                    • (string) --

                  • status (string) --

                    The status of the asset scope.

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

            • 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': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                          'errorMessage': 'string',
                                                                          'filterIds': ['string'],
                                                                          'status': '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.

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': {
                        'assetScope': {
                            'assetId': 'string',
                            'errorMessage': 'string',
                            'filterIds': [
                                'string',
                            ],
                            'status': 'string'
                        },
                        '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.

            • assetListing (dict) --

              The asset for which the subscription grant is created.

              • assetScope (dict) --

                The asset scope of the subscribed asset listing.

                • assetId (string) --

                  The asset ID of the asset scope.

                • errorMessage (string) --

                  The error message of the asset scope.

                • filterIds (list) --

                  The filter IDs of the asset scope.

                  • (string) --

                • status (string) --

                  The status of the asset scope.

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

          • 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': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                 'errorMessage': 'string',
                                                                 'filterIds': ['string'],
                                                                 'status': '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': {
                    'assetScope': {
                        'assetId': 'string',
                        'errorMessage': 'string',
                        'filterIds': [
                            'string',
                        ],
                        'status': 'string'
                    },
                    '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.

          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • assetScope (dict) --

              The asset scope of the subscribed asset listing.

              • assetId (string) --

                The asset ID of the asset scope.

              • errorMessage (string) --

                The error message of the asset scope.

              • filterIds (list) --

                The filter IDs of the asset scope.

                • (string) --

              • status (string) --

                The status of the asset scope.

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

        • 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': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                'errorMessage': 'string',
                                                                'filterIds': ['string'],
                                                                'status': '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': {
                'assetScope': {
                    'assetId': 'string',
                    'errorMessage': 'string',
                    'filterIds': [
                        'string',
                    ],
                    'status': 'string'
                },
                '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.

        • assetListing (dict) --

          The asset for which the subscription grant is created.

          • assetScope (dict) --

            The asset scope of the subscribed asset listing.

            • assetId (string) --

              The asset ID of the asset scope.

            • errorMessage (string) --

              The error message of the asset scope.

            • filterIds (list) --

              The filter IDs of the asset scope.

              • (string) --

            • status (string) --

              The status of the asset scope.

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

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

UpdateSubscriptionGrantStatus (updated) Link ¶
Changes (response)
{'assets': {'assetScope': {'assetId': 'string',
                           'errorMessage': 'string',
                           'filterIds': ['string'],
                           'status': 'string'}}}

Updates the status of the specified subscription grant status in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.update_subscription_grant_status(
    assetIdentifier='string',
    domainIdentifier='string',
    failureCause={
        'message': 'string'
    },
    identifier='string',
    status='GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED',
    targetName='string'
)
type assetIdentifier:

string

param assetIdentifier:

[REQUIRED]

The identifier of the asset the subscription grant status of which is to be updated.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

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

type failureCause:

dict

param failureCause:

Specifies the error message that is returned if the operation cannot be successfully completed.

  • message (string) --

    The description of the error message.

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the subscription grant the status of which is to be updated.

type status:

string

param status:

[REQUIRED]

The status to be updated as part of the UpdateSubscriptionGrantStatus action.

type targetName:

string

param targetName:

The target name to be updated as part of the UpdateSubscriptionGrantStatus action.

rtype:

dict

returns:

Response Syntax

{
    'assets': [
        {
            'assetId': 'string',
            'assetRevision': 'string',
            'assetScope': {
                'assetId': 'string',
                'errorMessage': 'string',
                'filterIds': [
                    'string',
                ],
                'status': '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'
}

Response Structure

  • (dict) --

    • assets (list) --

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

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

        • assetScope (dict) --

          The asset scope of the subscribed asset.

          • assetId (string) --

            The asset ID of the asset scope.

          • errorMessage (string) --

            The error message of the asset scope.

          • filterIds (list) --

            The filter IDs of the asset scope.

            • (string) --

          • status (string) --

            The status of the asset scope.

        • 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 the subscription grant status was created.

    • createdBy (string) --

      The Amazon DataZone domain user who created the subscription grant status.

    • domainId (string) --

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

    • grantedEntity (dict) --

      The granted entity to be updated as part of the UpdateSubscriptionGrantStatus action.

      • 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 to be updated as part of the UpdateSubscriptionGrantStatus action.

    • subscriptionId (string) --

      The identifier of the subscription.

    • subscriptionTargetId (string) --

      The identifier of the subscription target whose subscription grant status is to be updated.

    • updatedAt (datetime) --

      The timestamp of when the subscription grant status is to be updated.

    • updatedBy (string) --

      The Amazon DataZone user who updated the subscription grant status.

UpdateSubscriptionRequest (updated) Link ¶
Changes (response)
{'subscribedListings': {'item': {'assetListing': {'assetScope': {'assetId': 'string',
                                                                 'errorMessage': 'string',
                                                                 'filterIds': ['string'],
                                                                 'status': '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': {
                    'assetScope': {
                        'assetId': 'string',
                        'errorMessage': 'string',
                        'filterIds': [
                            'string',
                        ],
                        'status': 'string'
                    },
                    '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.

          • assetListing (dict) --

            The asset for which the subscription grant is created.

            • assetScope (dict) --

              The asset scope of the subscribed asset listing.

              • assetId (string) --

                The asset ID of the asset scope.

              • errorMessage (string) --

                The error message of the asset scope.

              • filterIds (list) --

                The filter IDs of the asset scope.

                • (string) --

              • status (string) --

                The status of the asset scope.

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

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