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

AcceptSubscriptionRequest

Accepts a subscription request to a specific asset.

Request Syntax


PUT /v2/domains/domainIdentifier/subscription-requests/identifier/accept HTTP/1.1
Content-type: application/json

{
   "assetScopes": [ 
      { 
         "assetId": "string",
         "filterIds": [ "string" ]
      }
   ],
   "decisionComment": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The Amazon DataZone domain where the specified subscription request is being accepted.

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

Required: Yes

identifier

The unique identifier of the subscription request that is to be accepted.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

assetScopes

The asset scopes of the accept subscription request.

Type: Array of AcceptedAssetScope objects

Required: No

decisionComment

A description that specifies the reason for accepting the specified subscription request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

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

The timestamp that specifies when the subscription request was accepted.

Type: Timestamp

createdBy

Specifies the Amazon DataZone user that accepted the specified subscription request.

Type: String

decisionComment

Specifies the reason for accepting the subscription request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

domainId

The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted.

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 identifier of the subscription request.

Type: String

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

metadataForms

The metadata form in the subscription request.

Type: Array of FormOutput objects

requestReason

Specifies the reason for requesting a subscription to the asset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

reviewerId

Specifes the ID of the Amazon DataZone user who reviewed the subscription request.

Type: String

status

Specifies the status of the subscription request.

Type: String

Valid Values: PENDING | ACCEPTED | REJECTED

subscribedListings

Specifies the asset for which the subscription request was created.

Type: Array of SubscribedListing objects

Array Members: Fixed number of 1 item.

subscribedPrincipals

Specifies the Amazon DataZone users who are subscribed to the asset specified in the subscription request.

Type: Array of SubscribedPrincipal objects

Array Members: Fixed number of 1 item.

updatedAt

Specifies the timestamp when subscription request was updated.

Type: Timestamp

updatedBy

Specifies 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