DataZone / Client / list_subscription_grants

list_subscription_grants#

DataZone.Client.list_subscription_grants(**kwargs)#

Lists subscription grants.

See also: AWS API Documentation

Request Syntax

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

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain.

  • environmentId (string) – The identifier of the Amazon DataZone environment.

  • maxResults (integer) – 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.

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

  • sortBy (string) – Specifies the way of sorting the results of this action.

  • sortOrder (string) – Specifies the sort order of this action.

  • subscribedListingId (string) – The identifier of the subscribed listing.

  • subscriptionId (string) – The identifier of the subscription.

  • subscriptionTargetId (string) – The identifier of the subscription target.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • items (list) –

      The results of the ListSubscriptionGrants action.

      • (dict) –

        The details of the subscription grant.

        • assets (list) –

          The assets included in the subscription grant.

          • (dict) –

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

            • assetId (string) –

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

            • assetRevision (string) –

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

            • failureCause (dict) –

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

              • message (string) –

                The description of the error message.

            • failureTimestamp (datetime) –

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

            • grantedTimestamp (datetime) –

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

            • status (string) –

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

            • targetName (string) –

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

        • createdAt (datetime) –

          The timestamp of when a subscription grant was created.

        • createdBy (string) –

          The datazone user who created the subscription grant.

        • domainId (string) –

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

        • grantedEntity (dict) –

          The entity to which the subscription is granted.

          Note

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

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

          • listing (dict) –

            The listing for which a subscription is granted.

            • id (string) –

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

            • revision (string) –

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

        • id (string) –

          The identifier of the subscription grant.

        • status (string) –

          The status of the subscription grant.

        • subscriptionId (string) –

          The ID of the subscription grant.

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

Exceptions