@aws-sdk/client-supplychain 3.670.0 → 3.672.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -7
- package/dist-cjs/index.js +264 -2
- package/dist-es/SupplyChain.js +10 -0
- package/dist-es/commands/CreateInstanceCommand.js +22 -0
- package/dist-es/commands/DeleteInstanceCommand.js +22 -0
- package/dist-es/commands/GetInstanceCommand.js +22 -0
- package/dist-es/commands/ListInstancesCommand.js +22 -0
- package/dist-es/commands/UpdateInstanceCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +8 -0
- package/dist-es/pagination/ListInstancesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +160 -1
- package/dist-types/SupplyChain.d.ts +37 -0
- package/dist-types/SupplyChainClient.d.ts +7 -2
- package/dist-types/commands/CreateInstanceCommand.d.ts +163 -0
- package/dist-types/commands/DeleteInstanceCommand.d.ts +129 -0
- package/dist-types/commands/GetInstanceCommand.d.ts +129 -0
- package/dist-types/commands/ListInstancesCommand.d.ts +239 -0
- package/dist-types/commands/UpdateInstanceCommand.d.ts +133 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +232 -0
- package/dist-types/pagination/ListInstancesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/ts3.4/SupplyChain.d.ts +87 -0
- package/dist-types/ts3.4/SupplyChainClient.d.ts +32 -2
- package/dist-types/ts3.4/commands/CreateInstanceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteInstanceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetInstanceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListInstancesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateInstanceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +61 -0
- package/dist-types/ts3.4/pagination/ListInstancesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/package.json +1 -1
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CreateInstanceRequest, CreateInstanceResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateInstanceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateInstanceCommandInput extends CreateInstanceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateInstanceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateInstanceCommandOutput extends CreateInstanceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateInstanceCommand_base: {
|
|
25
|
+
new (input: CreateInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<CreateInstanceCommandInput, CreateInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [CreateInstanceCommandInput]): import("@smithy/smithy-client").CommandImpl<CreateInstanceCommandInput, CreateInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Create a new instance for AWS Supply Chain. This is an asynchronous operation. Upon receiving a CreateInstance request, AWS Supply Chain immediately returns the instance resource, with instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { SupplyChainClient, CreateInstanceCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
|
|
35
|
+
* // const { SupplyChainClient, CreateInstanceCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
|
|
36
|
+
* const client = new SupplyChainClient(config);
|
|
37
|
+
* const input = { // CreateInstanceRequest
|
|
38
|
+
* instanceName: "STRING_VALUE",
|
|
39
|
+
* instanceDescription: "STRING_VALUE",
|
|
40
|
+
* kmsKeyArn: "STRING_VALUE",
|
|
41
|
+
* tags: { // TagMap
|
|
42
|
+
* "<keys>": "STRING_VALUE",
|
|
43
|
+
* },
|
|
44
|
+
* clientToken: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new CreateInstanceCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // CreateInstanceResponse
|
|
49
|
+
* // instance: { // Instance
|
|
50
|
+
* // instanceId: "STRING_VALUE", // required
|
|
51
|
+
* // awsAccountId: "STRING_VALUE", // required
|
|
52
|
+
* // state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required
|
|
53
|
+
* // webAppDnsDomain: "STRING_VALUE",
|
|
54
|
+
* // createdTime: new Date("TIMESTAMP"),
|
|
55
|
+
* // lastModifiedTime: new Date("TIMESTAMP"),
|
|
56
|
+
* // instanceName: "STRING_VALUE",
|
|
57
|
+
* // instanceDescription: "STRING_VALUE",
|
|
58
|
+
* // kmsKeyArn: "STRING_VALUE",
|
|
59
|
+
* // versionNumber: Number("double"),
|
|
60
|
+
* // },
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param CreateInstanceCommandInput - {@link CreateInstanceCommandInput}
|
|
66
|
+
* @returns {@link CreateInstanceCommandOutput}
|
|
67
|
+
* @see {@link CreateInstanceCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link CreateInstanceCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link SupplyChainClientResolvedConfig | config} for SupplyChainClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
72
|
+
* <p>You do not have the required privileges to perform this action.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ConflictException} (client fault)
|
|
75
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalServerException} (server fault)
|
|
78
|
+
* <p>Unexpected error during processing of request.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
81
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
84
|
+
* <p>Request was denied due to request throttling.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ValidationException} (client fault)
|
|
87
|
+
* <p>The input does not satisfy the constraints specified by an AWS service.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
90
|
+
* <p>Request references a resource which does not exist.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link SupplyChainServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from SupplyChain service.</p>
|
|
94
|
+
*
|
|
95
|
+
* @public
|
|
96
|
+
* @example Successful CreateInstance request with all input data
|
|
97
|
+
* ```javascript
|
|
98
|
+
* //
|
|
99
|
+
* const input = {
|
|
100
|
+
* "instanceDescription": "example instance description",
|
|
101
|
+
* "instanceName": "example instance name",
|
|
102
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
|
|
103
|
+
* "tags": {
|
|
104
|
+
* "tagKey1": "tagValue1"
|
|
105
|
+
* }
|
|
106
|
+
* };
|
|
107
|
+
* const command = new CreateInstanceCommand(input);
|
|
108
|
+
* const response = await client.send(command);
|
|
109
|
+
* /* response ==
|
|
110
|
+
* {
|
|
111
|
+
* "instance": {
|
|
112
|
+
* "awsAccountId": "123456789012",
|
|
113
|
+
* "createdTime": 172615383136,
|
|
114
|
+
* "instanceDescription": "example instance description",
|
|
115
|
+
* "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
|
|
116
|
+
* "instanceName": "example instance name",
|
|
117
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
|
|
118
|
+
* "lastModifiedTime": 172615383136,
|
|
119
|
+
* "state": "Initializing",
|
|
120
|
+
* "versionNumber": 2
|
|
121
|
+
* }
|
|
122
|
+
* }
|
|
123
|
+
* *\/
|
|
124
|
+
* // example id: example-1
|
|
125
|
+
* ```
|
|
126
|
+
*
|
|
127
|
+
* @example Successful CreateInstance request with no input data
|
|
128
|
+
* ```javascript
|
|
129
|
+
* //
|
|
130
|
+
* const input = {};
|
|
131
|
+
* const command = new CreateInstanceCommand(input);
|
|
132
|
+
* const response = await client.send(command);
|
|
133
|
+
* /* response ==
|
|
134
|
+
* {
|
|
135
|
+
* "instance": {
|
|
136
|
+
* "awsAccountId": "123456789012",
|
|
137
|
+
* "createdTime": 172615383136,
|
|
138
|
+
* "instanceDescription": "",
|
|
139
|
+
* "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
|
|
140
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:456789012345:key/7372eb6d-874c-4212-8d49-7804282d33a8",
|
|
141
|
+
* "lastModifiedTime": 172615383136,
|
|
142
|
+
* "state": "Initializing",
|
|
143
|
+
* "versionNumber": 2
|
|
144
|
+
* }
|
|
145
|
+
* }
|
|
146
|
+
* *\/
|
|
147
|
+
* // example id: example-2
|
|
148
|
+
* ```
|
|
149
|
+
*
|
|
150
|
+
*/
|
|
151
|
+
export declare class CreateInstanceCommand extends CreateInstanceCommand_base {
|
|
152
|
+
/** @internal type navigation helper, not in runtime. */
|
|
153
|
+
protected static __types: {
|
|
154
|
+
api: {
|
|
155
|
+
input: CreateInstanceRequest;
|
|
156
|
+
output: CreateInstanceResponse;
|
|
157
|
+
};
|
|
158
|
+
sdk: {
|
|
159
|
+
input: CreateInstanceCommandInput;
|
|
160
|
+
output: CreateInstanceCommandOutput;
|
|
161
|
+
};
|
|
162
|
+
};
|
|
163
|
+
}
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteInstanceRequest, DeleteInstanceResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteInstanceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteInstanceCommandInput extends DeleteInstanceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteInstanceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteInstanceCommandOutput extends DeleteInstanceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteInstanceCommand_base: {
|
|
25
|
+
new (input: DeleteInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteInstanceCommandInput, DeleteInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteInstanceCommandInput, DeleteInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <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>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { SupplyChainClient, DeleteInstanceCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
|
|
35
|
+
* // const { SupplyChainClient, DeleteInstanceCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
|
|
36
|
+
* const client = new SupplyChainClient(config);
|
|
37
|
+
* const input = { // DeleteInstanceRequest
|
|
38
|
+
* instanceId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteInstanceCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DeleteInstanceResponse
|
|
43
|
+
* // instance: { // Instance
|
|
44
|
+
* // instanceId: "STRING_VALUE", // required
|
|
45
|
+
* // awsAccountId: "STRING_VALUE", // required
|
|
46
|
+
* // state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required
|
|
47
|
+
* // webAppDnsDomain: "STRING_VALUE",
|
|
48
|
+
* // createdTime: new Date("TIMESTAMP"),
|
|
49
|
+
* // lastModifiedTime: new Date("TIMESTAMP"),
|
|
50
|
+
* // instanceName: "STRING_VALUE",
|
|
51
|
+
* // instanceDescription: "STRING_VALUE",
|
|
52
|
+
* // kmsKeyArn: "STRING_VALUE",
|
|
53
|
+
* // versionNumber: Number("double"),
|
|
54
|
+
* // },
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param DeleteInstanceCommandInput - {@link DeleteInstanceCommandInput}
|
|
60
|
+
* @returns {@link DeleteInstanceCommandOutput}
|
|
61
|
+
* @see {@link DeleteInstanceCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link DeleteInstanceCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link SupplyChainClientResolvedConfig | config} for SupplyChainClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
+
* <p>You do not have the required privileges to perform this action.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p>Unexpected error during processing of request.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>Request references a resource which does not exist.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>Request was denied due to request throttling.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* <p>The input does not satisfy the constraints specified by an AWS service.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ConflictException} (client fault)
|
|
81
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
84
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link SupplyChainServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from SupplyChain service.</p>
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
* @example Successful DeleteInstance request
|
|
91
|
+
* ```javascript
|
|
92
|
+
* //
|
|
93
|
+
* const input = {
|
|
94
|
+
* "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793"
|
|
95
|
+
* };
|
|
96
|
+
* const command = new DeleteInstanceCommand(input);
|
|
97
|
+
* const response = await client.send(command);
|
|
98
|
+
* /* response ==
|
|
99
|
+
* {
|
|
100
|
+
* "instance": {
|
|
101
|
+
* "awsAccountId": "123456789012",
|
|
102
|
+
* "createdTime": 172615383136,
|
|
103
|
+
* "instanceDescription": "updated example instance description",
|
|
104
|
+
* "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
|
|
105
|
+
* "instanceName": "updated example instance name",
|
|
106
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
|
|
107
|
+
* "lastModifiedTime": 172615383136,
|
|
108
|
+
* "state": "Deleting",
|
|
109
|
+
* "versionNumber": 2
|
|
110
|
+
* }
|
|
111
|
+
* }
|
|
112
|
+
* *\/
|
|
113
|
+
* // example id: example-1
|
|
114
|
+
* ```
|
|
115
|
+
*
|
|
116
|
+
*/
|
|
117
|
+
export declare class DeleteInstanceCommand extends DeleteInstanceCommand_base {
|
|
118
|
+
/** @internal type navigation helper, not in runtime. */
|
|
119
|
+
protected static __types: {
|
|
120
|
+
api: {
|
|
121
|
+
input: DeleteInstanceRequest;
|
|
122
|
+
output: DeleteInstanceResponse;
|
|
123
|
+
};
|
|
124
|
+
sdk: {
|
|
125
|
+
input: DeleteInstanceCommandInput;
|
|
126
|
+
output: DeleteInstanceCommandOutput;
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
}
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetInstanceRequest, GetInstanceResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetInstanceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetInstanceCommandInput extends GetInstanceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetInstanceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetInstanceCommandOutput extends GetInstanceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetInstanceCommand_base: {
|
|
25
|
+
new (input: GetInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<GetInstanceCommandInput, GetInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<GetInstanceCommandInput, GetInstanceCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Get the AWS Supply Chain instance details.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { SupplyChainClient, GetInstanceCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
|
|
35
|
+
* // const { SupplyChainClient, GetInstanceCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
|
|
36
|
+
* const client = new SupplyChainClient(config);
|
|
37
|
+
* const input = { // GetInstanceRequest
|
|
38
|
+
* instanceId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetInstanceCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetInstanceResponse
|
|
43
|
+
* // instance: { // Instance
|
|
44
|
+
* // instanceId: "STRING_VALUE", // required
|
|
45
|
+
* // awsAccountId: "STRING_VALUE", // required
|
|
46
|
+
* // state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required
|
|
47
|
+
* // webAppDnsDomain: "STRING_VALUE",
|
|
48
|
+
* // createdTime: new Date("TIMESTAMP"),
|
|
49
|
+
* // lastModifiedTime: new Date("TIMESTAMP"),
|
|
50
|
+
* // instanceName: "STRING_VALUE",
|
|
51
|
+
* // instanceDescription: "STRING_VALUE",
|
|
52
|
+
* // kmsKeyArn: "STRING_VALUE",
|
|
53
|
+
* // versionNumber: Number("double"),
|
|
54
|
+
* // },
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param GetInstanceCommandInput - {@link GetInstanceCommandInput}
|
|
60
|
+
* @returns {@link GetInstanceCommandOutput}
|
|
61
|
+
* @see {@link GetInstanceCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link GetInstanceCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link SupplyChainClientResolvedConfig | config} for SupplyChainClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
+
* <p>You do not have the required privileges to perform this action.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p>Unexpected error during processing of request.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>Request references a resource which does not exist.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>Request was denied due to request throttling.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* <p>The input does not satisfy the constraints specified by an AWS service.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ConflictException} (client fault)
|
|
81
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
84
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link SupplyChainServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from SupplyChain service.</p>
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
* @example Successful GetInstance request
|
|
91
|
+
* ```javascript
|
|
92
|
+
* //
|
|
93
|
+
* const input = {
|
|
94
|
+
* "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793"
|
|
95
|
+
* };
|
|
96
|
+
* const command = new GetInstanceCommand(input);
|
|
97
|
+
* const response = await client.send(command);
|
|
98
|
+
* /* response ==
|
|
99
|
+
* {
|
|
100
|
+
* "instance": {
|
|
101
|
+
* "awsAccountId": "123456789012",
|
|
102
|
+
* "createdTime": 172615383136,
|
|
103
|
+
* "instanceDescription": "example instance description",
|
|
104
|
+
* "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
|
|
105
|
+
* "instanceName": "example instance name",
|
|
106
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
|
|
107
|
+
* "lastModifiedTime": 172615383136,
|
|
108
|
+
* "state": "Active",
|
|
109
|
+
* "versionNumber": 2
|
|
110
|
+
* }
|
|
111
|
+
* }
|
|
112
|
+
* *\/
|
|
113
|
+
* // example id: example-1
|
|
114
|
+
* ```
|
|
115
|
+
*
|
|
116
|
+
*/
|
|
117
|
+
export declare class GetInstanceCommand extends GetInstanceCommand_base {
|
|
118
|
+
/** @internal type navigation helper, not in runtime. */
|
|
119
|
+
protected static __types: {
|
|
120
|
+
api: {
|
|
121
|
+
input: GetInstanceRequest;
|
|
122
|
+
output: GetInstanceResponse;
|
|
123
|
+
};
|
|
124
|
+
sdk: {
|
|
125
|
+
input: GetInstanceCommandInput;
|
|
126
|
+
output: GetInstanceCommandOutput;
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
}
|
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListInstancesRequest, ListInstancesResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListInstancesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListInstancesCommandInput extends ListInstancesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListInstancesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListInstancesCommandOutput extends ListInstancesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListInstancesCommand_base: {
|
|
25
|
+
new (input: ListInstancesCommandInput): import("@smithy/smithy-client").CommandImpl<ListInstancesCommandInput, ListInstancesCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListInstancesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListInstancesCommandInput, ListInstancesCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>List all the AWS Supply Chain instances in a paginated way.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { SupplyChainClient, ListInstancesCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
|
|
35
|
+
* // const { SupplyChainClient, ListInstancesCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
|
|
36
|
+
* const client = new SupplyChainClient(config);
|
|
37
|
+
* const input = { // ListInstancesRequest
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* instanceNameFilter: [ // InstanceNameList
|
|
41
|
+
* "STRING_VALUE",
|
|
42
|
+
* ],
|
|
43
|
+
* instanceStateFilter: [ // InstanceStateList
|
|
44
|
+
* "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted",
|
|
45
|
+
* ],
|
|
46
|
+
* };
|
|
47
|
+
* const command = new ListInstancesCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // ListInstancesResponse
|
|
50
|
+
* // instances: [ // InstanceList // required
|
|
51
|
+
* // { // Instance
|
|
52
|
+
* // instanceId: "STRING_VALUE", // required
|
|
53
|
+
* // awsAccountId: "STRING_VALUE", // required
|
|
54
|
+
* // state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required
|
|
55
|
+
* // webAppDnsDomain: "STRING_VALUE",
|
|
56
|
+
* // createdTime: new Date("TIMESTAMP"),
|
|
57
|
+
* // lastModifiedTime: new Date("TIMESTAMP"),
|
|
58
|
+
* // instanceName: "STRING_VALUE",
|
|
59
|
+
* // instanceDescription: "STRING_VALUE",
|
|
60
|
+
* // kmsKeyArn: "STRING_VALUE",
|
|
61
|
+
* // versionNumber: Number("double"),
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // nextToken: "STRING_VALUE",
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
69
|
+
* @param ListInstancesCommandInput - {@link ListInstancesCommandInput}
|
|
70
|
+
* @returns {@link ListInstancesCommandOutput}
|
|
71
|
+
* @see {@link ListInstancesCommandInput} for command's `input` shape.
|
|
72
|
+
* @see {@link ListInstancesCommandOutput} for command's `response` shape.
|
|
73
|
+
* @see {@link SupplyChainClientResolvedConfig | config} for SupplyChainClient's `config` shape.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
+
* <p>You do not have the required privileges to perform this action.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InternalServerException} (server fault)
|
|
79
|
+
* <p>Unexpected error during processing of request.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
+
* <p>Request was denied due to request throttling.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationException} (client fault)
|
|
85
|
+
* <p>The input does not satisfy the constraints specified by an AWS service.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ConflictException} (client fault)
|
|
88
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
91
|
+
* <p>Request references a resource which does not exist.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
94
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link SupplyChainServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from SupplyChain service.</p>
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
* @example Successful ListInstance request with no input data
|
|
101
|
+
* ```javascript
|
|
102
|
+
* //
|
|
103
|
+
* const input = {};
|
|
104
|
+
* const command = new ListInstancesCommand(input);
|
|
105
|
+
* const response = await client.send(command);
|
|
106
|
+
* /* response ==
|
|
107
|
+
* {
|
|
108
|
+
* "instances": [
|
|
109
|
+
* {
|
|
110
|
+
* "awsAccountId": "123456789012",
|
|
111
|
+
* "createdTime": 172615383136,
|
|
112
|
+
* "instanceDescription": "example instance description",
|
|
113
|
+
* "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
|
|
114
|
+
* "instanceName": "example instance name",
|
|
115
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
|
|
116
|
+
* "lastModifiedTime": 172615383136,
|
|
117
|
+
* "state": "Active",
|
|
118
|
+
* "versionNumber": 2
|
|
119
|
+
* },
|
|
120
|
+
* {
|
|
121
|
+
* "awsAccountId": "123456789012",
|
|
122
|
+
* "createdTime": 17261674383136,
|
|
123
|
+
* "instanceDescription": "example instance description",
|
|
124
|
+
* "instanceId": "3ad8116a-644d-4172-8dcb-20e51d314c14",
|
|
125
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
|
|
126
|
+
* "lastModifiedTime": 17261674383136,
|
|
127
|
+
* "state": "Initializing",
|
|
128
|
+
* "versionNumber": 2
|
|
129
|
+
* }
|
|
130
|
+
* ]
|
|
131
|
+
* }
|
|
132
|
+
* *\/
|
|
133
|
+
* // example id: example-1
|
|
134
|
+
* ```
|
|
135
|
+
*
|
|
136
|
+
* @example Successful ListInstance request with filters
|
|
137
|
+
* ```javascript
|
|
138
|
+
* //
|
|
139
|
+
* const input = {
|
|
140
|
+
* "instanceNameFilter": [
|
|
141
|
+
* "example instance name"
|
|
142
|
+
* ],
|
|
143
|
+
* "instanceStateFilter": [
|
|
144
|
+
* "Active"
|
|
145
|
+
* ]
|
|
146
|
+
* };
|
|
147
|
+
* const command = new ListInstancesCommand(input);
|
|
148
|
+
* const response = await client.send(command);
|
|
149
|
+
* /* response ==
|
|
150
|
+
* {
|
|
151
|
+
* "instances": [
|
|
152
|
+
* {
|
|
153
|
+
* "awsAccountId": "123456789012",
|
|
154
|
+
* "createdTime": 172615383136,
|
|
155
|
+
* "instanceDescription": "example instance description",
|
|
156
|
+
* "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
|
|
157
|
+
* "instanceName": "example instance name",
|
|
158
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
|
|
159
|
+
* "lastModifiedTime": 172615383136,
|
|
160
|
+
* "state": "Active",
|
|
161
|
+
* "versionNumber": 2
|
|
162
|
+
* }
|
|
163
|
+
* ]
|
|
164
|
+
* }
|
|
165
|
+
* *\/
|
|
166
|
+
* // example id: example-2
|
|
167
|
+
* ```
|
|
168
|
+
*
|
|
169
|
+
* @example Successful ListInstance request with maxResult override
|
|
170
|
+
* ```javascript
|
|
171
|
+
* //
|
|
172
|
+
* const input = {
|
|
173
|
+
* "maxResults": 1
|
|
174
|
+
* };
|
|
175
|
+
* const command = new ListInstancesCommand(input);
|
|
176
|
+
* const response = await client.send(command);
|
|
177
|
+
* /* response ==
|
|
178
|
+
* {
|
|
179
|
+
* "instances": [
|
|
180
|
+
* {
|
|
181
|
+
* "awsAccountId": "123456789012",
|
|
182
|
+
* "createdTime": 172615383136,
|
|
183
|
+
* "instanceDescription": "example instance description",
|
|
184
|
+
* "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
|
|
185
|
+
* "instanceName": "example instance name",
|
|
186
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
|
|
187
|
+
* "lastModifiedTime": 172615383136,
|
|
188
|
+
* "state": "Active",
|
|
189
|
+
* "versionNumber": 2
|
|
190
|
+
* }
|
|
191
|
+
* ],
|
|
192
|
+
* "nextToken": "AAQA-EFRSURBSGhtcng0c0dxbENwUHdnckVIbkFYNU1QVjRTZWN2ak5iMFVicC8zemlHOVF3SEpjSC9WTWJVVXBMV2Z1N3ZvZlQ0WEFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTTJibW9LemgrSWZTY0RaZEdBZ0VRZ0R2dDhsQnVGbGJ0dnFTZityWmNSWEVPbG93emJoSjhxOGNMbGQ1UGMvY0VRbWlTR3pQUFd4N2RraXY5Y0ovcS9vSmFYZVBGdWVHaU0zWmd0dz09n-rC1ejA5--7ltJxpDT2xP_i8xGqDPMOZfjpp8q6l5NuP9_bnBURvwwYhdqDriMK5_f96LuPEnPbuML-ItfgEiCcUy0p2tApvpZkZqOG5fbqP-4C5aDYPTffHLyq-MMqvfrGVJzL1nvkpZcnTkVR9VJsu5b8I0qqDW0H8EMKGgTo78U9lr4sj3Usi9VMwZxgKCBmr03HhFLYXOW--XMbIx0CTZF0fYIcRxmA_sVS6J7gpaB9yMcnzs5VUKokoA5JTcAPY5d1Y1VyE8KKxv51cfPgXw8OYCDbFQncw8mZPmE-VqxjFbksmk_FmghpPn9j2Ppoe-zr0LQ%3D"
|
|
193
|
+
* }
|
|
194
|
+
* *\/
|
|
195
|
+
* // example id: example-3
|
|
196
|
+
* ```
|
|
197
|
+
*
|
|
198
|
+
* @example Successful ListInstance request with nextToken
|
|
199
|
+
* ```javascript
|
|
200
|
+
* //
|
|
201
|
+
* const input = {
|
|
202
|
+
* "maxResults": 1,
|
|
203
|
+
* "nextToken": "AAQA-EFRSURBSGhtcng0c0dxbENwUHdnckVIbkFYNU1QVjRTZWN2ak5iMFVicC8zemlHOVF3SEpjSC9WTWJVVXBMV2Z1N3ZvZlQ0WEFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTTJibW9LemgrSWZTY0RaZEdBZ0VRZ0R2dDhsQnVGbGJ0dnFTZityWmNSWEVPbG93emJoSjhxOGNMbGQ1UGMvY0VRbWlTR3pQUFd4N2RraXY5Y0ovcS9vSmFYZVBGdWVHaU0zWmd0dz09n-rC1ejA5--7ltJxpDT2xP_i8xGqDPMOZfjpp8q6l5NuP9_bnBURvwwYhdqDriMK5_f96LuPEnPbuML-ItfgEiCcUy0p2tApvpZkZqOG5fbqP-4C5aDYPTffHLyq-MMqvfrGVJzL1nvkpZcnTkVR9VJsu5b8I0qqDW0H8EMKGgTo78U9lr4sj3Usi9VMwZxgKCBmr03HhFLYXOW--XMbIx0CTZF0fYIcRxmA_sVS6J7gpaB9yMcnzs5VUKokoA5JTcAPY5d1Y1VyE8KKxv51cfPgXw8OYCDbFQncw8mZPmE-VqxjFbksmk_FmghpPn9j2Ppoe-zr0LQ%3D"
|
|
204
|
+
* };
|
|
205
|
+
* const command = new ListInstancesCommand(input);
|
|
206
|
+
* const response = await client.send(command);
|
|
207
|
+
* /* response ==
|
|
208
|
+
* {
|
|
209
|
+
* "instances": [
|
|
210
|
+
* {
|
|
211
|
+
* "awsAccountId": "123456789012",
|
|
212
|
+
* "createdTime": 17261674383136,
|
|
213
|
+
* "instanceDescription": "example instance description",
|
|
214
|
+
* "instanceId": "3ad8116a-644d-4172-8dcb-20e51d314c14",
|
|
215
|
+
* "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
|
|
216
|
+
* "lastModifiedTime": 17261674383136,
|
|
217
|
+
* "state": "Initializing",
|
|
218
|
+
* "versionNumber": 2
|
|
219
|
+
* }
|
|
220
|
+
* ]
|
|
221
|
+
* }
|
|
222
|
+
* *\/
|
|
223
|
+
* // example id: example-4
|
|
224
|
+
* ```
|
|
225
|
+
*
|
|
226
|
+
*/
|
|
227
|
+
export declare class ListInstancesCommand extends ListInstancesCommand_base {
|
|
228
|
+
/** @internal type navigation helper, not in runtime. */
|
|
229
|
+
protected static __types: {
|
|
230
|
+
api: {
|
|
231
|
+
input: ListInstancesRequest;
|
|
232
|
+
output: ListInstancesResponse;
|
|
233
|
+
};
|
|
234
|
+
sdk: {
|
|
235
|
+
input: ListInstancesCommandInput;
|
|
236
|
+
output: ListInstancesCommandOutput;
|
|
237
|
+
};
|
|
238
|
+
};
|
|
239
|
+
}
|