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

GetSubscriptionTarget

Gets the subscription target in Amazon DataZone.

Request Syntax


GET /v2/domains/domainIdentifier/environments/environmentIdentifier/subscription-targets/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain in which the subscription target exists.

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

Required: Yes

environmentIdentifier

The ID of the environment associated with the subscription target.

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

Required: Yes

identifier

The ID of the subscription target.

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

{
   "applicableAssetTypes": [ "string" ],
   "authorizedPrincipals": [ "string" ],
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "environmentId": "string",
   "id": "string",
   "manageAccessRole": "string",
   "name": "string",
   "projectId": "string",
   "provider": "string",
   "subscriptionTargetConfig": [ 
      { 
         "content": "string",
         "formName": "string"
      }
   ],
   "type": "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.

applicableAssetTypes

The asset types associated with the subscription target.

Type: Array of strings

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

Pattern: ^[^\.]*

authorizedPrincipals

The authorized principals of the subscription target.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: ^[a-zA-Z0-9:/_-]*$

createdAt

The timestamp of when the subscription target was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created the subscription target.

Type: String

domainId

The ID of the Amazon DataZone domain in which the subscription target exists.

Type: String

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

environmentId

The ID of the environment associated with the subscription target.

Type: String

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

id

The ID of the subscription target.

Type: String

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

manageAccessRole

The manage access role with which the subscription target was created.

Type: String

name

The name of the subscription target.

Type: String

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

projectId

The ID of the project associated with the subscription target.

Type: String

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

provider

The provider of the subscription target.

Type: String

subscriptionTargetConfig

The configuration of teh subscription target.

Type: Array of SubscriptionTargetForm objects

type

The type of the subscription target.

Type: String

updatedAt

The timestamp of when the subscription target was updated.

Type: Timestamp

updatedBy

The Amazon DataZone user who updated the subscription target.

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

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