DataZone / Client / get_subscription_request_details

get_subscription_request_details

DataZone.Client.get_subscription_request_details(**kwargs)

Gets the details of the specified subscription request.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

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

• identifier (string) –

  [REQUIRED]

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

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

  • existingSubscriptionId (string) –

    The ID of the existing subscription.

  • id (string) –

    The identifier of the subscription request.

  • metadataForms (list) –

    The metadata forms included 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) –

    The reason for the subscription request.

  • reviewerId (string) –

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

  • status (string) –

    The status of the subscription request.

  • subscribedListings (list) –

    The subscribed listings in the subscription request.

    • (dict) –

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

      • description (string) –

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

      • id (string) –

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

      • item (dict) –

        The published asset for which the subscription grant is created.

        Note

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

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

        • assetListing (dict) –

          The asset for which the subscription grant is created.

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

      Note

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

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

      • project (dict) –

        The project that has the subscription grant.

        • id (string) –

          The identifier of the project that has the subscription grant.

        • name (string) –

          The name of the project that has the subscription grant.

  • updatedAt (datetime) –

    The timestamp of when the subscription request was updated.

  • updatedBy (string) –

    The Amazon DataZone user who updated the subscription request.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException