RevokeSubscription
Revokes a specified subscription in Amazon DataZone.
Request Syntax
PUT /v2/domains/domainIdentifier/subscriptions/identifier/revoke HTTP/1.1
Content-type: application/json
{
"retainPermissions": boolean
}URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The identifier of the Amazon DataZone domain where you want to revoke a subscription.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- identifier
-
The identifier of the revoked subscription.
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- retainPermissions
-
Specifies whether permissions are retained when the subscription is revoked.
Type: Boolean
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": number,
"createdBy": "string",
"domainId": "string",
"id": "string",
"retainPermissions": boolean,
"status": "string",
"subscribedListing": {
"description": "string",
"id": "string",
"item": { ... },
"name": "string",
"ownerProjectId": "string",
"ownerProjectName": "string",
"revision": "string"
},
"subscribedPrincipal": { ... },
"subscriptionRequestId": "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.
- createdAt
-
The timestamp of when the subscription was revoked.
Type: Timestamp
- createdBy
-
The identifier of the user who revoked the subscription.
Type: String
- domainId
-
The identifier of the Amazon DataZone domain where you want to revoke a subscription.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$ - id
-
The identifier of the revoked subscription.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - retainPermissions
-
Specifies whether permissions are retained when the subscription is revoked.
Type: Boolean
- status
-
The status of the revoked subscription.
Type: String
Valid Values:
APPROVED | REVOKED | CANCELLED - subscribedListing
-
The subscribed listing of the revoked subscription.
Type: SubscribedListing object
- subscribedPrincipal
-
The subscribed principal of the revoked subscription.
Type: SubscribedPrincipal object
Note: This object is a Union. Only one member of this object can be specified or returned.
- subscriptionRequestId
-
The identifier of the subscription request for the revoked subscription.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - updatedAt
-
The timestamp of when the subscription was revoked.
Type: Timestamp
- updatedBy
-
The Amazon DataZone user who revoked the subscription.
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:
