- 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.
CreateSubscriptionTargetCommand
Creates a subscription target in Amazon DataZone.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, CreateSubscriptionTargetCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateSubscriptionTargetCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateSubscriptionTargetInput
domainIdentifier: "STRING_VALUE", // required
environmentIdentifier: "STRING_VALUE", // required
name: "STRING_VALUE", // required
type: "STRING_VALUE", // required
subscriptionTargetConfig: [ // SubscriptionTargetForms // required
{ // SubscriptionTargetForm
formName: "STRING_VALUE", // required
content: "STRING_VALUE", // required
},
],
authorizedPrincipals: [ // AuthorizedPrincipalIdentifiers // required
"STRING_VALUE",
],
manageAccessRole: "STRING_VALUE", // required
applicableAssetTypes: [ // ApplicableAssetTypes // required
"STRING_VALUE",
],
provider: "STRING_VALUE",
clientToken: "STRING_VALUE",
};
const command = new CreateSubscriptionTargetCommand(input);
const response = await client.send(command);
// { // CreateSubscriptionTargetOutput
// 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
// };
CreateSubscriptionTargetCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
applicableAssetTypes Required | string[] | undefined | The asset types that can be included in the subscription target. |
authorizedPrincipals Required | string[] | undefined | The authorized principals of the subscription target. |
domainIdentifier Required | string | undefined | The ID of the Amazon DataZone domain in which subscription target is created. |
environmentIdentifier Required | string | undefined | The ID of the environment in which subscription target is created. |
manageAccessRole Required | string | undefined | The manage access role that is used to create the subscription target. |
name Required | string | undefined | The name of the subscription target. |
subscriptionTargetConfig Required | SubscriptionTargetForm[] | undefined | The configuration of the subscription target. |
type Required | string | undefined | The type of the subscription target. |
clientToken | string | undefined | A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. |
provider | string | undefined | The provider of the subscription target. |
CreateSubscriptionTargetCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
applicableAssetTypes Required | string[] | undefined | The asset types that can be included in the subscription target. |
authorizedPrincipals Required | string[] | undefined | The authorised principals of the subscription target. |
createdAt Required | Date | undefined | The timestamp of when the subscription target was created. |
createdBy Required | string | undefined | The Amazon DataZone user who created the subscription target. |
domainId Required | string | undefined | The ID of the Amazon DataZone domain in which the subscription target was created. |
environmentId Required | string | undefined | The ID of the environment in which the subscription target was created. |
id Required | string | undefined | The ID of the subscription target. |
name Required | string | undefined | The name of the subscription target. |
projectId Required | string | undefined | ??? |
provider Required | string | undefined | The provider of the subscription target. |
subscriptionTargetConfig Required | SubscriptionTargetForm[] | undefined | The configuration of the subscription target. |
type Required | string | undefined | The type of the subscription target. |
manageAccessRole | string | undefined | The manage access role with which the subscription target was created. |
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. |