@aws-sdk/client-deadline 3.1055.0 → 3.1057.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.
Files changed (49) hide show
  1. package/README.md +21 -0
  2. package/dist-cjs/index.js +58 -0
  3. package/dist-cjs/schemas/schemas_0.js +88 -11
  4. package/dist-es/Deadline.js +8 -0
  5. package/dist-es/commands/DeleteVolumeCommand.js +16 -0
  6. package/dist-es/commands/GetVolumeCommand.js +16 -0
  7. package/dist-es/commands/ListVolumesCommand.js +16 -0
  8. package/dist-es/commands/index.js +3 -0
  9. package/dist-es/models/enums.js +10 -0
  10. package/dist-es/pagination/ListVolumesPaginator.js +4 -0
  11. package/dist-es/pagination/index.js +1 -0
  12. package/dist-es/schemas/schemas_0.js +78 -2
  13. package/dist-types/Deadline.d.ts +28 -0
  14. package/dist-types/DeadlineClient.d.ts +5 -2
  15. package/dist-types/commands/CreateFleetCommand.d.ts +7 -0
  16. package/dist-types/commands/DeleteVolumeCommand.d.ts +109 -0
  17. package/dist-types/commands/GetFleetCommand.d.ts +7 -0
  18. package/dist-types/commands/GetVolumeCommand.d.ts +121 -0
  19. package/dist-types/commands/ListFleetsCommand.d.ts +7 -0
  20. package/dist-types/commands/ListStepConsumersCommand.d.ts +2 -1
  21. package/dist-types/commands/ListStepDependenciesCommand.d.ts +1 -1
  22. package/dist-types/commands/ListStepsCommand.d.ts +1 -1
  23. package/dist-types/commands/ListTasksCommand.d.ts +1 -2
  24. package/dist-types/commands/ListVolumesCommand.d.ts +119 -0
  25. package/dist-types/commands/UpdateFleetCommand.d.ts +7 -0
  26. package/dist-types/commands/index.d.ts +3 -0
  27. package/dist-types/models/enums.d.ts +26 -3
  28. package/dist-types/models/models_0.d.ts +243 -249
  29. package/dist-types/models/models_1.d.ts +251 -4
  30. package/dist-types/pagination/ListVolumesPaginator.d.ts +7 -0
  31. package/dist-types/pagination/index.d.ts +1 -0
  32. package/dist-types/schemas/schemas_0.d.ts +11 -0
  33. package/dist-types/ts3.4/Deadline.d.ts +58 -0
  34. package/dist-types/ts3.4/DeadlineClient.d.ts +18 -0
  35. package/dist-types/ts3.4/commands/DeleteVolumeCommand.d.ts +49 -0
  36. package/dist-types/ts3.4/commands/GetVolumeCommand.d.ts +45 -0
  37. package/dist-types/ts3.4/commands/ListStepConsumersCommand.d.ts +2 -4
  38. package/dist-types/ts3.4/commands/ListStepDependenciesCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/ListStepsCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/ListTasksCommand.d.ts +1 -2
  41. package/dist-types/ts3.4/commands/ListVolumesCommand.d.ts +49 -0
  42. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  43. package/dist-types/ts3.4/models/enums.d.ts +12 -0
  44. package/dist-types/ts3.4/models/models_0.d.ts +56 -56
  45. package/dist-types/ts3.4/models/models_1.d.ts +59 -0
  46. package/dist-types/ts3.4/pagination/ListVolumesPaginator.d.ts +11 -0
  47. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  48. package/dist-types/ts3.4/schemas/schemas_0.d.ts +11 -0
  49. package/package.json +6 -6
@@ -0,0 +1,121 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DeadlineClient";
4
+ import type { GetVolumeRequest, GetVolumeResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetVolumeCommand}.
14
+ */
15
+ export interface GetVolumeCommandInput extends GetVolumeRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetVolumeCommand}.
21
+ */
22
+ export interface GetVolumeCommandOutput extends GetVolumeResponse, __MetadataBearer {
23
+ }
24
+ declare const GetVolumeCommand_base: {
25
+ new (input: GetVolumeCommandInput): import("@smithy/core/client").CommandImpl<GetVolumeCommandInput, GetVolumeCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetVolumeCommandInput): import("@smithy/core/client").CommandImpl<GetVolumeCommandInput, GetVolumeCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): {
28
+ [x: string]: unknown;
29
+ };
30
+ };
31
+ /**
32
+ * <p>Gets a persistent volume.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { DeadlineClient, GetVolumeCommand } from "@aws-sdk/client-deadline"; // ES Modules import
37
+ * // const { DeadlineClient, GetVolumeCommand } = require("@aws-sdk/client-deadline"); // CommonJS import
38
+ * // import type { DeadlineClientConfig } from "@aws-sdk/client-deadline";
39
+ * const config = {}; // type is DeadlineClientConfig
40
+ * const client = new DeadlineClient(config);
41
+ * const input = { // GetVolumeRequest
42
+ * farmId: "STRING_VALUE", // required
43
+ * fleetId: "STRING_VALUE", // required
44
+ * volumeId: "STRING_VALUE", // required
45
+ * };
46
+ * const command = new GetVolumeCommand(input);
47
+ * const response = await client.send(command);
48
+ * // { // GetVolumeResponse
49
+ * // volumeId: "STRING_VALUE", // required
50
+ * // farmId: "STRING_VALUE", // required
51
+ * // fleetId: "STRING_VALUE", // required
52
+ * // state: "PENDING_CREATION" || "PENDING_ATTACHMENT" || "IN_USE" || "AVAILABLE" || "PENDING_DELETION", // required
53
+ * // sizeGiB: Number("int"), // required
54
+ * // availabilityZoneId: "STRING_VALUE", // required
55
+ * // attachedWorkerId: "STRING_VALUE",
56
+ * // volumeType: "gp3", // required
57
+ * // iops: Number("int"),
58
+ * // throughputMiB: Number("int"),
59
+ * // createdAt: new Date("TIMESTAMP"), // required
60
+ * // lastAssignedAt: new Date("TIMESTAMP"),
61
+ * // lastReleasedAt: new Date("TIMESTAMP"),
62
+ * // expiresAt: new Date("TIMESTAMP"),
63
+ * // };
64
+ *
65
+ * ```
66
+ *
67
+ * @param GetVolumeCommandInput - {@link GetVolumeCommandInput}
68
+ * @returns {@link GetVolumeCommandOutput}
69
+ * @see {@link GetVolumeCommandInput} for command's `input` shape.
70
+ * @see {@link GetVolumeCommandOutput} for command's `response` shape.
71
+ * @see {@link DeadlineClientResolvedConfig | config} for DeadlineClient's `config` shape.
72
+ *
73
+ * @throws {@link AccessDeniedException} (client fault)
74
+ * <p>You don't have permission to perform the action.</p>
75
+ *
76
+ * @throws {@link InternalServerErrorException} (server fault)
77
+ * <p>Deadline Cloud can't process your request right now. Try again later.</p>
78
+ *
79
+ * @throws {@link ResourceNotFoundException} (client fault)
80
+ * <p>The requested resource can't be found.</p>
81
+ *
82
+ * @throws {@link ThrottlingException} (client fault)
83
+ * <p>Your request exceeded a request rate quota.</p>
84
+ *
85
+ * @throws {@link ValidationException} (client fault)
86
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
87
+ *
88
+ * @throws {@link DeadlineServiceException}
89
+ * <p>Base exception class for all service exceptions from Deadline service.</p>
90
+ *
91
+ *
92
+ * @example Get a volume
93
+ * ```javascript
94
+ * //
95
+ * const input = {
96
+ * farmId: "farm-1234567890abcdef1234567890abcdef",
97
+ * fleetId: "fleet-1234567890abcdef1234567890abcdef",
98
+ * volumeId: "volume-1234567890abcdef1234567890abcdef"
99
+ * };
100
+ * const command = new GetVolumeCommand(input);
101
+ * const response = await client.send(command);
102
+ * /* response is
103
+ * { /* metadata only *\/ }
104
+ * *\/
105
+ * ```
106
+ *
107
+ * @public
108
+ */
109
+ export declare class GetVolumeCommand extends GetVolumeCommand_base {
110
+ /** @internal type navigation helper, not in runtime. */
111
+ protected static __types: {
112
+ api: {
113
+ input: GetVolumeRequest;
114
+ output: GetVolumeResponse;
115
+ };
116
+ sdk: {
117
+ input: GetVolumeCommandInput;
118
+ output: GetVolumeCommandOutput;
119
+ };
120
+ };
121
+ }
@@ -170,6 +170,13 @@ declare const ListFleetsCommand_base: {
170
170
  * // ],
171
171
  * // },
172
172
  * // storageProfileId: "STRING_VALUE",
173
+ * // persistentVolumeConfiguration: { // PersistentVolumeConfiguration
174
+ * // sizeGiB: Number("int"),
175
+ * // iops: Number("int"),
176
+ * // throughputMiB: Number("int"),
177
+ * // mountPath: "STRING_VALUE", // required
178
+ * // lastUsedTtlHours: Number("int"),
179
+ * // },
173
180
  * // autoScalingConfiguration: { // ServiceManagedEc2AutoScalingConfiguration
174
181
  * // standbyWorkerCount: Number("int"),
175
182
  * // workerIdleDurationSeconds: Number("int"),
@@ -1,7 +1,8 @@
1
1
  import { Command as $Command } from "@smithy/core/client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import type { DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DeadlineClient";
4
- import type { ListStepConsumersRequest, ListStepConsumersResponse } from "../models/models_0";
4
+ import type { ListStepConsumersRequest } from "../models/models_0";
5
+ import type { ListStepConsumersResponse } from "../models/models_1";
5
6
  /**
6
7
  * @public
7
8
  */
@@ -1,7 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/core/client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import type { DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DeadlineClient";
4
- import type { ListStepDependenciesRequest, ListStepDependenciesResponse } from "../models/models_0";
4
+ import type { ListStepDependenciesRequest, ListStepDependenciesResponse } from "../models/models_1";
5
5
  /**
6
6
  * @public
7
7
  */
@@ -1,7 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/core/client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import type { DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DeadlineClient";
4
- import type { ListStepsRequest, ListStepsResponse } from "../models/models_0";
4
+ import type { ListStepsRequest, ListStepsResponse } from "../models/models_1";
5
5
  /**
6
6
  * @public
7
7
  */
@@ -1,8 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/core/client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import type { DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DeadlineClient";
4
- import type { ListTasksRequest } from "../models/models_0";
5
- import type { ListTasksResponse } from "../models/models_1";
4
+ import type { ListTasksRequest, ListTasksResponse } from "../models/models_1";
6
5
  /**
7
6
  * @public
8
7
  */
@@ -0,0 +1,119 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DeadlineClient";
4
+ import type { ListVolumesRequest, ListVolumesResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListVolumesCommand}.
14
+ */
15
+ export interface ListVolumesCommandInput extends ListVolumesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListVolumesCommand}.
21
+ */
22
+ export interface ListVolumesCommandOutput extends ListVolumesResponse, __MetadataBearer {
23
+ }
24
+ declare const ListVolumesCommand_base: {
25
+ new (input: ListVolumesCommandInput): import("@smithy/core/client").CommandImpl<ListVolumesCommandInput, ListVolumesCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListVolumesCommandInput): import("@smithy/core/client").CommandImpl<ListVolumesCommandInput, ListVolumesCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): {
28
+ [x: string]: unknown;
29
+ };
30
+ };
31
+ /**
32
+ * <p>Lists the persistent volumes in a fleet.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { DeadlineClient, ListVolumesCommand } from "@aws-sdk/client-deadline"; // ES Modules import
37
+ * // const { DeadlineClient, ListVolumesCommand } = require("@aws-sdk/client-deadline"); // CommonJS import
38
+ * // import type { DeadlineClientConfig } from "@aws-sdk/client-deadline";
39
+ * const config = {}; // type is DeadlineClientConfig
40
+ * const client = new DeadlineClient(config);
41
+ * const input = { // ListVolumesRequest
42
+ * farmId: "STRING_VALUE", // required
43
+ * fleetId: "STRING_VALUE", // required
44
+ * nextToken: "STRING_VALUE",
45
+ * maxResults: Number("int"),
46
+ * };
47
+ * const command = new ListVolumesCommand(input);
48
+ * const response = await client.send(command);
49
+ * // { // ListVolumesResponse
50
+ * // volumes: [ // VolumeSummaries // required
51
+ * // { // VolumeSummary
52
+ * // volumeId: "STRING_VALUE", // required
53
+ * // farmId: "STRING_VALUE", // required
54
+ * // fleetId: "STRING_VALUE", // required
55
+ * // state: "PENDING_CREATION" || "PENDING_ATTACHMENT" || "IN_USE" || "AVAILABLE" || "PENDING_DELETION", // required
56
+ * // sizeGiB: Number("int"), // required
57
+ * // availabilityZoneId: "STRING_VALUE", // required
58
+ * // attachedWorkerId: "STRING_VALUE",
59
+ * // },
60
+ * // ],
61
+ * // nextToken: "STRING_VALUE",
62
+ * // };
63
+ *
64
+ * ```
65
+ *
66
+ * @param ListVolumesCommandInput - {@link ListVolumesCommandInput}
67
+ * @returns {@link ListVolumesCommandOutput}
68
+ * @see {@link ListVolumesCommandInput} for command's `input` shape.
69
+ * @see {@link ListVolumesCommandOutput} for command's `response` shape.
70
+ * @see {@link DeadlineClientResolvedConfig | config} for DeadlineClient's `config` shape.
71
+ *
72
+ * @throws {@link AccessDeniedException} (client fault)
73
+ * <p>You don't have permission to perform the action.</p>
74
+ *
75
+ * @throws {@link InternalServerErrorException} (server fault)
76
+ * <p>Deadline Cloud can't process your request right now. Try again later.</p>
77
+ *
78
+ * @throws {@link ResourceNotFoundException} (client fault)
79
+ * <p>The requested resource can't be found.</p>
80
+ *
81
+ * @throws {@link ThrottlingException} (client fault)
82
+ * <p>Your request exceeded a request rate quota.</p>
83
+ *
84
+ * @throws {@link ValidationException} (client fault)
85
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
86
+ *
87
+ * @throws {@link DeadlineServiceException}
88
+ * <p>Base exception class for all service exceptions from Deadline service.</p>
89
+ *
90
+ *
91
+ * @example List volumes for a fleet
92
+ * ```javascript
93
+ * //
94
+ * const input = {
95
+ * farmId: "farm-1234567890abcdef1234567890abcdef",
96
+ * fleetId: "fleet-1234567890abcdef1234567890abcdef"
97
+ * };
98
+ * const command = new ListVolumesCommand(input);
99
+ * const response = await client.send(command);
100
+ * /* response is
101
+ * { /* metadata only *\/ }
102
+ * *\/
103
+ * ```
104
+ *
105
+ * @public
106
+ */
107
+ export declare class ListVolumesCommand extends ListVolumesCommand_base {
108
+ /** @internal type navigation helper, not in runtime. */
109
+ protected static __types: {
110
+ api: {
111
+ input: ListVolumesRequest;
112
+ output: ListVolumesResponse;
113
+ };
114
+ sdk: {
115
+ input: ListVolumesCommandInput;
116
+ output: ListVolumesCommandOutput;
117
+ };
118
+ };
119
+ }
@@ -156,6 +156,13 @@ declare const UpdateFleetCommand_base: {
156
156
  * ],
157
157
  * },
158
158
  * storageProfileId: "STRING_VALUE",
159
+ * persistentVolumeConfiguration: { // PersistentVolumeConfiguration
160
+ * sizeGiB: Number("int"),
161
+ * iops: Number("int"),
162
+ * throughputMiB: Number("int"),
163
+ * mountPath: "STRING_VALUE", // required
164
+ * lastUsedTtlHours: Number("int"),
165
+ * },
159
166
  * autoScalingConfiguration: { // ServiceManagedEc2AutoScalingConfiguration
160
167
  * standbyWorkerCount: Number("int"),
161
168
  * workerIdleDurationSeconds: Number("int"),
@@ -42,6 +42,7 @@ export * from "./DeleteQueueEnvironmentCommand";
42
42
  export * from "./DeleteQueueFleetAssociationCommand";
43
43
  export * from "./DeleteQueueLimitAssociationCommand";
44
44
  export * from "./DeleteStorageProfileCommand";
45
+ export * from "./DeleteVolumeCommand";
45
46
  export * from "./DeleteWorkerCommand";
46
47
  export * from "./DisassociateMemberFromFarmCommand";
47
48
  export * from "./DisassociateMemberFromFleetCommand";
@@ -66,6 +67,7 @@ export * from "./GetStepCommand";
66
67
  export * from "./GetStorageProfileCommand";
67
68
  export * from "./GetStorageProfileForQueueCommand";
68
69
  export * from "./GetTaskCommand";
70
+ export * from "./GetVolumeCommand";
69
71
  export * from "./GetWorkerCommand";
70
72
  export * from "./ListAvailableMeteredProductsCommand";
71
73
  export * from "./ListBudgetsCommand";
@@ -95,6 +97,7 @@ export * from "./ListStorageProfilesCommand";
95
97
  export * from "./ListStorageProfilesForQueueCommand";
96
98
  export * from "./ListTagsForResourceCommand";
97
99
  export * from "./ListTasksCommand";
100
+ export * from "./ListVolumesCommand";
98
101
  export * from "./ListWorkersCommand";
99
102
  export * from "./PutMeteredProductCommand";
100
103
  export * from "./SearchJobsCommand";
@@ -18,9 +18,6 @@ export type AcceleratorName = (typeof AcceleratorName)[keyof typeof AcceleratorN
18
18
  * @enum
19
19
  */
20
20
  export declare const AcceleratorType: {
21
- /**
22
- * GPU accelerator type.
23
- */
24
21
  readonly GPU: "gpu";
25
22
  };
26
23
  /**
@@ -703,6 +700,32 @@ export declare const FleetStatus: {
703
700
  * @public
704
701
  */
705
702
  export type FleetStatus = (typeof FleetStatus)[keyof typeof FleetStatus];
703
+ /**
704
+ * @public
705
+ * @enum
706
+ */
707
+ export declare const VolumeState: {
708
+ readonly AVAILABLE: "AVAILABLE";
709
+ readonly IN_USE: "IN_USE";
710
+ readonly PENDING_ATTACHMENT: "PENDING_ATTACHMENT";
711
+ readonly PENDING_CREATION: "PENDING_CREATION";
712
+ readonly PENDING_DELETION: "PENDING_DELETION";
713
+ };
714
+ /**
715
+ * @public
716
+ */
717
+ export type VolumeState = (typeof VolumeState)[keyof typeof VolumeState];
718
+ /**
719
+ * @public
720
+ * @enum
721
+ */
722
+ export declare const EbsVolumeType: {
723
+ readonly GP3: "gp3";
724
+ };
725
+ /**
726
+ * @public
727
+ */
728
+ export type EbsVolumeType = (typeof EbsVolumeType)[keyof typeof EbsVolumeType];
706
729
  /**
707
730
  * @public
708
731
  * @enum