- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateSubscriptionTargetCommand
Updates the specified subscription target in Amazon DataZone.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, UpdateSubscriptionTargetCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, UpdateSubscriptionTargetCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // UpdateSubscriptionTargetInput
domainIdentifier: "STRING_VALUE", // required
environmentIdentifier: "STRING_VALUE", // required
identifier: "STRING_VALUE", // required
name: "STRING_VALUE",
authorizedPrincipals: [ // AuthorizedPrincipalIdentifiers
"STRING_VALUE",
],
applicableAssetTypes: [ // ApplicableAssetTypes
"STRING_VALUE",
],
subscriptionTargetConfig: [ // SubscriptionTargetForms
{ // SubscriptionTargetForm
formName: "STRING_VALUE", // required
content: "STRING_VALUE", // required
},
],
manageAccessRole: "STRING_VALUE",
provider: "STRING_VALUE",
};
const command = new UpdateSubscriptionTargetCommand(input);
const response = await client.send(command);
// { // UpdateSubscriptionTargetOutput
// id: "STRING_VALUE", // required
// authorizedPrincipals: [ // AuthorizedPrincipalIdentifiers // required
// "STRING_VALUE",
// ],
// domainId: "STRING_VALUE", // required
// projectId: "STRING_VALUE", // required
// environmentId: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// type: "STRING_VALUE", // required
// createdBy: "STRING_VALUE", // required
// updatedBy: "STRING_VALUE",
// createdAt: new Date("TIMESTAMP"), // required
// updatedAt: new Date("TIMESTAMP"),
// manageAccessRole: "STRING_VALUE",
// applicableAssetTypes: [ // ApplicableAssetTypes // required
// "STRING_VALUE",
// ],
// subscriptionTargetConfig: [ // SubscriptionTargetForms // required
// { // SubscriptionTargetForm
// formName: "STRING_VALUE", // required
// content: "STRING_VALUE", // required
// },
// ],
// provider: "STRING_VALUE", // required
// };
UpdateSubscriptionTargetCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The identifier of the Amazon DataZone domain in which a subscription target is to be updated. |
environmentIdentifier Required | string | undefined | The identifier of the environment in which a subscription target is to be updated. |
identifier Required | string | undefined | Identifier of the subscription target that is to be updated. |
applicableAssetTypes | string[] | undefined | The applicable asset types to be updated as part of the |
authorizedPrincipals | string[] | undefined | The authorized principals to be updated as part of the |
manageAccessRole | string | undefined | The manage access role to be updated as part of the |
name | string | undefined | The name to be updated as part of the |
provider | string | undefined | The provider to be updated as part of the |
subscriptionTargetConfig | SubscriptionTargetForm[] | undefined | The configuration to be updated as part of the |
UpdateSubscriptionTargetCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
applicableAssetTypes Required | string[] | undefined | The applicable asset types to be updated as part of the |
authorizedPrincipals Required | string[] | undefined | The authorized principals to be updated as part of the |
createdAt Required | Date | undefined | The timestamp of when a subscription target was created. |
createdBy Required | string | undefined | The Amazon DataZone user who created the subscription target. |
domainId Required | string | undefined | The identifier of the Amazon DataZone domain in which a subscription target is to be updated. |
environmentId Required | string | undefined | The identifier of the environment in which a subscription target is to be updated. |
id Required | string | undefined | Identifier of the subscription target that is to be updated. |
name Required | string | undefined | The name to be updated as part of the |
projectId Required | string | undefined | The identifier of the project in which a subscription target is to be updated. |
provider Required | string | undefined | The provider to be updated as part of the |
subscriptionTargetConfig Required | SubscriptionTargetForm[] | undefined | The configuration to be updated as part of the |
type Required | string | undefined | The type to be updated as part of the |
manageAccessRole | string | undefined | The manage access role to be updated as part of the |
updatedAt | Date | undefined | The timestamp of when the subscription target was updated. |
updatedBy | string | undefined | The Amazon DataZone user who updated the subscription target. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ConflictException | client | There is a conflict while performing this action. |
InternalServerException | server | The request has failed because of an unknown error, exception or failure. |
ResourceNotFoundException | client | The specified resource cannot be found. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints specified by the Amazon Web Services service. |
UnauthorizedException | client | You do not have permission to perform this action. |
DataZoneServiceException | Base exception class for all service exceptions from DataZone service. |