UpdateSubscriptionGrantStatus - Amazon DataZone
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

UpdateSubscriptionGrantStatus

Updates the status of the specified subscription grant status in Amazon DataZone.

Request Syntax

PATCH /v2/domains/domainIdentifier/subscription-grants/identifier/status/assetIdentifier HTTP/1.1
Content-type: application/json

{
   "failureCause": { 
      "message": "string"
   },
   "status": "string",
   "targetName": "string"
}

URI Request Parameters

The request uses the following URI parameters.

assetIdentifier

The identifier of the asset the subscription grant status of which is to be updated.

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

Required: Yes

domainIdentifier

The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

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

Required: Yes

identifier

The identifier of the subscription grant the status of which is to be updated.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

failureCause

Specifies the error message that is returned if the operation cannot be successfully completed.

Type: FailureCause object

Required: No

status

The status to be updated as part of the UpdateSubscriptionGrantStatus action.

Type: String

Valid Values: GRANT_PENDING | REVOKE_PENDING | GRANT_IN_PROGRESS | REVOKE_IN_PROGRESS | GRANTED | REVOKED | GRANT_FAILED | REVOKE_FAILED

Required: Yes

targetName

The target name to be updated as part of the UpdateSubscriptionGrantStatus action.

Type: String

Required: No

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 details of the asset for which the subscription grant is created.

Type: Array of SubscribedAsset objects

createdAt

The timestamp of when the subscription grant status was created.

Type: Timestamp

createdBy

The Amazon DataZone domain user who created the subscription grant status.

Type: String

domainId

The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

Type: String

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

grantedEntity

The granted entity to be updated as part of the UpdateSubscriptionGrantStatus action.

Type: GrantedEntity object

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

id

The identifier of the subscription grant.

Type: String

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

status

The status to be updated as part of the UpdateSubscriptionGrantStatus action.

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.

Type: String

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

subscriptionTargetId

The identifier of the subscription target whose subscription grant status is to be updated.

Type: String

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

updatedAt

The timestamp of when the subscription grant status is to be updated.

Type: Timestamp

updatedBy

The Amazon DataZone user who updated the subscription grant status.

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: