DataZone / Client / accept_subscription_request

accept_subscription_request#

DataZone.Client.accept_subscription_request(**kwargs)#

Accepts a subscription request to a specific asset.

See also: AWS API Documentation

Request Syntax

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

  • assetScopes (list) –

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

  • decisionComment (string) – A description that specifies the reason for accepting the specified subscription request.

  • domainIdentifier (string) –

    [REQUIRED]

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

  • identifier (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'decisionComment': 'string',
    'domainId': 'string',
    'existingSubscriptionId': 'string',
    'id': 'string',
    'metadataForms': [
        {
            'content': 'string',
            'formName': 'string',
            'typeName': 'string',
            'typeRevision': '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.

    • existingSubscriptionId (string) –

      The ID of the existing subscription.

    • id (string) –

      The identifier of the subscription request.

    • metadataForms (list) –

      The metadata form in the subscription request.

      • (dict) –

        The details of a metadata form.

        • content (string) –

          The content of the metadata form.

        • formName (string) –

          The name of the metadata form.

        • typeName (string) –

          The name of the metadata form type.

        • typeRevision (string) –

          The revision of the metadata form type.

    • requestReason (string) –

      Specifies the reason for requesting a subscription to the asset.

    • reviewerId (string) –

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

    • status (string) –

      Specifies the status of the subscription request.

    • subscribedListings (list) –

      Specifies the asset for which the subscription request was created.

      • (dict) –

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

        • description (string) –

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

        • id (string) –

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

        • item (dict) –

          The published asset for which the subscription grant is created.

          Note

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

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • assetListing (dict) –

            The asset for which the subscription grant is created.

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

        Note

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

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • project (dict) –

          The project that has the subscription grant.

          • id (string) –

            The identifier of the project that has the subscription grant.

          • name (string) –

            The name of the project that has the subscription grant.

    • updatedAt (datetime) –

      Specifies the timestamp when subscription request was updated.

    • updatedBy (string) –

      Specifies the Amazon DataZone user who updated the subscription request.

Exceptions