RevokeRevision
This operation revokes subscribers' access to a revision.
Request Syntax
POST /v1/data-sets/DataSetId/revisions/RevisionId/revoke HTTP/1.1
Content-type: application/json
{
"RevocationComment": "string"
}URI Request Parameters
The request uses the following URI parameters.
- DataSetId
-
The unique identifier for a data set.
Required: Yes
- RevisionId
-
The unique identifier for a revision.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- RevocationComment
-
A required comment to inform subscribers of the reason their access to the revision was revoked.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 512.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"Comment": "string",
"CreatedAt": "string",
"DataSetId": "string",
"Finalized": boolean,
"Id": "string",
"RevocationComment": "string",
"Revoked": boolean,
"RevokedAt": "string",
"SourceId": "string",
"UpdatedAt": "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.
- Arn
-
The ARN for the revision.
Type: String
- Comment
-
An optional comment about the revision.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 16384.
- CreatedAt
-
The date and time that the revision was created, in ISO 8601 format.
Type: Timestamp
- DataSetId
-
The unique identifier for the data set associated with the data set revision.
Type: String
- Finalized
-
To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
Type: Boolean
- Id
-
The unique identifier for the revision.
Type: String
- RevocationComment
-
A required comment to inform subscribers of the reason their access to the revision was revoked.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 512.
- Revoked
-
A status indicating that subscribers' access to the revision was revoked.
Type: Boolean
- RevokedAt
-
The date and time that the revision was revoked, in ISO 8601 format.
Type: Timestamp
- SourceId
-
The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
Type: String
- UpdatedAt
-
The date and time that the revision was last updated, in ISO 8601 format.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to the resource is denied.
HTTP Status Code: 403
- ConflictException
-
The request couldn't be completed because it conflicted with the current state of the resource.
HTTP Status Code: 409
- InternalServerException
-
An exception occurred with the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource couldn't be found.
HTTP Status Code: 404
- ThrottlingException
-
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
- ValidationException
-
The request was invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
