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

CreateSubscriptionRequest

Creates a subscription request in Amazon DataZone.

Request Syntax


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

{
   "clientToken": "string",
   "requestReason": "string",
   "subscribedListings": [ 
      { 
         "identifier": "string"
      }
   ],
   "subscribedPrincipals": [ 
      { ... }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

Required: No

requestReason

The reason for the subscription request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: Yes

subscribedListings

The published asset for which the subscription grant is to be created.

Type: Array of SubscribedListingInput objects

Array Members: Fixed number of 1 item.

Required: Yes

subscribedPrincipals

The Amazon DataZone principals for whom the subscription request is created.

Type: Array of SubscribedPrincipalInput objects

Array Members: Fixed number of 1 item.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "decisionComment": "string",
   "domainId": "string",
   "id": "string",
   "requestReason": "string",
   "reviewerId": "string",
   "status": "string",
   "subscribedListings": [ 
      { 
         "description": "string",
         "id": "string",
         "item": { ... },
         "name": "string",
         "ownerProjectId": "string",
         "ownerProjectName": "string",
         "revision": "string"
      }
   ],
   "subscribedPrincipals": [ 
      { ... }
   ],
   "updatedAt": number,
   "updatedBy": "string"
}