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: Yes
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"
}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.
- assets
-
The assets for which the subscription grant is created.
Type: Array of SubscribedAsset objects
- createdAt
-
A timestamp of when the subscription grant is created.
Type: Timestamp
- createdBy
-
The Amazon DataZone user who created the subscription grant.
Type: String
- domainId
-
The ID of the Amazon DataZone domain in which the subscription grant is created.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$ - grantedEntity
-
The entity to which the subscription is granted.
Type: GrantedEntity object
Note: This object is a Union. Only one member of this object can be specified or returned.
- id
-
The ID of the subscription grant.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - status
-
The status of the subscription grant.
Type: String
Valid Values:
PENDING | IN_PROGRESS | GRANT_FAILED | REVOKE_FAILED | GRANT_AND_REVOKE_FAILED | COMPLETED | INACCESSIBLE - subscriptionId
-
This parameter has been deprecated.
The identifier of the subscription grant.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - subscriptionTargetId
-
The ID of the subscription target for which the subscription grant is created.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - updatedAt
-
A timestamp of when the subscription grant was updated.
Type: Timestamp
- updatedBy
-
The Amazon DataZone user who updated the subscription grant.
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:
