DataZone / Client / create_subscription_grant

create_subscription_grant#

DataZone.Client.create_subscription_grant(**kwargs)#

Creates a subsscription grant in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

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

  • assetTargetNames (list) –

    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.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • domainIdentifier (string) –

    [REQUIRED]

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

  • environmentIdentifier (string) –

    [REQUIRED]

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

  • grantedEntity (dict) –

    [REQUIRED]

    The entity to which the subscription is to be granted.

    Note

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

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

  • subscriptionTargetIdentifier (string) – The ID of the subscription target for which the subscription grant is created.

Return type:

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.

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

Exceptions