Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateSubscriptionGrant

Creates a subsscription grant in Amazon DataZone.

Request Syntax


POST /v2/domains/domainIdentifier/subscription-grants HTTP/1.1
Content-type: application/json

{
   "assetTargetNames": [ 
      { 
         "assetId": "string",
         "targetName": "string"
      }
   ],
   "clientToken": "string",
   "environmentIdentifier": "string",
   "grantedEntity": { ... },
   "subscriptionTargetIdentifier": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

assetTargetNames

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

Type: Array of AssetTargetNameMap objects

Required: No

clientToken

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

Type: String

Required: No

environmentIdentifier

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

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: Yes

grantedEntity

The entity to which the subscription is to be granted.

Type: GrantedEntityInput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

subscriptionTargetIdentifier

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

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assets": [ 
      { 
         "assetId": "string",
         "assetRevision": "string",
         "assetScope": { 
            "assetId": "string",
            "errorMessage": "string",
            "filterIds": [ "string" ],
            "status": "string"
         },
         "failureCause": { 
            "message": "string"
         },
         "failureTimestamp": number,
         "grantedTimestamp": number,
         "status": "string",
         "targetName": "string"
      }
   ],
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "grantedEntity": { ... },
   "id": "string",
   "status": "string",
   "subscriptionId": "string",
   "subscriptionTargetId": "string",
   "updatedAt": number,
   "updatedBy": "string"
}