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

CancelSubscription

Cancels the subscription to the specified asset.

Request Syntax


PUT /v2/domains/domainIdentifier/subscriptions/identifier/cancel HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.

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

Required: Yes

identifier

The unique identifier of the subscription that is being cancelled.

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

Required: Yes

Request Body

The request does not have a request body.

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 that specifies when the request to cancel the subscription was created.

Type: Timestamp

createdBy

Specifies the Amazon DataZone user who is cancelling the subscription.

Type: String

domainId

The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.

Type: String

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

id

The identifier of the subscription.

Type: String

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

retainPermissions

Specifies whether the permissions to the asset are retained after the subscription is cancelled.

Type: Boolean

status

The status of the request to cancel the subscription.

Type: String

Valid Values: APPROVED | REVOKED | CANCELLED

subscribedListing

The asset to which a subscription is being cancelled.

Type: SubscribedListing object

subscribedPrincipal

The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.

Type: SubscribedPrincipal object

Note: This object is a Union. Only one member of this object can be specified or returned.

subscriptionRequestId

The unique ID of the subscripton request for the subscription that is being cancelled.

Type: String

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

updatedAt

The timestamp that specifies when the subscription was cancelled.

Type: Timestamp

updatedBy

The Amazon DataZone user that cancelled 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