UpdateSubscriptionTarget - Amazon DataZone

UpdateSubscriptionTarget

Updates the specified subscription target in Amazon DataZone.

Request Syntax

PATCH /v2/domains/domainIdentifier/environments/environmentIdentifier/subscription-targets/identifier HTTP/1.1 Content-type: application/json { "applicableAssetTypes": [ "string" ], "authorizedPrincipals": [ "string" ], "manageAccessRole": "string", "name": "string", "provider": "string", "subscriptionTargetConfig": [ { "content": "string", "formName": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

environmentIdentifier

The identifier of the environment in which a subscription target is to be updated.

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

Required: Yes

identifier

Identifier of the subscription target that is to be updated.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

applicableAssetTypes

The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

Type: Array of strings

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

Pattern: ^[^\.]*

Required: No

authorizedPrincipals

The authorized principals to be updated as part of the UpdateSubscriptionTarget action.

Type: Array of strings

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

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

Required: No

manageAccessRole

The manage access role to be updated as part of the UpdateSubscriptionTarget action.

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

Required: No

name

The name to be updated as part of the UpdateSubscriptionTarget action.

Type: String

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

Required: No

provider

The provider to be updated as part of the UpdateSubscriptionTarget action.

Type: String

Required: No

subscriptionTargetConfig

The configuration to be updated as part of the UpdateSubscriptionTarget action.

Type: Array of SubscriptionTargetForm objects

Required: No

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 applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

Type: Array of strings

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

Pattern: ^[^\.]*

authorizedPrincipals

The authorized principals to be updated as part of the UpdateSubscriptionTarget action.

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 a subscription target was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created the subscription target.

Type: String

domainId

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

Type: String

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

environmentId

The identifier of the environment in which a subscription target is to be updated.

Type: String

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

id

Identifier of the subscription target that is to be updated.

Type: String

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

manageAccessRole

The manage access role to be updated as part of the UpdateSubscriptionTarget action.

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

name

The name to be updated as part of the UpdateSubscriptionTarget action.

Type: String

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

projectId

The identifier of the project in which a subscription target is to be updated.

Type: String

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

provider

The provider to be updated as part of the UpdateSubscriptionTarget action.

Type: String

subscriptionTargetConfig

The configuration to be updated as part of the UpdateSubscriptionTarget action.

Type: Array of SubscriptionTargetForm objects

type

The type to be updated as part of the UpdateSubscriptionTarget action.

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

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: