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",
"metadataForms": [
{
"content": "string",
"formName": "string",
"typeIdentifier": "string",
"typeRevision": "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
- metadataForms
-
The metadata form included in the subscription request.
Type: Array of FormInput objects
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",
"existingSubscriptionId": "string",
"id": "string",
"metadataForms": [
{
"content": "string",
"formName": "string",
"typeName": "string",
"typeRevision": "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"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- createdAt
-
A timestamp of when the subscription request is created.
Type: Timestamp
- createdBy
-
The Amazon DataZone user who created the subscription request.
Type: String
- decisionComment
-
The decision comment of the subscription request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
- domainId
-
The ID of the Amazon DataZone domain in whcih the subscription request is created.
Type: String
Pattern:
dzd[-_][a-zA-Z0-9_-]{1,36} - existingSubscriptionId
-
The ID of the existing subscription.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36} - id
-
The ID of the subscription request.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36} - metadataForms
-
The metadata form included in the subscription request.
Type: Array of FormOutput objects
- requestReason
-
The reason for the subscription request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
- reviewerId
-
The ID of the reviewer of the subscription request.
Type: String
- status
-
The status of the subscription request.
Type: String
Valid Values:
PENDING | ACCEPTED | REJECTED - subscribedListings
-
The published asset for which the subscription grant is to be created.
Type: Array of SubscribedListing objects
Array Members: Fixed number of 1 item.
- subscribedPrincipals
-
The subscribed principals of the subscription request.
Type: Array of SubscribedPrincipal objects
Array Members: Fixed number of 1 item.
- updatedAt
-
The timestamp of when the subscription request was updated.
Type: Timestamp
- updatedBy
-
The Amazon DataZone user who updated the subscription request.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
There is a conflict while performing this action.
HTTP Status Code: 409
- InternalServerException
-
The request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UnauthorizedException
-
You do not have permission to perform this action.
HTTP Status Code: 401
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
