@aws-sdk/client-supplychain 3.670.0 → 3.671.0

package/dist-types/commands/DeleteInstanceCommand.d.ts

@@ -0,0 +1,103 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DeleteInstanceRequest, DeleteInstanceResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteInstanceCommand}.
+ */
+export interface DeleteInstanceCommandInput extends DeleteInstanceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteInstanceCommand}.
+ */
+export interface DeleteInstanceCommandOutput extends DeleteInstanceResponse, __MetadataBearer {
+}
+declare const DeleteInstanceCommand_base: {
+    new (input: DeleteInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteInstanceCommandInput, DeleteInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteInstanceCommandInput, DeleteInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Delete the instance. This is an asynchronous operation. Upon receiving a DeleteInstance request, AWS Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance creation process. You can use the GetInstance action to check the instance status.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, DeleteInstanceCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, DeleteInstanceCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // DeleteInstanceRequest
+ *   instanceId: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteInstanceCommand(input);
+ * const response = await client.send(command);
+ * // { // DeleteInstanceResponse
+ * //   instance: { // Instance
+ * //     instanceId: "STRING_VALUE", // required
+ * //     awsAccountId: "STRING_VALUE", // required
+ * //     state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required
+ * //     webAppDnsDomain: "STRING_VALUE",
+ * //     createdTime: new Date("TIMESTAMP"),
+ * //     lastModifiedTime: new Date("TIMESTAMP"),
+ * //     instanceName: "STRING_VALUE",
+ * //     instanceDescription: "STRING_VALUE",
+ * //     kmsKeyArn: "STRING_VALUE",
+ * //     versionNumber: Number("double"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param DeleteInstanceCommandInput - {@link DeleteInstanceCommandInput}
+ * @returns {@link DeleteInstanceCommandOutput}
+ * @see {@link DeleteInstanceCommandInput} for command's `input` shape.
+ * @see {@link DeleteInstanceCommandOutput} for command's `response` shape.
+ * @see {@link SupplyChainClientResolvedConfig | config} for SupplyChainClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have the required privileges to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input does not satisfy the constraints specified by an AWS service.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Request would cause a service quota to be exceeded.</p>
+ *
+ * @throws {@link SupplyChainServiceException}
+ * <p>Base exception class for all service exceptions from SupplyChain service.</p>
+ *
+ * @public
+ */
+export declare class DeleteInstanceCommand extends DeleteInstanceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteInstanceRequest;
+            output: DeleteInstanceResponse;
+        };
+        sdk: {
+            input: DeleteInstanceCommandInput;
+            output: DeleteInstanceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/GetInstanceCommand.d.ts

@@ -0,0 +1,103 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetInstanceRequest, GetInstanceResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetInstanceCommand}.
+ */
+export interface GetInstanceCommandInput extends GetInstanceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetInstanceCommand}.
+ */
+export interface GetInstanceCommandOutput extends GetInstanceResponse, __MetadataBearer {
+}
+declare const GetInstanceCommand_base: {
+    new (input: GetInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<GetInstanceCommandInput, GetInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<GetInstanceCommandInput, GetInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Get the AWS Supply Chain instance details.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, GetInstanceCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, GetInstanceCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // GetInstanceRequest
+ *   instanceId: "STRING_VALUE", // required
+ * };
+ * const command = new GetInstanceCommand(input);
+ * const response = await client.send(command);
+ * // { // GetInstanceResponse
+ * //   instance: { // Instance
+ * //     instanceId: "STRING_VALUE", // required
+ * //     awsAccountId: "STRING_VALUE", // required
+ * //     state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required
+ * //     webAppDnsDomain: "STRING_VALUE",
+ * //     createdTime: new Date("TIMESTAMP"),
+ * //     lastModifiedTime: new Date("TIMESTAMP"),
+ * //     instanceName: "STRING_VALUE",
+ * //     instanceDescription: "STRING_VALUE",
+ * //     kmsKeyArn: "STRING_VALUE",
+ * //     versionNumber: Number("double"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetInstanceCommandInput - {@link GetInstanceCommandInput}
+ * @returns {@link GetInstanceCommandOutput}
+ * @see {@link GetInstanceCommandInput} for command's `input` shape.
+ * @see {@link GetInstanceCommandOutput} for command's `response` shape.
+ * @see {@link SupplyChainClientResolvedConfig | config} for SupplyChainClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have the required privileges to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input does not satisfy the constraints specified by an AWS service.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Request would cause a service quota to be exceeded.</p>
+ *
+ * @throws {@link SupplyChainServiceException}
+ * <p>Base exception class for all service exceptions from SupplyChain service.</p>
+ *
+ * @public
+ */
+export declare class GetInstanceCommand extends GetInstanceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetInstanceRequest;
+            output: GetInstanceResponse;
+        };
+        sdk: {
+            input: GetInstanceCommandInput;
+            output: GetInstanceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListInstancesCommand.d.ts

@@ -0,0 +1,113 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListInstancesRequest, ListInstancesResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListInstancesCommand}.
+ */
+export interface ListInstancesCommandInput extends ListInstancesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListInstancesCommand}.
+ */
+export interface ListInstancesCommandOutput extends ListInstancesResponse, __MetadataBearer {
+}
+declare const ListInstancesCommand_base: {
+    new (input: ListInstancesCommandInput): import("@smithy/smithy-client").CommandImpl<ListInstancesCommandInput, ListInstancesCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListInstancesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListInstancesCommandInput, ListInstancesCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>List all the AWS Supply Chain instances in a paginated way.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, ListInstancesCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, ListInstancesCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // ListInstancesRequest
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   instanceNameFilter: [ // InstanceNameList
+ *     "STRING_VALUE",
+ *   ],
+ *   instanceStateFilter: [ // InstanceStateList
+ *     "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted",
+ *   ],
+ * };
+ * const command = new ListInstancesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListInstancesResponse
+ * //   instances: [ // InstanceList // required
+ * //     { // Instance
+ * //       instanceId: "STRING_VALUE", // required
+ * //       awsAccountId: "STRING_VALUE", // required
+ * //       state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required
+ * //       webAppDnsDomain: "STRING_VALUE",
+ * //       createdTime: new Date("TIMESTAMP"),
+ * //       lastModifiedTime: new Date("TIMESTAMP"),
+ * //       instanceName: "STRING_VALUE",
+ * //       instanceDescription: "STRING_VALUE",
+ * //       kmsKeyArn: "STRING_VALUE",
+ * //       versionNumber: Number("double"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListInstancesCommandInput - {@link ListInstancesCommandInput}
+ * @returns {@link ListInstancesCommandOutput}
+ * @see {@link ListInstancesCommandInput} for command's `input` shape.
+ * @see {@link ListInstancesCommandOutput} for command's `response` shape.
+ * @see {@link SupplyChainClientResolvedConfig | config} for SupplyChainClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have the required privileges to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input does not satisfy the constraints specified by an AWS service.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which does not exist.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Request would cause a service quota to be exceeded.</p>
+ *
+ * @throws {@link SupplyChainServiceException}
+ * <p>Base exception class for all service exceptions from SupplyChain service.</p>
+ *
+ * @public
+ */
+export declare class ListInstancesCommand extends ListInstancesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListInstancesRequest;
+            output: ListInstancesResponse;
+        };
+        sdk: {
+            input: ListInstancesCommandInput;
+            output: ListInstancesCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateInstanceCommand.d.ts

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateInstanceRequest, UpdateInstanceResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateInstanceCommand}.
+ */
+export interface UpdateInstanceCommandInput extends UpdateInstanceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateInstanceCommand}.
+ */
+export interface UpdateInstanceCommandOutput extends UpdateInstanceResponse, __MetadataBearer {
+}
+declare const UpdateInstanceCommand_base: {
+    new (input: UpdateInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateInstanceCommandInput, UpdateInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateInstanceCommandInput, UpdateInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Update the instance.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, UpdateInstanceCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, UpdateInstanceCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // UpdateInstanceRequest
+ *   instanceId: "STRING_VALUE", // required
+ *   instanceName: "STRING_VALUE",
+ *   instanceDescription: "STRING_VALUE",
+ * };
+ * const command = new UpdateInstanceCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateInstanceResponse
+ * //   instance: { // Instance
+ * //     instanceId: "STRING_VALUE", // required
+ * //     awsAccountId: "STRING_VALUE", // required
+ * //     state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required
+ * //     webAppDnsDomain: "STRING_VALUE",
+ * //     createdTime: new Date("TIMESTAMP"),
+ * //     lastModifiedTime: new Date("TIMESTAMP"),
+ * //     instanceName: "STRING_VALUE",
+ * //     instanceDescription: "STRING_VALUE",
+ * //     kmsKeyArn: "STRING_VALUE",
+ * //     versionNumber: Number("double"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateInstanceCommandInput - {@link UpdateInstanceCommandInput}
+ * @returns {@link UpdateInstanceCommandOutput}
+ * @see {@link UpdateInstanceCommandInput} for command's `input` shape.
+ * @see {@link UpdateInstanceCommandOutput} for command's `response` shape.
+ * @see {@link SupplyChainClientResolvedConfig | config} for SupplyChainClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have the required privileges to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input does not satisfy the constraints specified by an AWS service.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Request would cause a service quota to be exceeded.</p>
+ *
+ * @throws {@link SupplyChainServiceException}
+ * <p>Base exception class for all service exceptions from SupplyChain service.</p>
+ *
+ * @public
+ */
+export declare class UpdateInstanceCommand extends UpdateInstanceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateInstanceRequest;
+            output: UpdateInstanceResponse;
+        };
+        sdk: {
+            input: UpdateInstanceCommandInput;
+            output: UpdateInstanceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,16 +1,21 @@
 export * from "./CreateBillOfMaterialsImportJobCommand";
 export * from "./CreateDataIntegrationFlowCommand";
 export * from "./CreateDataLakeDatasetCommand";
+export * from "./CreateInstanceCommand";
 export * from "./DeleteDataIntegrationFlowCommand";
 export * from "./DeleteDataLakeDatasetCommand";
+export * from "./DeleteInstanceCommand";
 export * from "./GetBillOfMaterialsImportJobCommand";
 export * from "./GetDataIntegrationFlowCommand";
 export * from "./GetDataLakeDatasetCommand";
+export * from "./GetInstanceCommand";
 export * from "./ListDataIntegrationFlowsCommand";
 export * from "./ListDataLakeDatasetsCommand";
+export * from "./ListInstancesCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./SendDataIntegrationEventCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateDataIntegrationFlowCommand";
 export * from "./UpdateDataLakeDatasetCommand";
+export * from "./UpdateInstanceCommand";