Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for +you to run and scale your high performance computing (HPC) workloads, +and build scientific and engineering models on Amazon Web Services using Slurm. +For more information, see +the Amazon Web Services Parallel Computing Service +User Guide.
+This reference describes the actions and data types of the service management API. You can use the +Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API +actions manually. These API actions manage the service through an Amazon Web Services account.
+The API actions operate on Amazon Web Services PCS resources. A resource is +an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use +the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute +node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.
+An Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch +compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch +compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. +Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources +related to those compute nodes.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-pcs +using your favorite package manager: + +- `npm install @aws-sdk/client-pcs` +- `yarn add @aws-sdk/client-pcs` +- `pnpm add @aws-sdk/client-pcs` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `PCSClient` and +the commands you need, for example `ListClustersCommand`: + +```js +// ES5 example +const { PCSClient, ListClustersCommand } = require("@aws-sdk/client-pcs"); +``` + +```ts +// ES6+ example +import { PCSClient, ListClustersCommand } from "@aws-sdk/client-pcs"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new PCSClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new ListClustersCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-pcs"; +const client = new AWS.PCS({ region: "REGION" }); + +// async/await. +try { + const data = await client.listClusters(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .listClusters(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.listClusters(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-pcs` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for + * you to run and scale your high performance computing (HPC) workloads, + * and build scientific and engineering models on Amazon Web Services using Slurm. + * For more information, see + * the Amazon Web Services Parallel Computing Service + * User Guide.
+ *This reference describes the actions and data types of the service management API. You can use the + * Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API + * actions manually. These API actions manage the service through an Amazon Web Services account.
+ *The API actions operate on Amazon Web Services PCS resources. A resource is + * an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use + * the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute + * node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.
+ *An Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch + * compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch + * compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. + * Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources + * related to those compute nodes.
+ * @public + */ +export class PCS extends PCSClient implements PCS {} +createAggregatedClient(commands, PCS); diff --git a/clients/client-pcs/src/PCSClient.ts b/clients/client-pcs/src/PCSClient.ts new file mode 100644 index 000000000000..c05bc4f5aff1 --- /dev/null +++ b/clients/client-pcs/src/PCSClient.ts @@ -0,0 +1,393 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { + DefaultIdentityProviderConfig, + getHttpAuthSchemeEndpointRuleSetPlugin, + getHttpSigningPlugin, +} from "@smithy/core"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + AwsCredentialIdentityProvider, + BodyLengthCalculator as __BodyLengthCalculator, + CheckOptionalClientConfig as __CheckOptionalClientConfig, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + HashConstructor as __HashConstructor, + HttpHandlerOptions as __HttpHandlerOptions, + Logger as __Logger, + Provider as __Provider, + Provider, + StreamCollector as __StreamCollector, + UrlParser as __UrlParser, + UserAgent as __UserAgent, +} from "@smithy/types"; + +import { + defaultPCSHttpAuthSchemeParametersProvider, + HttpAuthSchemeInputConfig, + HttpAuthSchemeResolvedConfig, + resolveHttpAuthSchemeConfig, +} from "./auth/httpAuthSchemeProvider"; +import { CreateClusterCommandInput, CreateClusterCommandOutput } from "./commands/CreateClusterCommand"; +import { + CreateComputeNodeGroupCommandInput, + CreateComputeNodeGroupCommandOutput, +} from "./commands/CreateComputeNodeGroupCommand"; +import { CreateQueueCommandInput, CreateQueueCommandOutput } from "./commands/CreateQueueCommand"; +import { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "./commands/DeleteClusterCommand"; +import { + DeleteComputeNodeGroupCommandInput, + DeleteComputeNodeGroupCommandOutput, +} from "./commands/DeleteComputeNodeGroupCommand"; +import { DeleteQueueCommandInput, DeleteQueueCommandOutput } from "./commands/DeleteQueueCommand"; +import { GetClusterCommandInput, GetClusterCommandOutput } from "./commands/GetClusterCommand"; +import { + GetComputeNodeGroupCommandInput, + GetComputeNodeGroupCommandOutput, +} from "./commands/GetComputeNodeGroupCommand"; +import { GetQueueCommandInput, GetQueueCommandOutput } from "./commands/GetQueueCommand"; +import { ListClustersCommandInput, ListClustersCommandOutput } from "./commands/ListClustersCommand"; +import { + ListComputeNodeGroupsCommandInput, + ListComputeNodeGroupsCommandOutput, +} from "./commands/ListComputeNodeGroupsCommand"; +import { ListQueuesCommandInput, ListQueuesCommandOutput } from "./commands/ListQueuesCommand"; +import { + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; +import { + RegisterComputeNodeGroupInstanceCommandInput, + RegisterComputeNodeGroupInstanceCommandOutput, +} from "./commands/RegisterComputeNodeGroupInstanceCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; +import { + UpdateComputeNodeGroupCommandInput, + UpdateComputeNodeGroupCommandOutput, +} from "./commands/UpdateComputeNodeGroupCommand"; +import { UpdateQueueCommandInput, UpdateQueueCommandOutput } from "./commands/UpdateQueueCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | CreateClusterCommandInput + | CreateComputeNodeGroupCommandInput + | CreateQueueCommandInput + | DeleteClusterCommandInput + | DeleteComputeNodeGroupCommandInput + | DeleteQueueCommandInput + | GetClusterCommandInput + | GetComputeNodeGroupCommandInput + | GetQueueCommandInput + | ListClustersCommandInput + | ListComputeNodeGroupsCommandInput + | ListQueuesCommandInput + | ListTagsForResourceCommandInput + | RegisterComputeNodeGroupInstanceCommandInput + | TagResourceCommandInput + | UntagResourceCommandInput + | UpdateComputeNodeGroupCommandInput + | UpdateQueueCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | CreateClusterCommandOutput + | CreateComputeNodeGroupCommandOutput + | CreateQueueCommandOutput + | DeleteClusterCommandOutput + | DeleteComputeNodeGroupCommandOutput + | DeleteQueueCommandOutput + | GetClusterCommandOutput + | GetComputeNodeGroupCommandOutput + | GetQueueCommandOutput + | ListClustersCommandOutput + | ListComputeNodeGroupsCommandOutput + | ListQueuesCommandOutput + | ListTagsForResourceCommandOutput + | RegisterComputeNodeGroupInstanceCommandOutput + | TagResourceCommandOutput + | UntagResourceCommandOutput + | UpdateComputeNodeGroupCommandOutput + | UpdateQueueCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandlerUserInput; + + /** + * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dynamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderAmazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for + * you to run and scale your high performance computing (HPC) workloads, + * and build scientific and engineering models on Amazon Web Services using Slurm. + * For more information, see + * the Amazon Web Services Parallel Computing Service + * User Guide.
+ *This reference describes the actions and data types of the service management API. You can use the + * Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API + * actions manually. These API actions manage the service through an Amazon Web Services account.
+ *The API actions operate on Amazon Web Services PCS resources. A resource is + * an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use + * the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute + * node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.
+ *An Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch + * compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch + * compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. + * Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources + * related to those compute nodes.
+ * @public + */ +export class PCSClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + PCSClientResolvedConfig +> { + /** + * The resolved configuration of PCSClient class. This is resolved and normalized from the {@link PCSClientConfig | constructor configuration interface}. + */ + readonly config: PCSClientResolvedConfig; + + constructor(...[configuration]: __CheckOptionalClientConfigCreates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a + * service-owned account. The cluster controller communicates with the cluster resources in + * your account. The subnets and security groups for the cluster must already exist before you + * use this API action.
+ *It takes time for Amazon Web Services PCS to create the cluster. The cluster is in
+ * a Creating state until it is ready to use. There can only be 1
+ * cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account.
+ * CreateCluster
+ * fails with a ServiceQuotaExceededException if there is already
+ * a cluster in a Creating state.
You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You exceeded your service quota. Service quotas, also referred to as limits, are the + * maximum number of service resources or operations for your Amazon Web Services account. To learn how to + * increase your service quota, see Requesting a quota + * increase in the Service Quotas User Guide + *
+ *+ * Examples + *
+ *The max number of clusters or queues has been reached for the account.
+ *The max number of compute node groups has been reached for the associated + * cluster.
+ *The total of maxInstances across all compute node groups has been
+ * reached for associated cluster.
Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class CreateClusterCommand extends $Command + .classBuilder< + CreateClusterCommandInput, + CreateClusterCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "CreateCluster", {}) + .n("PCSClient", "CreateClusterCommand") + .f(void 0, void 0) + .ser(se_CreateClusterCommand) + .de(de_CreateClusterCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/CreateComputeNodeGroupCommand.ts b/clients/client-pcs/src/commands/CreateComputeNodeGroupCommand.ts new file mode 100644 index 000000000000..265ac7715ea4 --- /dev/null +++ b/clients/client-pcs/src/commands/CreateComputeNodeGroupCommand.ts @@ -0,0 +1,269 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateComputeNodeGroupRequest, CreateComputeNodeGroupResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_CreateComputeNodeGroupCommand, se_CreateComputeNodeGroupCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateComputeNodeGroupCommand}. + */ +export interface CreateComputeNodeGroupCommandInput extends CreateComputeNodeGroupRequest {} +/** + * @public + * + * The output of {@link CreateComputeNodeGroupCommand}. + */ +export interface CreateComputeNodeGroupCommandOutput extends CreateComputeNodeGroupResponse, __MetadataBearer {} + +/** + *Creates a managed set of compute nodes. You associate a compute node group with a + * cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node + * group includes the definition of the compute properties and lifecycle management. + * Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in + * your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive + * billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must + * already have a launch template before you call this API. For more information, see Launch an + * instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux + * Instances.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, CreateComputeNodeGroupCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, CreateComputeNodeGroupCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // CreateComputeNodeGroupRequest + * clusterIdentifier: "STRING_VALUE", // required + * computeNodeGroupName: "STRING_VALUE", // required + * amiId: "STRING_VALUE", + * subnetIds: [ // StringList // required + * "STRING_VALUE", + * ], + * purchaseOption: "ONDEMAND" || "SPOT", + * customLaunchTemplate: { // CustomLaunchTemplate + * id: "STRING_VALUE", // required + * version: "STRING_VALUE", // required + * }, + * iamInstanceProfileArn: "STRING_VALUE", // required + * scalingConfiguration: { // ScalingConfigurationRequest + * minInstanceCount: Number("int"), // required + * maxInstanceCount: Number("int"), // required + * }, + * instanceConfigs: [ // InstanceList // required + * { // InstanceConfig + * instanceType: "STRING_VALUE", + * }, + * ], + * spotOptions: { // SpotOptions + * allocationStrategy: "lowest-price" || "capacity-optimized" || "price-capacity-optimized", + * }, + * slurmConfiguration: { // ComputeNodeGroupSlurmConfigurationRequest + * slurmCustomSettings: [ // SlurmCustomSettings + * { // SlurmCustomSetting + * parameterName: "STRING_VALUE", // required + * parameterValue: "STRING_VALUE", // required + * }, + * ], + * }, + * clientToken: "STRING_VALUE", + * tags: { // RequestTagMap + * "You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You exceeded your service quota. Service quotas, also referred to as limits, are the + * maximum number of service resources or operations for your Amazon Web Services account. To learn how to + * increase your service quota, see Requesting a quota + * increase in the Service Quotas User Guide + *
+ *+ * Examples + *
+ *The max number of clusters or queues has been reached for the account.
+ *The max number of compute node groups has been reached for the associated + * cluster.
+ *The total of maxInstances across all compute node groups has been
+ * reached for associated cluster.
Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class CreateComputeNodeGroupCommand extends $Command + .classBuilder< + CreateComputeNodeGroupCommandInput, + CreateComputeNodeGroupCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "CreateComputeNodeGroup", {}) + .n("PCSClient", "CreateComputeNodeGroupCommand") + .f(void 0, void 0) + .ser(se_CreateComputeNodeGroupCommand) + .de(de_CreateComputeNodeGroupCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/CreateQueueCommand.ts b/clients/client-pcs/src/commands/CreateQueueCommand.ts new file mode 100644 index 000000000000..b89bc3b3ea58 --- /dev/null +++ b/clients/client-pcs/src/commands/CreateQueueCommand.ts @@ -0,0 +1,212 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateQueueRequest, CreateQueueResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_CreateQueueCommand, se_CreateQueueCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateQueueCommand}. + */ +export interface CreateQueueCommandInput extends CreateQueueRequest {} +/** + * @public + * + * The output of {@link CreateQueueCommand}. + */ +export interface CreateQueueCommandOutput extends CreateQueueResponse, __MetadataBearer {} + +/** + *Creates a job queue. You must associate 1 or more compute node groups with the queue. + * You can associate 1 compute node group with multiple queues.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, CreateQueueCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, CreateQueueCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // CreateQueueRequest + * clusterIdentifier: "STRING_VALUE", // required + * queueName: "STRING_VALUE", // required + * computeNodeGroupConfigurations: [ // ComputeNodeGroupConfigurationList + * { // ComputeNodeGroupConfiguration + * computeNodeGroupId: "STRING_VALUE", + * }, + * ], + * clientToken: "STRING_VALUE", + * tags: { // RequestTagMap + * "You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You exceeded your service quota. Service quotas, also referred to as limits, are the + * maximum number of service resources or operations for your Amazon Web Services account. To learn how to + * increase your service quota, see Requesting a quota + * increase in the Service Quotas User Guide + *
+ *+ * Examples + *
+ *The max number of clusters or queues has been reached for the account.
+ *The max number of compute node groups has been reached for the associated + * cluster.
+ *The total of maxInstances across all compute node groups has been
+ * reached for associated cluster.
Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class CreateQueueCommand extends $Command + .classBuilder< + CreateQueueCommandInput, + CreateQueueCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "CreateQueue", {}) + .n("PCSClient", "CreateQueueCommand") + .f(void 0, void 0) + .ser(se_CreateQueueCommand) + .de(de_CreateQueueCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/DeleteClusterCommand.ts b/clients/client-pcs/src/commands/DeleteClusterCommand.ts new file mode 100644 index 000000000000..100e0e142d51 --- /dev/null +++ b/clients/client-pcs/src/commands/DeleteClusterCommand.ts @@ -0,0 +1,159 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteClusterRequest, DeleteClusterResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_DeleteClusterCommand, se_DeleteClusterCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteClusterCommand}. + */ +export interface DeleteClusterCommandInput extends DeleteClusterRequest {} +/** + * @public + * + * The output of {@link DeleteClusterCommand}. + */ +export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __MetadataBearer {} + +/** + *Deletes a cluster and all its linked resources. You must delete all queues and compute + * node groups associated with the cluster before you can delete the cluster.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, DeleteClusterCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, DeleteClusterCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // DeleteClusterRequest + * clusterIdentifier: "STRING_VALUE", // required + * clientToken: "STRING_VALUE", + * }; + * const command = new DeleteClusterCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteClusterCommandInput - {@link DeleteClusterCommandInput} + * @returns {@link DeleteClusterCommandOutput} + * @see {@link DeleteClusterCommandInput} for command's `input` shape. + * @see {@link DeleteClusterCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ThrottlingException} (client fault) + *Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class DeleteClusterCommand extends $Command + .classBuilder< + DeleteClusterCommandInput, + DeleteClusterCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "DeleteCluster", {}) + .n("PCSClient", "DeleteClusterCommand") + .f(void 0, void 0) + .ser(se_DeleteClusterCommand) + .de(de_DeleteClusterCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/DeleteComputeNodeGroupCommand.ts b/clients/client-pcs/src/commands/DeleteComputeNodeGroupCommand.ts new file mode 100644 index 000000000000..f284358e172c --- /dev/null +++ b/clients/client-pcs/src/commands/DeleteComputeNodeGroupCommand.ts @@ -0,0 +1,160 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteComputeNodeGroupRequest, DeleteComputeNodeGroupResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_DeleteComputeNodeGroupCommand, se_DeleteComputeNodeGroupCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteComputeNodeGroupCommand}. + */ +export interface DeleteComputeNodeGroupCommandInput extends DeleteComputeNodeGroupRequest {} +/** + * @public + * + * The output of {@link DeleteComputeNodeGroupCommand}. + */ +export interface DeleteComputeNodeGroupCommandOutput extends DeleteComputeNodeGroupResponse, __MetadataBearer {} + +/** + *Deletes a compute node group. You must delete all queues associated with the compute + * node group first.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, DeleteComputeNodeGroupCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, DeleteComputeNodeGroupCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // DeleteComputeNodeGroupRequest + * clusterIdentifier: "STRING_VALUE", // required + * computeNodeGroupIdentifier: "STRING_VALUE", // required + * clientToken: "STRING_VALUE", + * }; + * const command = new DeleteComputeNodeGroupCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteComputeNodeGroupCommandInput - {@link DeleteComputeNodeGroupCommandInput} + * @returns {@link DeleteComputeNodeGroupCommandOutput} + * @see {@link DeleteComputeNodeGroupCommandInput} for command's `input` shape. + * @see {@link DeleteComputeNodeGroupCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ThrottlingException} (client fault) + *Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class DeleteComputeNodeGroupCommand extends $Command + .classBuilder< + DeleteComputeNodeGroupCommandInput, + DeleteComputeNodeGroupCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "DeleteComputeNodeGroup", {}) + .n("PCSClient", "DeleteComputeNodeGroupCommand") + .f(void 0, void 0) + .ser(se_DeleteComputeNodeGroupCommand) + .de(de_DeleteComputeNodeGroupCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/DeleteQueueCommand.ts b/clients/client-pcs/src/commands/DeleteQueueCommand.ts new file mode 100644 index 000000000000..f53d4c523a95 --- /dev/null +++ b/clients/client-pcs/src/commands/DeleteQueueCommand.ts @@ -0,0 +1,161 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteQueueRequest, DeleteQueueResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_DeleteQueueCommand, se_DeleteQueueCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteQueueCommand}. + */ +export interface DeleteQueueCommandInput extends DeleteQueueRequest {} +/** + * @public + * + * The output of {@link DeleteQueueCommand}. + */ +export interface DeleteQueueCommandOutput extends DeleteQueueResponse, __MetadataBearer {} + +/** + *Deletes a job queue. If the compute node group associated with this queue isn't + * associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this + * queue.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, DeleteQueueCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, DeleteQueueCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // DeleteQueueRequest + * clusterIdentifier: "STRING_VALUE", // required + * queueIdentifier: "STRING_VALUE", // required + * clientToken: "STRING_VALUE", + * }; + * const command = new DeleteQueueCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteQueueCommandInput - {@link DeleteQueueCommandInput} + * @returns {@link DeleteQueueCommandOutput} + * @see {@link DeleteQueueCommandInput} for command's `input` shape. + * @see {@link DeleteQueueCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ThrottlingException} (client fault) + *Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class DeleteQueueCommand extends $Command + .classBuilder< + DeleteQueueCommandInput, + DeleteQueueCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "DeleteQueue", {}) + .n("PCSClient", "DeleteQueueCommand") + .f(void 0, void 0) + .ser(se_DeleteQueueCommand) + .de(de_DeleteQueueCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/GetClusterCommand.ts b/clients/client-pcs/src/commands/GetClusterCommand.ts new file mode 100644 index 000000000000..eb7c08ce4d91 --- /dev/null +++ b/clients/client-pcs/src/commands/GetClusterCommand.ts @@ -0,0 +1,208 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetClusterRequest, GetClusterResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_GetClusterCommand, se_GetClusterCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetClusterCommand}. + */ +export interface GetClusterCommandInput extends GetClusterRequest {} +/** + * @public + * + * The output of {@link GetClusterCommand}. + */ +export interface GetClusterCommandOutput extends GetClusterResponse, __MetadataBearer {} + +/** + *Returns detailed information about a running cluster in your account. This API action + * provides networking information, endpoint information for communication with the scheduler, + * and provisioning status.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, GetClusterCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, GetClusterCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // GetClusterRequest + * clusterIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetClusterCommand(input); + * const response = await client.send(command); + * // { // GetClusterResponse + * // cluster: { // Cluster + * // name: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), // required + * // scheduler: { // Scheduler + * // type: "SLURM", // required + * // version: "STRING_VALUE", // required + * // }, + * // size: "SMALL" || "MEDIUM" || "LARGE", // required + * // slurmConfiguration: { // ClusterSlurmConfiguration + * // scaleDownIdleTimeInSeconds: Number("int"), + * // slurmCustomSettings: [ // SlurmCustomSettings + * // { // SlurmCustomSetting + * // parameterName: "STRING_VALUE", // required + * // parameterValue: "STRING_VALUE", // required + * // }, + * // ], + * // authKey: { // SlurmAuthKey + * // secretArn: "STRING_VALUE", // required + * // secretVersion: "STRING_VALUE", // required + * // }, + * // }, + * // networking: { // Networking + * // subnetIds: [ // SubnetIdList + * // "STRING_VALUE", + * // ], + * // securityGroupIds: [ // SecurityGroupIdList + * // "STRING_VALUE", + * // ], + * // }, + * // endpoints: [ // Endpoints + * // { // Endpoint + * // type: "SLURMCTLD" || "SLURMDBD", // required + * // privateIpAddress: "STRING_VALUE", // required + * // publicIpAddress: "STRING_VALUE", + * // port: "STRING_VALUE", // required + * // }, + * // ], + * // errorInfo: [ // ErrorInfoList + * // { // ErrorInfo + * // code: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // ], + * // }, + * // }; + * + * ``` + * + * @param GetClusterCommandInput - {@link GetClusterCommandInput} + * @returns {@link GetClusterCommandOutput} + * @see {@link GetClusterCommandInput} for command's `input` shape. + * @see {@link GetClusterCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ThrottlingException} (client fault) + *Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class GetClusterCommand extends $Command + .classBuilder< + GetClusterCommandInput, + GetClusterCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "GetCluster", {}) + .n("PCSClient", "GetClusterCommand") + .f(void 0, void 0) + .ser(se_GetClusterCommand) + .de(de_GetClusterCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/GetComputeNodeGroupCommand.ts b/clients/client-pcs/src/commands/GetComputeNodeGroupCommand.ts new file mode 100644 index 000000000000..081380769f18 --- /dev/null +++ b/clients/client-pcs/src/commands/GetComputeNodeGroupCommand.ts @@ -0,0 +1,206 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetComputeNodeGroupRequest, GetComputeNodeGroupResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_GetComputeNodeGroupCommand, se_GetComputeNodeGroupCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetComputeNodeGroupCommand}. + */ +export interface GetComputeNodeGroupCommandInput extends GetComputeNodeGroupRequest {} +/** + * @public + * + * The output of {@link GetComputeNodeGroupCommand}. + */ +export interface GetComputeNodeGroupCommandOutput extends GetComputeNodeGroupResponse, __MetadataBearer {} + +/** + *Returns detailed information about a compute node group. This API action provides + * networking information, EC2 instance type, compute node group status, and scheduler (such + * as Slurm) configuration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, GetComputeNodeGroupCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, GetComputeNodeGroupCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // GetComputeNodeGroupRequest + * clusterIdentifier: "STRING_VALUE", // required + * computeNodeGroupIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetComputeNodeGroupCommand(input); + * const response = await client.send(command); + * // { // GetComputeNodeGroupResponse + * // computeNodeGroup: { // ComputeNodeGroup + * // name: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // clusterId: "STRING_VALUE", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), // required + * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED" || "DELETED", // required + * // amiId: "STRING_VALUE", + * // subnetIds: [ // SubnetIdList // required + * // "STRING_VALUE", + * // ], + * // purchaseOption: "ONDEMAND" || "SPOT", + * // customLaunchTemplate: { // CustomLaunchTemplate + * // id: "STRING_VALUE", // required + * // version: "STRING_VALUE", // required + * // }, + * // iamInstanceProfileArn: "STRING_VALUE", // required + * // scalingConfiguration: { // ScalingConfiguration + * // minInstanceCount: Number("int"), // required + * // maxInstanceCount: Number("int"), // required + * // }, + * // instanceConfigs: [ // InstanceList // required + * // { // InstanceConfig + * // instanceType: "STRING_VALUE", + * // }, + * // ], + * // spotOptions: { // SpotOptions + * // allocationStrategy: "lowest-price" || "capacity-optimized" || "price-capacity-optimized", + * // }, + * // slurmConfiguration: { // ComputeNodeGroupSlurmConfiguration + * // slurmCustomSettings: [ // SlurmCustomSettings + * // { // SlurmCustomSetting + * // parameterName: "STRING_VALUE", // required + * // parameterValue: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // errorInfo: [ // ErrorInfoList + * // { // ErrorInfo + * // code: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // ], + * // }, + * // }; + * + * ``` + * + * @param GetComputeNodeGroupCommandInput - {@link GetComputeNodeGroupCommandInput} + * @returns {@link GetComputeNodeGroupCommandOutput} + * @see {@link GetComputeNodeGroupCommandInput} for command's `input` shape. + * @see {@link GetComputeNodeGroupCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ThrottlingException} (client fault) + *Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class GetComputeNodeGroupCommand extends $Command + .classBuilder< + GetComputeNodeGroupCommandInput, + GetComputeNodeGroupCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "GetComputeNodeGroup", {}) + .n("PCSClient", "GetComputeNodeGroupCommand") + .f(void 0, void 0) + .ser(se_GetComputeNodeGroupCommand) + .de(de_GetComputeNodeGroupCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/GetQueueCommand.ts b/clients/client-pcs/src/commands/GetQueueCommand.ts new file mode 100644 index 000000000000..a2f011d9cbbf --- /dev/null +++ b/clients/client-pcs/src/commands/GetQueueCommand.ts @@ -0,0 +1,180 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetQueueRequest, GetQueueResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_GetQueueCommand, se_GetQueueCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetQueueCommand}. + */ +export interface GetQueueCommandInput extends GetQueueRequest {} +/** + * @public + * + * The output of {@link GetQueueCommand}. + */ +export interface GetQueueCommandOutput extends GetQueueResponse, __MetadataBearer {} + +/** + *Returns detailed information about a queue. The information includes the compute node + * groups that the queue uses to schedule jobs.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, GetQueueCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, GetQueueCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // GetQueueRequest + * clusterIdentifier: "STRING_VALUE", // required + * queueIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetQueueCommand(input); + * const response = await client.send(command); + * // { // GetQueueResponse + * // queue: { // Queue + * // name: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // clusterId: "STRING_VALUE", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), // required + * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED", // required + * // computeNodeGroupConfigurations: [ // ComputeNodeGroupConfigurationList // required + * // { // ComputeNodeGroupConfiguration + * // computeNodeGroupId: "STRING_VALUE", + * // }, + * // ], + * // errorInfo: [ // ErrorInfoList + * // { // ErrorInfo + * // code: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // ], + * // }, + * // }; + * + * ``` + * + * @param GetQueueCommandInput - {@link GetQueueCommandInput} + * @returns {@link GetQueueCommandOutput} + * @see {@link GetQueueCommandInput} for command's `input` shape. + * @see {@link GetQueueCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ThrottlingException} (client fault) + *Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class GetQueueCommand extends $Command + .classBuilder< + GetQueueCommandInput, + GetQueueCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "GetQueue", {}) + .n("PCSClient", "GetQueueCommand") + .f(void 0, void 0) + .ser(se_GetQueueCommand) + .de(de_GetQueueCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/ListClustersCommand.ts b/clients/client-pcs/src/commands/ListClustersCommand.ts new file mode 100644 index 000000000000..1a95e00150cf --- /dev/null +++ b/clients/client-pcs/src/commands/ListClustersCommand.ts @@ -0,0 +1,170 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListClustersRequest, ListClustersResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_ListClustersCommand, se_ListClustersCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListClustersCommand}. + */ +export interface ListClustersCommandInput extends ListClustersRequest {} +/** + * @public + * + * The output of {@link ListClustersCommand}. + */ +export interface ListClustersCommandOutput extends ListClustersResponse, __MetadataBearer {} + +/** + *Returns a list of running clusters in your account.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, ListClustersCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, ListClustersCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // ListClustersRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListClustersCommand(input); + * const response = await client.send(command); + * // { // ListClustersResponse + * // clusters: [ // ClusterList // required + * // { // ClusterSummary + * // name: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), // required + * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED", // required + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListClustersCommandInput - {@link ListClustersCommandInput} + * @returns {@link ListClustersCommandOutput} + * @see {@link ListClustersCommandInput} for command's `input` shape. + * @see {@link ListClustersCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ThrottlingException} (client fault) + *Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class ListClustersCommand extends $Command + .classBuilder< + ListClustersCommandInput, + ListClustersCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "ListClusters", {}) + .n("PCSClient", "ListClustersCommand") + .f(void 0, void 0) + .ser(se_ListClustersCommand) + .de(de_ListClustersCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/ListComputeNodeGroupsCommand.ts b/clients/client-pcs/src/commands/ListComputeNodeGroupsCommand.ts new file mode 100644 index 000000000000..a5c4502b032c --- /dev/null +++ b/clients/client-pcs/src/commands/ListComputeNodeGroupsCommand.ts @@ -0,0 +1,172 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListComputeNodeGroupsRequest, ListComputeNodeGroupsResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_ListComputeNodeGroupsCommand, se_ListComputeNodeGroupsCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListComputeNodeGroupsCommand}. + */ +export interface ListComputeNodeGroupsCommandInput extends ListComputeNodeGroupsRequest {} +/** + * @public + * + * The output of {@link ListComputeNodeGroupsCommand}. + */ +export interface ListComputeNodeGroupsCommandOutput extends ListComputeNodeGroupsResponse, __MetadataBearer {} + +/** + *Returns a list of all compute node groups associated with a cluster.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, ListComputeNodeGroupsCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, ListComputeNodeGroupsCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // ListComputeNodeGroupsRequest + * clusterIdentifier: "STRING_VALUE", // required + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListComputeNodeGroupsCommand(input); + * const response = await client.send(command); + * // { // ListComputeNodeGroupsResponse + * // computeNodeGroups: [ // ComputeNodeGroupList // required + * // { // ComputeNodeGroupSummary + * // name: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // clusterId: "STRING_VALUE", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), // required + * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED" || "DELETED", // required + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListComputeNodeGroupsCommandInput - {@link ListComputeNodeGroupsCommandInput} + * @returns {@link ListComputeNodeGroupsCommandOutput} + * @see {@link ListComputeNodeGroupsCommandInput} for command's `input` shape. + * @see {@link ListComputeNodeGroupsCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ThrottlingException} (client fault) + *Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class ListComputeNodeGroupsCommand extends $Command + .classBuilder< + ListComputeNodeGroupsCommandInput, + ListComputeNodeGroupsCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "ListComputeNodeGroups", {}) + .n("PCSClient", "ListComputeNodeGroupsCommand") + .f(void 0, void 0) + .ser(se_ListComputeNodeGroupsCommand) + .de(de_ListComputeNodeGroupsCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/ListQueuesCommand.ts b/clients/client-pcs/src/commands/ListQueuesCommand.ts new file mode 100644 index 000000000000..729bdcde360c --- /dev/null +++ b/clients/client-pcs/src/commands/ListQueuesCommand.ts @@ -0,0 +1,172 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListQueuesRequest, ListQueuesResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_ListQueuesCommand, se_ListQueuesCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListQueuesCommand}. + */ +export interface ListQueuesCommandInput extends ListQueuesRequest {} +/** + * @public + * + * The output of {@link ListQueuesCommand}. + */ +export interface ListQueuesCommandOutput extends ListQueuesResponse, __MetadataBearer {} + +/** + *Returns a list of all queues associated with a cluster.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, ListQueuesCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, ListQueuesCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // ListQueuesRequest + * clusterIdentifier: "STRING_VALUE", // required + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListQueuesCommand(input); + * const response = await client.send(command); + * // { // ListQueuesResponse + * // queues: [ // QueueList // required + * // { // QueueSummary + * // name: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // clusterId: "STRING_VALUE", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), // required + * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED", // required + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListQueuesCommandInput - {@link ListQueuesCommandInput} + * @returns {@link ListQueuesCommandOutput} + * @see {@link ListQueuesCommandInput} for command's `input` shape. + * @see {@link ListQueuesCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ThrottlingException} (client fault) + *Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class ListQueuesCommand extends $Command + .classBuilder< + ListQueuesCommandInput, + ListQueuesCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "ListQueues", {}) + .n("PCSClient", "ListQueuesCommand") + .f(void 0, void 0) + .ser(se_ListQueuesCommand) + .de(de_ListQueuesCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/ListTagsForResourceCommand.ts b/clients/client-pcs/src/commands/ListTagsForResourceCommand.ts new file mode 100644 index 000000000000..1d4b6a82597a --- /dev/null +++ b/clients/client-pcs/src/commands/ListTagsForResourceCommand.ts @@ -0,0 +1,91 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_ListTagsForResourceCommand, se_ListTagsForResourceCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {} +/** + * @public + * + * The output of {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} + +/** + *Returns a list of all tags on an Amazon Web Services PCS resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, ListTagsForResourceCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // ListTagsForResourceRequest + * resourceArn: "STRING_VALUE", // required + * }; + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * // { // ListTagsForResourceResponse + * // tags: { // ResponseTagMap + * // "The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link PCSServiceException} + *Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class ListTagsForResourceCommand extends $Command + .classBuilder< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "ListTagsForResource", {}) + .n("PCSClient", "ListTagsForResourceCommand") + .f(void 0, void 0) + .ser(se_ListTagsForResourceCommand) + .de(de_ListTagsForResourceCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/RegisterComputeNodeGroupInstanceCommand.ts b/clients/client-pcs/src/commands/RegisterComputeNodeGroupInstanceCommand.ts new file mode 100644 index 000000000000..2e4e68e6b1fd --- /dev/null +++ b/clients/client-pcs/src/commands/RegisterComputeNodeGroupInstanceCommand.ts @@ -0,0 +1,128 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { + RegisterComputeNodeGroupInstanceRequest, + RegisterComputeNodeGroupInstanceResponse, + RegisterComputeNodeGroupInstanceResponseFilterSensitiveLog, +} from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { + de_RegisterComputeNodeGroupInstanceCommand, + se_RegisterComputeNodeGroupInstanceCommand, +} from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link RegisterComputeNodeGroupInstanceCommand}. + */ +export interface RegisterComputeNodeGroupInstanceCommandInput extends RegisterComputeNodeGroupInstanceRequest {} +/** + * @public + * + * The output of {@link RegisterComputeNodeGroupInstanceCommand}. + */ +export interface RegisterComputeNodeGroupInstanceCommandOutput + extends RegisterComputeNodeGroupInstanceResponse, + __MetadataBearer {} + +/** + *This API action isn't intended for you to use.
+ *Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, RegisterComputeNodeGroupInstanceCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, RegisterComputeNodeGroupInstanceCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // RegisterComputeNodeGroupInstanceRequest + * clusterIdentifier: "STRING_VALUE", // required + * bootstrapId: "STRING_VALUE", // required + * }; + * const command = new RegisterComputeNodeGroupInstanceCommand(input); + * const response = await client.send(command); + * // { // RegisterComputeNodeGroupInstanceResponse + * // nodeID: "STRING_VALUE", // required + * // sharedSecret: "STRING_VALUE", // required + * // endpoints: [ // Endpoints // required + * // { // Endpoint + * // type: "SLURMCTLD" || "SLURMDBD", // required + * // privateIpAddress: "STRING_VALUE", // required + * // publicIpAddress: "STRING_VALUE", + * // port: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param RegisterComputeNodeGroupInstanceCommandInput - {@link RegisterComputeNodeGroupInstanceCommandInput} + * @returns {@link RegisterComputeNodeGroupInstanceCommandOutput} + * @see {@link RegisterComputeNodeGroupInstanceCommandInput} for command's `input` shape. + * @see {@link RegisterComputeNodeGroupInstanceCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link PCSServiceException} + *Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class RegisterComputeNodeGroupInstanceCommand extends $Command + .classBuilder< + RegisterComputeNodeGroupInstanceCommandInput, + RegisterComputeNodeGroupInstanceCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "RegisterComputeNodeGroupInstance", {}) + .n("PCSClient", "RegisterComputeNodeGroupInstanceCommand") + .f(void 0, RegisterComputeNodeGroupInstanceResponseFilterSensitiveLog) + .ser(se_RegisterComputeNodeGroupInstanceCommand) + .de(de_RegisterComputeNodeGroupInstanceCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/TagResourceCommand.ts b/clients/client-pcs/src/commands/TagResourceCommand.ts new file mode 100644 index 000000000000..032b2b763fe5 --- /dev/null +++ b/clients/client-pcs/src/commands/TagResourceCommand.ts @@ -0,0 +1,93 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { TagResourceRequest } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_TagResourceCommand, se_TagResourceCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link TagResourceCommand}. + */ +export interface TagResourceCommandInput extends TagResourceRequest {} +/** + * @public + * + * The output of {@link TagResourceCommand}. + */ +export interface TagResourceCommandOutput extends __MetadataBearer {} + +/** + *Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag + * value. The tag key and tag value are case-sensitive strings. The tag value can be an empty + * (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify + * an existing tag key and a new tag value.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, TagResourceCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, TagResourceCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // TagResourceRequest + * resourceArn: "STRING_VALUE", // required + * tags: { // RequestTagMap // required + * "The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link PCSServiceException} + *Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class TagResourceCommand extends $Command + .classBuilder< + TagResourceCommandInput, + TagResourceCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "TagResource", {}) + .n("PCSClient", "TagResourceCommand") + .f(void 0, void 0) + .ser(se_TagResourceCommand) + .de(de_TagResourceCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/UntagResourceCommand.ts b/clients/client-pcs/src/commands/UntagResourceCommand.ts new file mode 100644 index 000000000000..5bc44ee6e5c9 --- /dev/null +++ b/clients/client-pcs/src/commands/UntagResourceCommand.ts @@ -0,0 +1,91 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UntagResourceRequest } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_UntagResourceCommand, se_UntagResourceCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandInput extends UntagResourceRequest {} +/** + * @public + * + * The output of {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandOutput extends __MetadataBearer {} + +/** + *Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the + * Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, UntagResourceCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, UntagResourceCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // UntagResourceRequest + * resourceArn: "STRING_VALUE", // required + * tagKeys: [ // TagKeys // required + * "STRING_VALUE", + * ], + * }; + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UntagResourceCommandInput - {@link UntagResourceCommandInput} + * @returns {@link UntagResourceCommandOutput} + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link PCSServiceException} + *Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class UntagResourceCommand extends $Command + .classBuilder< + UntagResourceCommandInput, + UntagResourceCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "UntagResource", {}) + .n("PCSClient", "UntagResourceCommand") + .f(void 0, void 0) + .ser(se_UntagResourceCommand) + .de(de_UntagResourceCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/UpdateComputeNodeGroupCommand.ts b/clients/client-pcs/src/commands/UpdateComputeNodeGroupCommand.ts new file mode 100644 index 000000000000..93198af95afc --- /dev/null +++ b/clients/client-pcs/src/commands/UpdateComputeNodeGroupCommand.ts @@ -0,0 +1,255 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateComputeNodeGroupRequest, UpdateComputeNodeGroupResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_UpdateComputeNodeGroupCommand, se_UpdateComputeNodeGroupCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateComputeNodeGroupCommand}. + */ +export interface UpdateComputeNodeGroupCommandInput extends UpdateComputeNodeGroupRequest {} +/** + * @public + * + * The output of {@link UpdateComputeNodeGroupCommand}. + */ +export interface UpdateComputeNodeGroupCommandOutput extends UpdateComputeNodeGroupResponse, __MetadataBearer {} + +/** + *Updates a compute node group. You can update many of the fields related to your compute + * node group including the configurations for networking, compute nodes, and settings + * specific to your scheduler (such as Slurm).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, UpdateComputeNodeGroupCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, UpdateComputeNodeGroupCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // UpdateComputeNodeGroupRequest + * clusterIdentifier: "STRING_VALUE", // required + * computeNodeGroupIdentifier: "STRING_VALUE", // required + * amiId: "STRING_VALUE", + * subnetIds: [ // StringList + * "STRING_VALUE", + * ], + * customLaunchTemplate: { // CustomLaunchTemplate + * id: "STRING_VALUE", // required + * version: "STRING_VALUE", // required + * }, + * purchaseOption: "ONDEMAND" || "SPOT", + * spotOptions: { // SpotOptions + * allocationStrategy: "lowest-price" || "capacity-optimized" || "price-capacity-optimized", + * }, + * scalingConfiguration: { // ScalingConfigurationRequest + * minInstanceCount: Number("int"), // required + * maxInstanceCount: Number("int"), // required + * }, + * iamInstanceProfileArn: "STRING_VALUE", + * slurmConfiguration: { // UpdateComputeNodeGroupSlurmConfigurationRequest + * slurmCustomSettings: [ // SlurmCustomSettings + * { // SlurmCustomSetting + * parameterName: "STRING_VALUE", // required + * parameterValue: "STRING_VALUE", // required + * }, + * ], + * }, + * clientToken: "STRING_VALUE", + * }; + * const command = new UpdateComputeNodeGroupCommand(input); + * const response = await client.send(command); + * // { // UpdateComputeNodeGroupResponse + * // computeNodeGroup: { // ComputeNodeGroup + * // name: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // clusterId: "STRING_VALUE", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), // required + * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED" || "DELETED", // required + * // amiId: "STRING_VALUE", + * // subnetIds: [ // SubnetIdList // required + * // "STRING_VALUE", + * // ], + * // purchaseOption: "ONDEMAND" || "SPOT", + * // customLaunchTemplate: { // CustomLaunchTemplate + * // id: "STRING_VALUE", // required + * // version: "STRING_VALUE", // required + * // }, + * // iamInstanceProfileArn: "STRING_VALUE", // required + * // scalingConfiguration: { // ScalingConfiguration + * // minInstanceCount: Number("int"), // required + * // maxInstanceCount: Number("int"), // required + * // }, + * // instanceConfigs: [ // InstanceList // required + * // { // InstanceConfig + * // instanceType: "STRING_VALUE", + * // }, + * // ], + * // spotOptions: { // SpotOptions + * // allocationStrategy: "lowest-price" || "capacity-optimized" || "price-capacity-optimized", + * // }, + * // slurmConfiguration: { // ComputeNodeGroupSlurmConfiguration + * // slurmCustomSettings: [ // SlurmCustomSettings + * // { // SlurmCustomSetting + * // parameterName: "STRING_VALUE", // required + * // parameterValue: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // errorInfo: [ // ErrorInfoList + * // { // ErrorInfo + * // code: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // ], + * // }, + * // }; + * + * ``` + * + * @param UpdateComputeNodeGroupCommandInput - {@link UpdateComputeNodeGroupCommandInput} + * @returns {@link UpdateComputeNodeGroupCommandOutput} + * @see {@link UpdateComputeNodeGroupCommandInput} for command's `input` shape. + * @see {@link UpdateComputeNodeGroupCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You exceeded your service quota. Service quotas, also referred to as limits, are the + * maximum number of service resources or operations for your Amazon Web Services account. To learn how to + * increase your service quota, see Requesting a quota + * increase in the Service Quotas User Guide + *
+ *+ * Examples + *
+ *The max number of clusters or queues has been reached for the account.
+ *The max number of compute node groups has been reached for the associated + * cluster.
+ *The total of maxInstances across all compute node groups has been
+ * reached for associated cluster.
Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class UpdateComputeNodeGroupCommand extends $Command + .classBuilder< + UpdateComputeNodeGroupCommandInput, + UpdateComputeNodeGroupCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "UpdateComputeNodeGroup", {}) + .n("PCSClient", "UpdateComputeNodeGroupCommand") + .f(void 0, void 0) + .ser(se_UpdateComputeNodeGroupCommand) + .de(de_UpdateComputeNodeGroupCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/UpdateQueueCommand.ts b/clients/client-pcs/src/commands/UpdateQueueCommand.ts new file mode 100644 index 000000000000..4ba165021a38 --- /dev/null +++ b/clients/client-pcs/src/commands/UpdateQueueCommand.ts @@ -0,0 +1,209 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateQueueRequest, UpdateQueueResponse } from "../models/models_0"; +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; +import { de_UpdateQueueCommand, se_UpdateQueueCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateQueueCommand}. + */ +export interface UpdateQueueCommandInput extends UpdateQueueRequest {} +/** + * @public + * + * The output of {@link UpdateQueueCommand}. + */ +export interface UpdateQueueCommandOutput extends UpdateQueueResponse, __MetadataBearer {} + +/** + *Updates the compute node group configuration of a queue. Use this API to change the + * compute node groups that the queue can send jobs to.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PCSClient, UpdateQueueCommand } from "@aws-sdk/client-pcs"; // ES Modules import + * // const { PCSClient, UpdateQueueCommand } = require("@aws-sdk/client-pcs"); // CommonJS import + * const client = new PCSClient(config); + * const input = { // UpdateQueueRequest + * clusterIdentifier: "STRING_VALUE", // required + * queueIdentifier: "STRING_VALUE", // required + * computeNodeGroupConfigurations: [ // ComputeNodeGroupConfigurationList + * { // ComputeNodeGroupConfiguration + * computeNodeGroupId: "STRING_VALUE", + * }, + * ], + * clientToken: "STRING_VALUE", + * }; + * const command = new UpdateQueueCommand(input); + * const response = await client.send(command); + * // { // UpdateQueueResponse + * // queue: { // Queue + * // name: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // clusterId: "STRING_VALUE", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), // required + * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED", // required + * // computeNodeGroupConfigurations: [ // ComputeNodeGroupConfigurationList // required + * // { // ComputeNodeGroupConfiguration + * // computeNodeGroupId: "STRING_VALUE", + * // }, + * // ], + * // errorInfo: [ // ErrorInfoList + * // { // ErrorInfo + * // code: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // ], + * // }, + * // }; + * + * ``` + * + * @param UpdateQueueCommandInput - {@link UpdateQueueCommandInput} + * @returns {@link UpdateQueueCommandOutput} + * @see {@link UpdateQueueCommandInput} for command's `input` shape. + * @see {@link UpdateQueueCommandOutput} for command's `response` shape. + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *Amazon Web Services PCS can't process your request right now. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You exceeded your service quota. Service quotas, also referred to as limits, are the + * maximum number of service resources or operations for your Amazon Web Services account. To learn how to + * increase your service quota, see Requesting a quota + * increase in the Service Quotas User Guide + *
+ *+ * Examples + *
+ *The max number of clusters or queues has been reached for the account.
+ *The max number of compute node groups has been reached for the associated + * cluster.
+ *The total of maxInstances across all compute node groups has been
+ * reached for associated cluster.
Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
Base exception class for all service exceptions from PCS service.
+ * + * @public + */ +export class UpdateQueueCommand extends $Command + .classBuilder< + UpdateQueueCommandInput, + UpdateQueueCommandOutput, + PCSClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSParallelComputingService", "UpdateQueue", {}) + .n("PCSClient", "UpdateQueueCommand") + .f(void 0, void 0) + .ser(se_UpdateQueueCommand) + .de(de_UpdateQueueCommand) + .build() {} diff --git a/clients/client-pcs/src/commands/index.ts b/clients/client-pcs/src/commands/index.ts new file mode 100644 index 000000000000..43400ee0df05 --- /dev/null +++ b/clients/client-pcs/src/commands/index.ts @@ -0,0 +1,19 @@ +// smithy-typescript generated code +export * from "./CreateClusterCommand"; +export * from "./CreateComputeNodeGroupCommand"; +export * from "./CreateQueueCommand"; +export * from "./DeleteClusterCommand"; +export * from "./DeleteComputeNodeGroupCommand"; +export * from "./DeleteQueueCommand"; +export * from "./GetClusterCommand"; +export * from "./GetComputeNodeGroupCommand"; +export * from "./GetQueueCommand"; +export * from "./ListClustersCommand"; +export * from "./ListComputeNodeGroupsCommand"; +export * from "./ListQueuesCommand"; +export * from "./ListTagsForResourceCommand"; +export * from "./RegisterComputeNodeGroupInstanceCommand"; +export * from "./TagResourceCommand"; +export * from "./UntagResourceCommand"; +export * from "./UpdateComputeNodeGroupCommand"; +export * from "./UpdateQueueCommand"; diff --git a/clients/client-pcs/src/endpoint/EndpointParameters.ts b/clients/client-pcs/src/endpoint/EndpointParameters.ts new file mode 100644 index 000000000000..e538409b8469 --- /dev/null +++ b/clients/client-pcs/src/endpoint/EndpointParameters.ts @@ -0,0 +1,41 @@ +// smithy-typescript generated code +import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types"; + +/** + * @public + */ +export interface ClientInputEndpointParameters { + region?: string | ProviderAmazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for + * you to run and scale your high performance computing (HPC) workloads, + * and build scientific and engineering models on Amazon Web Services using Slurm. + * For more information, see + * the Amazon Web Services Parallel Computing Service + * User Guide.
+ *This reference describes the actions and data types of the service management API. You can use the + * Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API + * actions manually. These API actions manage the service through an Amazon Web Services account.
+ *The API actions operate on Amazon Web Services PCS resources. A resource is + * an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use + * the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute + * node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.
+ *An Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch + * compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch + * compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. + * Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources + * related to those compute nodes.
+ * + * @packageDocumentation + */ +export * from "./PCSClient"; +export * from "./PCS"; +export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; +export type { RuntimeExtension } from "./runtimeExtensions"; +export type { PCSExtensionConfiguration } from "./extensionConfiguration"; +export * from "./commands"; +export * from "./pagination"; +export * from "./models"; + +export { PCSServiceException } from "./models/PCSServiceException"; diff --git a/clients/client-pcs/src/models/PCSServiceException.ts b/clients/client-pcs/src/models/PCSServiceException.ts new file mode 100644 index 000000000000..9fc5f9f7be1f --- /dev/null +++ b/clients/client-pcs/src/models/PCSServiceException.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@smithy/smithy-client"; + +export type { __ServiceExceptionOptions }; + +export { __ServiceException }; + +/** + * @public + * + * Base exception class for all service exceptions from PCS service. + */ +export class PCSServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, PCSServiceException.prototype); + } +} diff --git a/clients/client-pcs/src/models/index.ts b/clients/client-pcs/src/models/index.ts new file mode 100644 index 000000000000..9eaceb12865f --- /dev/null +++ b/clients/client-pcs/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-pcs/src/models/models_0.ts b/clients/client-pcs/src/models/models_0.ts new file mode 100644 index 000000000000..88ecfa77267f --- /dev/null +++ b/clients/client-pcs/src/models/models_0.ts @@ -0,0 +1,2156 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; + +import { PCSServiceException as __BaseException } from "./PCSServiceException"; + +/** + *You don't have permission to perform the action.
+ *+ * Examples + *
+ *The launch template instance profile doesn't pass iam:PassRole
+ * verification.
There is a mismatch between the account ID and cluster ID.
+ *The cluster ID doesn't exist.
+ *The EC2 instance isn't present.
+ *Your request has conflicting operations. This can occur if you're trying to perform more + * than 1 operation on the same resource at the same time.
+ *+ * Examples + *
+ *A cluster with the same name already exists.
+ *A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has
+ * ACTIVE node groups or queues.
A queue already exists in a cluster.
+ *+ * The unique identifier of the resource that caused the conflict exception. + *
+ * @public + */ + resourceId: string | undefined; + + /** + *+ * The type or category of the resource that caused the conflict exception." + *
+ * @public + */ + resourceType: string | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeAn Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.
+ * @public + */ +export interface CustomLaunchTemplate { + /** + *The ID of the EC2 launch template to use to provision instances.
+ * Example: lt-xxxx
+ *
The version of the EC2 launch template to use to provision instances.
+ * @public + */ + version: string | undefined; +} + +/** + *An EC2 instance configuration Amazon Web Services PCS uses to launch compute nodes.
+ * @public + */ +export interface InstanceConfig { + /** + *The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.
+ * Example: t2.xlarge
+ *
Specifies the boundaries of the compute node group auto scaling.
+ * @public + */ +export interface ScalingConfigurationRequest { + /** + *The lower bound of the number of instances allowed in the compute fleet.
+ * @public + */ + minInstanceCount: number | undefined; + + /** + *The upper bound of the number of instances allowed in the compute fleet.
+ * @public + */ + maxInstanceCount: number | undefined; +} + +/** + *Additional settings that directly map to Slurm settings.
+ * @public + */ +export interface SlurmCustomSetting { + /** + *Amazon Web Services PCS supports configuration of the following Slurm parameters:
+ * Prolog
+ * ,
+ * Epilog
+ * , and
+ * SelectTypeParameters
+ * .
The values for the configured Slurm settings.
+ * @public + */ + parameterValue: string | undefined; +} + +/** + *Additional options related to the Slurm scheduler.
+ * @public + */ +export interface ComputeNodeGroupSlurmConfigurationRequest { + /** + *Additional Slurm-specific configuration that directly maps to Slurm settings.
+ * @public + */ + slurmCustomSettings?: SlurmCustomSetting[]; +} + +/** + * @public + * @enum + */ +export const SpotAllocationStrategy = { + CAPACITY_OPTIMIZED: "capacity-optimized", + LOWEST_PRICE: "lowest-price", + PRICE_CAPACITY_OPTIMIZED: "price-capacity-optimized", +} as const; + +/** + * @public + */ +export type SpotAllocationStrategy = (typeof SpotAllocationStrategy)[keyof typeof SpotAllocationStrategy]; + +/** + *Additional configuration when you specify SPOT as the
+ * purchaseOption for the CreateComputeNodeGroup API action.
The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. + * Amazon Web Services PCS supports lowest price, + * capacity optimized, and + * price capacity optimized. + * For more information, see Use + * allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand + * capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, + * it defaults to price capacity optimized.
+ * @public + */ + allocationStrategy?: SpotAllocationStrategy; +} + +/** + * @public + */ +export interface CreateComputeNodeGroupRequest { + /** + *The name or ID of the cluster to create a compute node group in.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *A name to identify the cluster. Example: MyCluster
+ *
The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes + * (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified + * in the custom launch template.
+ * @public + */ + amiId?: string; + + /** + *The list of subnet IDs where the compute node group launches instances. + * Subnets must be in the same VPC as the cluster.
+ * @public + */ + subnetIds: string[] | undefined; + + /** + *Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand + * and Spot instances. For more information, see Instance + * purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this + * option, it defaults to On-Demand.
+ * @public + */ + purchaseOption?: PurchaseOption; + + /** + *An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.
+ * @public + */ + customLaunchTemplate: CustomLaunchTemplate | undefined; + + /** + *The Amazon Resource Name (ARN) of the
+ * IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
+ * pcs:RegisterComputeNodeGroupInstance permissions attached in order to
+ * provision instances correctly. The resource identifier of the ARN must start with
+ * AWSPCS. For example, arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile.
+ *
Specifies the boundaries of the compute node group auto scaling.
+ * @public + */ + scalingConfiguration: ScalingConfigurationRequest | undefined; + + /** + *A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
+ * @public + */ + instanceConfigs: InstanceConfig[] | undefined; + + /** + *Additional configuration when you specify SPOT as the
+ * purchaseOption for the CreateComputeNodeGroup API action.
Additional options related to the Slurm scheduler.
+ * @public + */ + slurmConfiguration?: ComputeNodeGroupSlurmConfigurationRequest; + + /** + *A unique, case-sensitive identifier that you provide to + * ensure the idempotency of the request. Idempotency ensures that an API + * request completes only once. With an idempotent request, if the original + * request completes successfully, the subsequent retries with the same + * client token return the result from the original successful request and + * they have no additional effect. If you don't specify a client token, the + * CLI and SDK automatically generate 1 for you.
+ * @public + */ + clientToken?: string; + + /** + *1 or more tags added to the resource. Each tag consists of a + * tag key and tag value. The tag value is optional and can be an empty + * string.
+ * @public + */ + tags?: RecordAn error that occurred during resource creation.
+ * @public + */ +export interface ErrorInfo { + /** + *The short-form error code.
+ * @public + */ + code?: string; + + /** + *The detailed error information.
+ * @public + */ + message?: string; +} + +/** + *Specifies the boundaries of the compute node group auto scaling.
+ * @public + */ +export interface ScalingConfiguration { + /** + *The lower bound of the number of instances allowed in the compute fleet.
+ * @public + */ + minInstanceCount: number | undefined; + + /** + *The upper bound of the number of instances allowed in the compute fleet.
+ * @public + */ + maxInstanceCount: number | undefined; +} + +/** + *Additional options related to the Slurm scheduler.
+ * @public + */ +export interface ComputeNodeGroupSlurmConfiguration { + /** + *Additional Slurm-specific configuration that directly maps to Slurm settings.
+ * @public + */ + slurmCustomSettings?: SlurmCustomSetting[]; +} + +/** + * @public + * @enum + */ +export const ComputeNodeGroupStatus = { + ACTIVE: "ACTIVE", + CREATE_FAILED: "CREATE_FAILED", + CREATING: "CREATING", + DELETED: "DELETED", + DELETE_FAILED: "DELETE_FAILED", + DELETING: "DELETING", + UPDATE_FAILED: "UPDATE_FAILED", + UPDATING: "UPDATING", +} as const; + +/** + * @public + */ +export type ComputeNodeGroupStatus = (typeof ComputeNodeGroupStatus)[keyof typeof ComputeNodeGroupStatus]; + +/** + *A compute node group associated with a cluster.
+ * @public + */ +export interface ComputeNodeGroup { + /** + *The name that identifies the compute node group.
+ * @public + */ + name: string | undefined; + + /** + *The generated unique ID of the compute node group.
+ * @public + */ + id: string | undefined; + + /** + *The unique Amazon Resource Name (ARN) of the compute node group.
+ * @public + */ + arn: string | undefined; + + /** + *The ID of the cluster of the compute node group.
+ * @public + */ + clusterId: string | undefined; + + /** + *The date and time the resource was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The date and time the resource was modified.
+ * @public + */ + modifiedAt: Date | undefined; + + /** + *The provisioning status of the compute node group.
+ *The provisioning status doesn't indicate the overall health of the compute node + * group.
+ *The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. + * If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
+ * @public + */ + amiId?: string; + + /** + *The list of subnet IDs where instances are provisioned by the compute node group. + * The subnets must be in the same VPC as the cluster.
+ * @public + */ + subnetIds: string[] | undefined; + + /** + *Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand + * and Spot instances. For more information, see Instance + * purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this + * option, it defaults to On-Demand.
+ * @public + */ + purchaseOption?: PurchaseOption; + + /** + *An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.
+ * @public + */ + customLaunchTemplate: CustomLaunchTemplate | undefined; + + /** + *The Amazon Resource Name (ARN) of the
+ * IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
+ * pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances
+ * correctly.
Specifies the boundaries of the compute node group auto scaling.
+ * @public + */ + scalingConfiguration: ScalingConfiguration | undefined; + + /** + *A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
+ * @public + */ + instanceConfigs: InstanceConfig[] | undefined; + + /** + *Additional configuration when you specify SPOT as the
+ * purchaseOption for the CreateComputeNodeGroup API action.
Additional options related to the Slurm scheduler.
+ * @public + */ + slurmConfiguration?: ComputeNodeGroupSlurmConfiguration; + + /** + *The list of errors that occurred during compute node group provisioning.
+ * @public + */ + errorInfo?: ErrorInfo[]; +} + +/** + * @public + */ +export interface CreateComputeNodeGroupResponse { + /** + *A compute node group associated with a cluster.
+ * @public + */ + computeNodeGroup?: ComputeNodeGroup; +} + +/** + *Amazon Web Services PCS can't process your request right now. Try again later.
+ * @public + */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + $retryable = {}; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe requested resource can't be found. The cluster, node group, or queue you're + * attempting to get, update, list, or delete doesn't exist.
+ *+ * Examples + *
+ * @public + */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + *+ * The unique identifier of the resource that was not found. + *
+ * @public + */ + resourceId: string | undefined; + + /** + *+ * The type or category of the resource that was not found. + *
+ * @public + */ + resourceType: string | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeYou exceeded your service quota. Service quotas, also referred to as limits, are the + * maximum number of service resources or operations for your Amazon Web Services account. To learn how to + * increase your service quota, see Requesting a quota + * increase in the Service Quotas User Guide + *
+ *+ * Examples + *
+ *The max number of clusters or queues has been reached for the account.
+ *The max number of compute node groups has been reached for the associated + * cluster.
+ *The total of maxInstances across all compute node groups has been
+ * reached for associated cluster.
+ * The service code associated with the quota that was exceeded. + *
+ * @public + */ + serviceCode: string | undefined; + + /** + *+ * The unique identifier of the resource that caused the quota to be exceeded. + *
+ * @public + */ + resourceId?: string; + + /** + *+ * The type or category of the resource that caused the quota to be exceeded. + *
+ * @public + */ + resourceType?: string; + + /** + *+ * The quota code of the service quota that was exceeded. + *
+ * @public + */ + quotaCode?: string; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeYour request exceeded a request rate quota. Check the resource's request rate quota and try again.
+ * @public + */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + $retryable = {}; + /** + *+ * The number of seconds to wait before retrying the request. + *
+ * @public + */ + retryAfterSeconds?: number; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeStores information about a field in a request that caused an exception.
+ * @public + */ +export interface ValidationExceptionField { + /** + *The name of the exception.
+ * @public + */ + name: string | undefined; + + /** + *The message body of the exception.
+ * @public + */ + message: string | undefined; +} + +/** + * @public + * @enum + */ +export const ValidationExceptionReason = { + CANNOT_PARSE: "cannotParse", + FIELD_VALIDATION_FAILED: "fieldValidationFailed", + OTHER: "other", + UNKNOWN_OPERATION: "unknownOperation", +} as const; + +/** + * @public + */ +export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason]; + +/** + *The request isn't valid.
+ *+ * Examples + *
+ *Your request contains malformed JSON or unsupported characters.
+ *The scheduler version isn't supported.
+ *There are networking related errors, such as network validation failure.
+ *AMI type is CUSTOM and the launch template doesn't define the AMI ID,
+ * or the AMI type is AL2 and the launch template defines the AMI.
+ * The specific reason or cause of the validation error. + *
+ * @public + */ + reason: ValidationExceptionReason | undefined; + + /** + *+ * A list of fields or properties that failed validation. + *
+ * @public + */ + fieldList?: ValidationExceptionField[]; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe name or ID of the cluster of the compute node group.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *The name or ID of the compute node group to delete.
+ * @public + */ + computeNodeGroupIdentifier: string | undefined; + + /** + *A unique, case-sensitive identifier that you provide to + * ensure the idempotency of the request. Idempotency ensures that an API + * request completes only once. With an idempotent request, if the original + * request completes successfully, the subsequent retries with the same + * client token return the result from the original successful request and + * they have no additional effect. If you don't specify a client token, the + * CLI and SDK automatically generate 1 for you.
+ * @public + */ + clientToken?: string; +} + +/** + * @public + */ +export interface DeleteComputeNodeGroupResponse {} + +/** + * @public + */ +export interface GetComputeNodeGroupRequest { + /** + *The name or ID of the cluster.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *The name or ID of the compute node group.
+ * @public + */ + computeNodeGroupIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetComputeNodeGroupResponse { + /** + *A compute node group associated with a cluster.
+ * @public + */ + computeNodeGroup?: ComputeNodeGroup; +} + +/** + * @public + */ +export interface ListComputeNodeGroupsRequest { + /** + *The name or ID of the cluster to list compute node groups for.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *The value of nextToken is a unique pagination token
+ * for each page of results returned. If nextToken is returned, there are more
+ * results available. Make the call again using the returned token to retrieve the next page.
+ * Keep all other arguments unchanged. Each pagination token expires after 24 hours.
+ * Using an expired pagination token returns an HTTP 400 InvalidToken
+ * error.
The maximum number of results that are returned per call.
+ * You can use nextToken to obtain further pages of results. The default
+ * is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses
+ * the default.
The object returned by the ListComputeNodeGroups API action.
The name that identifies the compute node group.
+ * @public + */ + name: string | undefined; + + /** + *The generated unique ID of the compute node group.
+ * @public + */ + id: string | undefined; + + /** + *The unique Amazon Resource Name (ARN) of the compute node group.
+ * @public + */ + arn: string | undefined; + + /** + *The ID of the cluster of the compute node group.
+ * @public + */ + clusterId: string | undefined; + + /** + *The date and time the resource was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The date and time the resource was modified.
+ * @public + */ + modifiedAt: Date | undefined; + + /** + *The provisioning status of the compute node group.
+ *The provisioning status doesn't indicate the overall health of the compute node + * group.
+ *The list of compute node groups for the cluster.
+ * @public + */ + computeNodeGroups: ComputeNodeGroupSummary[] | undefined; + + /** + *The value of nextToken is a unique pagination token
+ * for each page of results returned. If nextToken is returned, there are more
+ * results available. Make the call again using the returned token to retrieve the next page.
+ * Keep all other arguments unchanged. Each pagination token expires after 24 hours.
+ * Using an expired pagination token returns an HTTP 400 InvalidToken
+ * error.
Additional options related to the Slurm scheduler.
+ * @public + */ +export interface UpdateComputeNodeGroupSlurmConfigurationRequest { + /** + *Additional Slurm-specific configuration that directly maps to Slurm settings.
+ * @public + */ + slurmCustomSettings?: SlurmCustomSetting[]; +} + +/** + * @public + */ +export interface UpdateComputeNodeGroupRequest { + /** + *The name or ID of the cluster of the compute node group.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *The name or ID of the compute node group.
+ * @public + */ + computeNodeGroupIdentifier: string | undefined; + + /** + *The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. + * If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch + * template.
+ * @public + */ + amiId?: string; + + /** + *The list of subnet IDs where the compute node group provisions instances. + * The subnets must be in the same VPC as the cluster.
+ * @public + */ + subnetIds?: string[]; + + /** + *An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.
+ * @public + */ + customLaunchTemplate?: CustomLaunchTemplate; + + /** + *Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand + * and Spot instances. For more information, see Instance + * purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this + * option, it defaults to On-Demand.
+ * @public + */ + purchaseOption?: PurchaseOption; + + /** + *Additional configuration when you specify SPOT as the
+ * purchaseOption for the CreateComputeNodeGroup API action.
Specifies the boundaries of the compute node group auto scaling.
+ * @public + */ + scalingConfiguration?: ScalingConfigurationRequest; + + /** + *The Amazon Resource Name (ARN) of the
+ * IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
+ * pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances
+ * correctly.
Additional options related to the Slurm scheduler.
+ * @public + */ + slurmConfiguration?: UpdateComputeNodeGroupSlurmConfigurationRequest; + + /** + *A unique, case-sensitive identifier that you provide to + * ensure the idempotency of the request. Idempotency ensures that an API + * request completes only once. With an idempotent request, if the original + * request completes successfully, the subsequent retries with the same + * client token return the result from the original successful request and + * they have no additional effect. If you don't specify a client token, the + * CLI and SDK automatically generate 1 for you.
+ * @public + */ + clientToken?: string; +} + +/** + * @public + */ +export interface UpdateComputeNodeGroupResponse { + /** + *A compute node group associated with a cluster.
+ * @public + */ + computeNodeGroup?: ComputeNodeGroup; +} + +/** + *The networking configuration for the cluster's control plane.
+ * @public + */ +export interface NetworkingRequest { + /** + *The list of subnet IDs where Amazon Web Services PCS creates an
+ * Elastic Network Interface (ENI) to enable communication between managed controllers
+ * and Amazon Web Services PCS resources. Subnet IDs have the form subnet-0123456789abcdef0.
Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.
+ *Amazon Web Services PCS currently supports only 1 subnet in this list.
+ *A list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
+ * @public + */ + securityGroupIds?: string[]; +} + +/** + * @public + * @enum + */ +export const SchedulerType = { + SLURM: "SLURM", +} as const; + +/** + * @public + */ +export type SchedulerType = (typeof SchedulerType)[keyof typeof SchedulerType]; + +/** + *The cluster management and job scheduling software associated with the cluster.
+ * @public + */ +export interface SchedulerRequest { + /** + *The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
+ * @public + */ + type: SchedulerType | undefined; + + /** + *The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
+ * @public + */ + version: string | undefined; +} + +/** + * @public + * @enum + */ +export const Size = { + LARGE: "LARGE", + MEDIUM: "MEDIUM", + SMALL: "SMALL", +} as const; + +/** + * @public + */ +export type Size = (typeof Size)[keyof typeof Size]; + +/** + *Additional options related to the Slurm scheduler.
+ * @public + */ +export interface ClusterSlurmConfigurationRequest { + /** + *The time before an idle node is scaled down.
+ * @public + */ + scaleDownIdleTimeInSeconds?: number; + + /** + *Additional Slurm-specific configuration that directly maps to Slurm settings.
+ * @public + */ + slurmCustomSettings?: SlurmCustomSetting[]; +} + +/** + * @public + */ +export interface CreateClusterRequest { + /** + *A name to identify the cluster. Example: MyCluster
+ *
The cluster management and job scheduling software associated with the cluster.
+ * @public + */ + scheduler: SchedulerRequest | undefined; + + /** + *A value that determines the maximum number of compute nodes in the cluster and the + * maximum number of jobs (active and queued).
+ *
+ * SMALL: 32 compute nodes and 256 jobs
+ * MEDIUM: 512 compute nodes and 8192 jobs
+ * LARGE: 2048 compute nodes and 16,384 jobs
The networking configuration used to set up the cluster's control plane.
+ * @public + */ + networking: NetworkingRequest | undefined; + + /** + *Additional options related to the Slurm scheduler.
+ * @public + */ + slurmConfiguration?: ClusterSlurmConfigurationRequest; + + /** + *A unique, case-sensitive identifier that you provide to + * ensure the idempotency of the request. Idempotency ensures that an API + * request completes only once. With an idempotent request, if the original + * request completes successfully, the subsequent retries with the same + * client token return the result from the original successful request and + * they have no additional effect. If you don't specify a client token, the + * CLI and SDK automatically generate 1 for you.
+ * @public + */ + clientToken?: string; + + /** + *1 or more tags added to the resource. Each tag consists of a + * tag key and tag value. The tag value is optional and can be an empty + * string.
+ * @public + */ + tags?: RecordAn endpoint available for interaction with the scheduler.
+ * @public + */ +export interface Endpoint { + /** + *Indicates the type of endpoint running at the specific IP address.
+ * @public + */ + type: EndpointType | undefined; + + /** + *The endpoint's private IP address.
+ *Example: 2.2.2.2
+ *
The endpoint's public IP address.
+ *Example: 1.1.1.1
+ *
The endpoint's connection port number.
+ * Example: 1234
+ *
The networking configuration for the cluster's control plane.
+ * @public + */ +export interface Networking { + /** + *The ID of the subnet where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to + * enable communication between managed controllers and Amazon Web Services PCS resources. The subnet must + * have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS + * Local Zone.
+ * Example: subnet-abcd1234
+ *
The list of security group IDs associated + * with the Elastic Network Interface (ENI) created in subnets.
+ *The following rules are required:
+ *Inbound rule 1
+ *Protocol: All
+ *Ports: All
+ *Source: Self
+ *Outbound rule 1
+ *Protocol: All
+ *Ports: All
+ *Destination: 0.0.0.0/0 (IPv4)
+ *Outbound rule 2
+ *Protocol: All
+ *Ports: All
+ *Destination: Self
+ *The cluster management and job scheduling software associated with the cluster.
+ * @public + */ +export interface Scheduler { + /** + *The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
+ * @public + */ + type: SchedulerType | undefined; + + /** + *The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
+ * @public + */ + version: string | undefined; +} + +/** + *The shared Slurm key for authentication, also known as the cluster secret.
+ * @public + */ +export interface SlurmAuthKey { + /** + *The Amazon Resource Name (ARN) of the the shared Slurm key.
+ * @public + */ + secretArn: string | undefined; + + /** + *The version of the shared Slurm key.
+ * @public + */ + secretVersion: string | undefined; +} + +/** + *Additional options related to the Slurm scheduler.
+ * @public + */ +export interface ClusterSlurmConfiguration { + /** + *The time before an idle node is scaled down.
+ * @public + */ + scaleDownIdleTimeInSeconds?: number; + + /** + *Additional Slurm-specific configuration that directly maps to Slurm settings.
+ * @public + */ + slurmCustomSettings?: SlurmCustomSetting[]; + + /** + *The shared Slurm key for authentication, also known as the cluster secret.
+ * @public + */ + authKey?: SlurmAuthKey; +} + +/** + * @public + * @enum + */ +export const ClusterStatus = { + ACTIVE: "ACTIVE", + CREATE_FAILED: "CREATE_FAILED", + CREATING: "CREATING", + DELETE_FAILED: "DELETE_FAILED", + DELETING: "DELETING", + UPDATE_FAILED: "UPDATE_FAILED", + UPDATING: "UPDATING", +} as const; + +/** + * @public + */ +export type ClusterStatus = (typeof ClusterStatus)[keyof typeof ClusterStatus]; + +/** + *The cluster resource and configuration.
+ * @public + */ +export interface Cluster { + /** + *The name that identifies the cluster.
+ * @public + */ + name: string | undefined; + + /** + *The generated unique ID of the cluster.
+ * @public + */ + id: string | undefined; + + /** + *The unique Amazon Resource Name (ARN) of the cluster.
+ * @public + */ + arn: string | undefined; + + /** + *The provisioning status of the cluster.
+ *The provisioning status doesn't indicate the overall health of the cluster.
+ *The date and time the resource was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The date and time the resource was modified.
+ * @public + */ + modifiedAt: Date | undefined; + + /** + *The cluster management and job scheduling software associated with the cluster.
+ * @public + */ + scheduler: Scheduler | undefined; + + /** + *The size of the cluster.
+ *
+ * SMALL: 32 compute nodes and 256 jobs
+ * MEDIUM: 512 compute nodes and 8192 jobs
+ * LARGE: 2048 compute nodes and 16,384 jobs
Additional options related to the Slurm scheduler.
+ * @public + */ + slurmConfiguration?: ClusterSlurmConfiguration; + + /** + *The networking configuration for the cluster's control plane.
+ * @public + */ + networking: Networking | undefined; + + /** + *The list of endpoints available for interaction with the scheduler.
+ * @public + */ + endpoints?: Endpoint[]; + + /** + *The list of errors that occurred during cluster provisioning.
+ * @public + */ + errorInfo?: ErrorInfo[]; +} + +/** + * @public + */ +export interface CreateClusterResponse { + /** + *The cluster resource.
+ * @public + */ + cluster?: Cluster; +} + +/** + * @public + */ +export interface DeleteClusterRequest { + /** + *The name or ID of the cluster to delete.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *A unique, case-sensitive identifier that you provide to + * ensure the idempotency of the request. Idempotency ensures that an API + * request completes only once. With an idempotent request, if the original + * request completes successfully, the subsequent retries with the same + * client token return the result from the original successful request and + * they have no additional effect. If you don't specify a client token, the + * CLI and SDK automatically generate 1 for you.
+ * @public + */ + clientToken?: string; +} + +/** + * @public + */ +export interface DeleteClusterResponse {} + +/** + * @public + */ +export interface GetClusterRequest { + /** + *The name or ID of the cluster of the queue.
+ * @public + */ + clusterIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetClusterResponse { + /** + *The cluster resource.
+ * @public + */ + cluster?: Cluster; +} + +/** + * @public + */ +export interface ListClustersRequest { + /** + *The value of nextToken is a unique pagination token
+ * for each page of results returned. If nextToken is returned, there are more
+ * results available. Make the call again using the returned token to retrieve the next page.
+ * Keep all other arguments unchanged. Each pagination token expires after 24 hours.
+ * Using an expired pagination token returns an HTTP 400 InvalidToken
+ * error.
The maximum number of results that are returned per call.
+ * You can use nextToken to obtain further pages of results. The default
+ * is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses
+ * the default.
The object returned by the ListClusters API action.
The name that identifies the cluster.
+ * @public + */ + name: string | undefined; + + /** + *The generated unique ID of the cluster.
+ * @public + */ + id: string | undefined; + + /** + *The unique Amazon Resource Name (ARN) of the cluster.
+ * @public + */ + arn: string | undefined; + + /** + *The date and time the resource was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The date and time the resource was modified.
+ * @public + */ + modifiedAt: Date | undefined; + + /** + *The provisioning status of the cluster.
+ *The provisioning status doesn't indicate the overall health of the cluster.
+ *The list of clusters.
+ * @public + */ + clusters: ClusterSummary[] | undefined; + + /** + *The value of nextToken is a unique pagination token
+ * for each page of results returned. If nextToken is returned, there are more
+ * results available. Make the call again using the returned token to retrieve the next page.
+ * Keep all other arguments unchanged. Each pagination token expires after 24 hours.
+ * Using an expired pagination token returns an HTTP 400 InvalidToken
+ * error.
The compute node group configuration for a queue.
+ * @public + */ +export interface ComputeNodeGroupConfiguration { + /** + *The compute node group ID for the compute node group configuration.
+ * @public + */ + computeNodeGroupId?: string; +} + +/** + * @public + */ +export interface CreateQueueRequest { + /** + *The name or ID of the cluster for which to create a queue.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *A name to identify the queue.
+ * @public + */ + queueName: string | undefined; + + /** + *The list of compute node group configurations to associate with the queue. Queues + * assign jobs to associated compute node groups.
+ * @public + */ + computeNodeGroupConfigurations?: ComputeNodeGroupConfiguration[]; + + /** + *A unique, case-sensitive identifier that you provide to + * ensure the idempotency of the request. Idempotency ensures that an API + * request completes only once. With an idempotent request, if the original + * request completes successfully, the subsequent retries with the same + * client token return the result from the original successful request and + * they have no additional effect. If you don't specify a client token, the + * CLI and SDK automatically generate 1 for you.
+ * @public + */ + clientToken?: string; + + /** + *1 or more tags added to the resource. Each tag consists of a + * tag key and tag value. The tag value is optional and can be an empty + * string.
+ * @public + */ + tags?: RecordA queue resource.
+ * @public + */ +export interface Queue { + /** + *The name that identifies the queue.
+ * @public + */ + name: string | undefined; + + /** + *The generated unique ID of the queue.
+ * @public + */ + id: string | undefined; + + /** + *The unique Amazon Resource Name (ARN) of the queue.
+ * @public + */ + arn: string | undefined; + + /** + *The ID of the cluster of the queue.
+ * @public + */ + clusterId: string | undefined; + + /** + *The date and time the resource was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The date and time the resource was modified.
+ * @public + */ + modifiedAt: Date | undefined; + + /** + *The provisioning status of the queue.
+ *The provisioning status doesn't indicate the overall health of the queue.
+ *The list of compute node group configurations associated with the queue. Queues + * assign jobs to associated compute node groups.
+ * @public + */ + computeNodeGroupConfigurations: ComputeNodeGroupConfiguration[] | undefined; + + /** + *The list of errors that occurred during queue provisioning.
+ * @public + */ + errorInfo?: ErrorInfo[]; +} + +/** + * @public + */ +export interface CreateQueueResponse { + /** + *A queue resource.
+ * @public + */ + queue?: Queue; +} + +/** + * @public + */ +export interface DeleteQueueRequest { + /** + *The name or ID of the cluster of the queue.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *The name or ID of the queue to delete.
+ * @public + */ + queueIdentifier: string | undefined; + + /** + *A unique, case-sensitive identifier that you provide to + * ensure the idempotency of the request. Idempotency ensures that an API + * request completes only once. With an idempotent request, if the original + * request completes successfully, the subsequent retries with the same + * client token return the result from the original successful request and + * they have no additional effect. If you don't specify a client token, the + * CLI and SDK automatically generate 1 for you.
+ * @public + */ + clientToken?: string; +} + +/** + * @public + */ +export interface DeleteQueueResponse {} + +/** + * @public + */ +export interface GetQueueRequest { + /** + *The name or ID of the cluster of the queue.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *The name or ID of the queue.
+ * @public + */ + queueIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetQueueResponse { + /** + *A queue resource.
+ * @public + */ + queue?: Queue; +} + +/** + * @public + */ +export interface ListQueuesRequest { + /** + *The name or ID of the cluster to list queues for.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *The value of nextToken is a unique pagination token
+ * for each page of results returned. If nextToken is returned, there are more
+ * results available. Make the call again using the returned token to retrieve the next page.
+ * Keep all other arguments unchanged. Each pagination token expires after 24 hours.
+ * Using an expired pagination token returns an HTTP 400 InvalidToken
+ * error.
The maximum number of results that are returned per call.
+ * You can use nextToken to obtain further pages of results. The default
+ * is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses
+ * the default.
The object returned by the ListQueues API action.
The name that identifies the queue.
+ * @public + */ + name: string | undefined; + + /** + *The generated unique ID of the queue.
+ * @public + */ + id: string | undefined; + + /** + *The unique Amazon Resource Name (ARN) of the queue.
+ * @public + */ + arn: string | undefined; + + /** + *The ID of the cluster of the queue.
+ * @public + */ + clusterId: string | undefined; + + /** + *The date and time the resource was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The date and time the resource was modified.
+ * @public + */ + modifiedAt: Date | undefined; + + /** + *The provisioning status of the queue.
+ *The provisioning status doesn't indicate the overall health of the queue.
+ *The list of queues associated with the cluster.
+ * @public + */ + queues: QueueSummary[] | undefined; + + /** + *The value of nextToken is a unique pagination token
+ * for each page of results returned. If nextToken is returned, there are more
+ * results available. Make the call again using the returned token to retrieve the next page.
+ * Keep all other arguments unchanged. Each pagination token expires after 24 hours.
+ * Using an expired pagination token returns an HTTP 400 InvalidToken
+ * error.
The name or ID of the cluster of the queue.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *The name or ID of the queue.
+ * @public + */ + queueIdentifier: string | undefined; + + /** + *The list of compute node group configurations to associate with the queue. Queues + * assign jobs to associated compute node groups.
+ * @public + */ + computeNodeGroupConfigurations?: ComputeNodeGroupConfiguration[]; + + /** + *A unique, case-sensitive identifier that you provide to + * ensure the idempotency of the request. Idempotency ensures that an API + * request completes only once. With an idempotent request, if the original + * request completes successfully, the subsequent retries with the same + * client token return the result from the original successful request and + * they have no additional effect. If you don't specify a client token, the + * CLI and SDK automatically generate 1 for you.
+ * @public + */ + clientToken?: string; +} + +/** + * @public + */ +export interface UpdateQueueResponse { + /** + *A queue resource.
+ * @public + */ + queue?: Queue; +} + +/** + * @public + */ +export interface RegisterComputeNodeGroupInstanceRequest { + /** + *The name or ID of the cluster to register the compute node group instance in.
+ * @public + */ + clusterIdentifier: string | undefined; + + /** + *The client-generated token to allow for retries.
+ * @public + */ + bootstrapId: string | undefined; +} + +/** + * @public + */ +export interface RegisterComputeNodeGroupInstanceResponse { + /** + *The scheduler node ID for this instance.
+ * @public + */ + nodeID: string | undefined; + + /** + *For the Slurm scheduler, this is the shared Munge key the scheduler uses to + * authenticate compute node group instances.
+ * @public + */ + sharedSecret: string | undefined; + + /** + *The list of endpoints available for interaction with the scheduler.
+ * @public + */ + endpoints: Endpoint[] | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceRequest { + /** + *The Amazon Resource Name (ARN) of the resource for which to list tags.
+ * @public + */ + resourceArn: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceResponse { + /** + *1 or more tags added to the resource. Each tag consists of a + * tag key and tag value. The tag value is optional and can be an empty + * string.
+ * @public + */ + tags?: RecordThe Amazon Resource Name (ARN) of the resource.
+ * @public + */ + resourceArn: string | undefined; + + /** + *1 or more tags added to the resource. Each tag consists of a + * tag key and tag value. The tag value is optional and can be an empty + * string.
+ * @public + */ + tags: RecordThe Amazon Resource Name (ARN) of the resource.
+ * @public + */ + resourceArn: string | undefined; + + /** + *1 or more tag keys to remove from the resource. Specify only tag keys and not tag + * values.
+ * @public + */ + tagKeys: string[] | undefined; +} + +/** + * @internal + */ +export const RegisterComputeNodeGroupInstanceResponseFilterSensitiveLog = ( + obj: RegisterComputeNodeGroupInstanceResponse +): any => ({ + ...obj, + ...(obj.sharedSecret && { sharedSecret: SENSITIVE_STRING }), +}); diff --git a/clients/client-pcs/src/pagination/Interfaces.ts b/clients/client-pcs/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..b22ef5bf625c --- /dev/null +++ b/clients/client-pcs/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { PCSClient } from "../PCSClient"; + +/** + * @public + */ +export interface PCSPaginationConfiguration extends PaginationConfiguration { + client: PCSClient; +} diff --git a/clients/client-pcs/src/pagination/ListClustersPaginator.ts b/clients/client-pcs/src/pagination/ListClustersPaginator.ts new file mode 100644 index 000000000000..94df87f0c060 --- /dev/null +++ b/clients/client-pcs/src/pagination/ListClustersPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListClustersCommand, + ListClustersCommandInput, + ListClustersCommandOutput, +} from "../commands/ListClustersCommand"; +import { PCSClient } from "../PCSClient"; +import { PCSPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListClusters: ( + config: PCSPaginationConfiguration, + input: ListClustersCommandInput, + ...rest: any[] +) => PaginatorAmazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for\n you to run and scale your high performance computing (HPC) workloads,\n and build scientific and engineering models on Amazon Web Services using Slurm. \n For more information, see \n the Amazon Web Services Parallel Computing Service\n User Guide.
\nThis reference describes the actions and data types of the service management API. You can use the\n Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API\n actions manually. These API actions manage the service through an Amazon Web Services account.
\nThe API actions operate on Amazon Web Services PCS resources. A resource is\n an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use\n the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute\n node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.
\nAn Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch\n compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch\n compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes.\n Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources\n related to those compute nodes.
", + "smithy.api#title": "AWS Parallel Computing Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pcs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pcs-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pcs.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pcs.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pcs-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pcs.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pcs-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pcs.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pcs-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pcs.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pcs.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.pcs#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You don't have permission to perform the action.
\n\n Examples\n
\nThe launch template instance profile doesn't pass iam:PassRole\n verification.
There is a mismatch between the account ID and cluster ID.
\nThe cluster ID doesn't exist.
\nThe EC2 instance isn't present.
\nThe name that identifies the cluster.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The generated unique ID of the cluster.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the cluster.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.pcs#ClusterStatus", + "traits": { + "smithy.api#documentation": "The provisioning status of the cluster.
\nThe provisioning status doesn't indicate the overall health of the cluster.
\nThe date and time the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "scheduler": { + "target": "com.amazonaws.pcs#Scheduler", + "traits": { + "smithy.api#required": {} + } + }, + "size": { + "target": "com.amazonaws.pcs#Size", + "traits": { + "smithy.api#documentation": "The size of the cluster.
\n\n SMALL: 32 compute nodes and 256 jobs
\n MEDIUM: 512 compute nodes and 8192 jobs
\n LARGE: 2048 compute nodes and 16,384 jobs
Additional options related to the Slurm scheduler.
" + } + }, + "networking": { + "target": "com.amazonaws.pcs#Networking", + "traits": { + "smithy.api#required": {} + } + }, + "endpoints": { + "target": "com.amazonaws.pcs#Endpoints", + "traits": { + "smithy.api#documentation": "The list of endpoints available for interaction with the scheduler.
" + } + }, + "errorInfo": { + "target": "com.amazonaws.pcs#ErrorInfoList", + "traits": { + "smithy.api#documentation": "The list of errors that occurred during cluster provisioning.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The cluster resource and configuration.
" + } + }, + "com.amazonaws.pcs#ClusterIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,40})$" + } + }, + "com.amazonaws.pcs#ClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#ClusterSummary" + } + }, + "com.amazonaws.pcs#ClusterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + }, + "smithy.api#pattern": "^(?!pcs_)^(?![A-Za-z0-9]{10}$)[A-Za-z][A-Za-z0-9-]+$" + } + }, + "com.amazonaws.pcs#ClusterResource": { + "type": "resource", + "identifiers": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier" + } + }, + "create": { + "target": "com.amazonaws.pcs#CreateCluster" + }, + "operations": [ + { + "target": "com.amazonaws.pcs#DeleteCluster" + }, + { + "target": "com.amazonaws.pcs#GetCluster" + }, + { + "target": "com.amazonaws.pcs#RegisterComputeNodeGroupInstance" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.pcs#ListClusters" + } + ], + "resources": [ + { + "target": "com.amazonaws.pcs#ComputeNodeGroupResource" + }, + { + "target": "com.amazonaws.pcs#QueueResource" + } + ], + "traits": { + "aws.api#arn": { + "template": "cluster/{clusterIdentifier}" + }, + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#iamResource": { + "name": "cluster" + } + } + }, + "com.amazonaws.pcs#ClusterSlurmConfiguration": { + "type": "structure", + "members": { + "scaleDownIdleTimeInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The time before an idle node is scaled down.
", + "smithy.api#range": { + "min": 1 + } + } + }, + "slurmCustomSettings": { + "target": "com.amazonaws.pcs#SlurmCustomSettings", + "traits": { + "smithy.api#documentation": "Additional Slurm-specific configuration that directly maps to Slurm settings.
" + } + }, + "authKey": { + "target": "com.amazonaws.pcs#SlurmAuthKey", + "traits": { + "smithy.api#documentation": "The shared Slurm key for authentication, also known as the cluster secret.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional options related to the Slurm scheduler.
" + } + }, + "com.amazonaws.pcs#ClusterSlurmConfigurationRequest": { + "type": "structure", + "members": { + "scaleDownIdleTimeInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The time before an idle node is scaled down.
", + "smithy.api#range": { + "min": 1 + } + } + }, + "slurmCustomSettings": { + "target": "com.amazonaws.pcs#SlurmCustomSettings", + "traits": { + "smithy.api#documentation": "Additional Slurm-specific configuration that directly maps to Slurm settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional options related to the Slurm scheduler.
" + } + }, + "com.amazonaws.pcs#ClusterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.pcs#ClusterSummary": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name that identifies the cluster.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The generated unique ID of the cluster.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the cluster.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "status": { + "target": "com.amazonaws.pcs#ClusterStatus", + "traits": { + "smithy.api#documentation": "The provisioning status of the cluster.
\nThe provisioning status doesn't indicate the overall health of the cluster.
\nThe object returned by the ListClusters API action.
The name that identifies the compute node group.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The generated unique ID of the compute node group.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the compute node group.
", + "smithy.api#required": {} + } + }, + "clusterId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the cluster of the compute node group.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "status": { + "target": "com.amazonaws.pcs#ComputeNodeGroupStatus", + "traits": { + "smithy.api#documentation": "The provisioning status of the compute node group.
\nThe provisioning status doesn't indicate the overall health of the compute node\n group.
\nThe ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances.\n If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
" + } + }, + "subnetIds": { + "target": "com.amazonaws.pcs#SubnetIdList", + "traits": { + "smithy.api#documentation": "The list of subnet IDs where instances are provisioned by the compute node group. \n The subnets must be in the same VPC as the cluster.
", + "smithy.api#required": {} + } + }, + "purchaseOption": { + "target": "com.amazonaws.pcs#PurchaseOption", + "traits": { + "smithy.api#documentation": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand\n and Spot instances. For more information, see Instance\n purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this\n option, it defaults to On-Demand.
" + } + }, + "customLaunchTemplate": { + "target": "com.amazonaws.pcs#CustomLaunchTemplate", + "traits": { + "smithy.api#required": {} + } + }, + "iamInstanceProfileArn": { + "target": "com.amazonaws.pcs#InstanceProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances\n correctly.
A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
", + "smithy.api#required": {} + } + }, + "spotOptions": { + "target": "com.amazonaws.pcs#SpotOptions" + }, + "slurmConfiguration": { + "target": "com.amazonaws.pcs#ComputeNodeGroupSlurmConfiguration" + }, + "errorInfo": { + "target": "com.amazonaws.pcs#ErrorInfoList", + "traits": { + "smithy.api#documentation": "The list of errors that occurred during compute node group provisioning.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A compute node group associated with a cluster.
" + } + }, + "com.amazonaws.pcs#ComputeNodeGroupConfiguration": { + "type": "structure", + "members": { + "computeNodeGroupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The compute node group ID for the compute node group configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The compute node group configuration for a queue.
" + } + }, + "com.amazonaws.pcs#ComputeNodeGroupConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#ComputeNodeGroupConfiguration" + } + }, + "com.amazonaws.pcs#ComputeNodeGroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,25})$" + } + }, + "com.amazonaws.pcs#ComputeNodeGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#ComputeNodeGroupSummary" + } + }, + "com.amazonaws.pcs#ComputeNodeGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#pattern": "^(?!pcs_)^(?![A-Za-z0-9]{10}$)[A-Za-z][A-Za-z0-9-]+$" + } + }, + "com.amazonaws.pcs#ComputeNodeGroupResource": { + "type": "resource", + "identifiers": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier" + }, + "computeNodeGroupIdentifier": { + "target": "com.amazonaws.pcs#ComputeNodeGroupIdentifier" + } + }, + "create": { + "target": "com.amazonaws.pcs#CreateComputeNodeGroup" + }, + "update": { + "target": "com.amazonaws.pcs#UpdateComputeNodeGroup" + }, + "operations": [ + { + "target": "com.amazonaws.pcs#DeleteComputeNodeGroup" + }, + { + "target": "com.amazonaws.pcs#GetComputeNodeGroup" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.pcs#ListComputeNodeGroups" + } + ], + "traits": { + "aws.api#arn": { + "template": "cluster/{clusterIdentifier}/computenodegroup/{computeNodeGroupIdentifier}" + }, + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#iamResource": { + "name": "computenodegroup" + } + } + }, + "com.amazonaws.pcs#ComputeNodeGroupSlurmConfiguration": { + "type": "structure", + "members": { + "slurmCustomSettings": { + "target": "com.amazonaws.pcs#SlurmCustomSettings", + "traits": { + "smithy.api#documentation": "Additional Slurm-specific configuration that directly maps to Slurm settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional options related to the Slurm scheduler.
" + } + }, + "com.amazonaws.pcs#ComputeNodeGroupSlurmConfigurationRequest": { + "type": "structure", + "members": { + "slurmCustomSettings": { + "target": "com.amazonaws.pcs#SlurmCustomSettings", + "traits": { + "smithy.api#documentation": "Additional Slurm-specific configuration that directly maps to Slurm settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional options related to the Slurm scheduler.
" + } + }, + "com.amazonaws.pcs#ComputeNodeGroupStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.pcs#ComputeNodeGroupSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.pcs#ComputeNodeGroupName", + "traits": { + "smithy.api#documentation": "The name that identifies the compute node group.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The generated unique ID of the compute node group.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the compute node group.
", + "smithy.api#required": {} + } + }, + "clusterId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the cluster of the compute node group.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "status": { + "target": "com.amazonaws.pcs#ComputeNodeGroupStatus", + "traits": { + "smithy.api#documentation": "The provisioning status of the compute node group.
\nThe provisioning status doesn't indicate the overall health of the compute node\n group.
\nThe object returned by the ListComputeNodeGroups API action.
\n The unique identifier of the resource that caused the conflict exception.\n
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The type or category of the resource that caused the conflict exception.\"\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Your request has conflicting operations. This can occur if you're trying to perform more\n than 1 operation on the same resource at the same time.
\n\n Examples\n
\nA cluster with the same name already exists.
\nA cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has\n ACTIVE node groups or queues.
A queue already exists in a cluster.
\nCreates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a\n service-owned account. The cluster controller communicates with the cluster resources in\n your account. The subnets and security groups for the cluster must already exist before you\n use this API action.
\nIt takes time for Amazon Web Services PCS to create the cluster. The cluster is in\n a Creating state until it is ready to use. There can only be 1\n cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account.\n CreateCluster\n fails with a ServiceQuotaExceededException if there is already\n a cluster in a Creating state.
A name to identify the cluster. Example: MyCluster\n
The cluster management and job scheduling software associated with the cluster.
", + "smithy.api#required": {} + } + }, + "size": { + "target": "com.amazonaws.pcs#Size", + "traits": { + "smithy.api#documentation": "A value that determines the maximum number of compute nodes in the cluster and the\n maximum number of jobs (active and queued).
\n\n SMALL: 32 compute nodes and 256 jobs
\n MEDIUM: 512 compute nodes and 8192 jobs
\n LARGE: 2048 compute nodes and 16,384 jobs
The networking configuration used to set up the cluster's control plane.
", + "smithy.api#required": {} + } + }, + "slurmConfiguration": { + "target": "com.amazonaws.pcs#ClusterSlurmConfigurationRequest", + "traits": { + "smithy.api#documentation": "Additional options related to the Slurm scheduler.
" + } + }, + "clientToken": { + "target": "com.amazonaws.pcs#SBClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.pcs#RequestTagMap", + "traits": { + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#CreateClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.pcs#Cluster", + "traits": { + "smithy.api#documentation": "The cluster resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#CreateComputeNodeGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#CreateComputeNodeGroupRequest" + }, + "output": { + "target": "com.amazonaws.pcs#CreateComputeNodeGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:RequestTag/${TagKey}", "aws:TagKeys"], + "smithy.api#documentation": "Creates a managed set of compute nodes. You associate a compute node group with a\n cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node\n group includes the definition of the compute properties and lifecycle management.\n Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in\n your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive\n billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must\n already have a launch template before you call this API. For more information, see Launch an\n instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["ComputeNodeGroup"] + } + }, + "com.amazonaws.pcs#CreateComputeNodeGroupRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster to create a compute node group in.
", + "smithy.api#required": {} + } + }, + "computeNodeGroupName": { + "target": "com.amazonaws.pcs#ComputeNodeGroupName", + "traits": { + "aws.iam#conditionKeyValue": "pcs:ResourceName", + "smithy.api#documentation": "A name to identify the cluster. Example: MyCluster\n
The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes\n (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified\n in the custom launch template.
" + } + }, + "subnetIds": { + "target": "com.amazonaws.pcs#StringList", + "traits": { + "smithy.api#documentation": "The list of subnet IDs where the compute node group launches instances.\n Subnets must be in the same VPC as the cluster.
", + "smithy.api#required": {} + } + }, + "purchaseOption": { + "target": "com.amazonaws.pcs#PurchaseOption", + "traits": { + "smithy.api#documentation": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand\n and Spot instances. For more information, see Instance\n purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this\n option, it defaults to On-Demand.
" + } + }, + "customLaunchTemplate": { + "target": "com.amazonaws.pcs#CustomLaunchTemplate", + "traits": { + "smithy.api#required": {} + } + }, + "iamInstanceProfileArn": { + "target": "com.amazonaws.pcs#InstanceProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n pcs:RegisterComputeNodeGroupInstance permissions attached in order to\n provision instances correctly. The resource identifier of the ARN must start with \n AWSPCS. For example, arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile.\n
Specifies the boundaries of the compute node group auto scaling.
", + "smithy.api#required": {} + } + }, + "instanceConfigs": { + "target": "com.amazonaws.pcs#InstanceList", + "traits": { + "smithy.api#documentation": "A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
", + "smithy.api#required": {} + } + }, + "spotOptions": { + "target": "com.amazonaws.pcs#SpotOptions" + }, + "slurmConfiguration": { + "target": "com.amazonaws.pcs#ComputeNodeGroupSlurmConfigurationRequest", + "traits": { + "smithy.api#documentation": "Additional options related to the Slurm scheduler.
" + } + }, + "clientToken": { + "target": "com.amazonaws.pcs#SBClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.pcs#RequestTagMap", + "traits": { + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#CreateComputeNodeGroupResponse": { + "type": "structure", + "members": { + "computeNodeGroup": { + "target": "com.amazonaws.pcs#ComputeNodeGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#CreateQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#CreateQueueRequest" + }, + "output": { + "target": "com.amazonaws.pcs#CreateQueueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:RequestTag/${TagKey}", "aws:TagKeys"], + "smithy.api#documentation": "Creates a job queue. You must associate 1 or more compute node groups with the queue.\n You can associate 1 compute node group with multiple queues.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Queue"] + } + }, + "com.amazonaws.pcs#CreateQueueRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster for which to create a queue.
", + "smithy.api#required": {} + } + }, + "queueName": { + "target": "com.amazonaws.pcs#QueueName", + "traits": { + "aws.iam#conditionKeyValue": "pcs:ResourceName", + "smithy.api#documentation": "A name to identify the queue.
", + "smithy.api#required": {} + } + }, + "computeNodeGroupConfigurations": { + "target": "com.amazonaws.pcs#ComputeNodeGroupConfigurationList", + "traits": { + "smithy.api#documentation": "The list of compute node group configurations to associate with the queue. Queues\n assign jobs to associated compute node groups.
" + } + }, + "clientToken": { + "target": "com.amazonaws.pcs#SBClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.pcs#RequestTagMap", + "traits": { + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#CreateQueueResponse": { + "type": "structure", + "members": { + "queue": { + "target": "com.amazonaws.pcs#Queue" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#CustomLaunchTemplate": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the EC2 launch template to use to provision instances.
\n Example: lt-xxxx\n
The version of the EC2 launch template to use to provision instances.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.
" + } + }, + "com.amazonaws.pcs#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.pcs#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a cluster and all its linked resources. You must delete all queues and compute\n node groups associated with the cluster before you can delete the cluster.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Cluster"] + } + }, + "com.amazonaws.pcs#DeleteClusterRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster to delete.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.pcs#SBClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#DeleteClusterResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#DeleteComputeNodeGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#DeleteComputeNodeGroupRequest" + }, + "output": { + "target": "com.amazonaws.pcs#DeleteComputeNodeGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a compute node group. You must delete all queues associated with the compute\n node group first.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["ComputeNodeGroup"] + } + }, + "com.amazonaws.pcs#DeleteComputeNodeGroupRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster of the compute node group.
", + "smithy.api#required": {} + } + }, + "computeNodeGroupIdentifier": { + "target": "com.amazonaws.pcs#ComputeNodeGroupIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the compute node group to delete.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.pcs#SBClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#DeleteComputeNodeGroupResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#DeleteQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#DeleteQueueRequest" + }, + "output": { + "target": "com.amazonaws.pcs#DeleteQueueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a job queue. If the compute node group associated with this queue isn't\n associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this\n queue.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Queue"] + } + }, + "com.amazonaws.pcs#DeleteQueueRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster of the queue.
", + "smithy.api#required": {} + } + }, + "queueIdentifier": { + "target": "com.amazonaws.pcs#QueueIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the queue to delete.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.pcs#SBClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#DeleteQueueResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#Endpoint": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.pcs#EndpointType", + "traits": { + "smithy.api#documentation": "Indicates the type of endpoint running at the specific IP address.
", + "smithy.api#required": {} + } + }, + "privateIpAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The endpoint's private IP address.
\nExample: 2.2.2.2\n
The endpoint's public IP address.
\nExample: 1.1.1.1\n
The endpoint's connection port number.
\n Example: 1234\n
An endpoint available for interaction with the scheduler.
" + } + }, + "com.amazonaws.pcs#EndpointType": { + "type": "enum", + "members": { + "SLURMCTLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SLURMCTLD" + } + }, + "SLURMDBD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SLURMDBD" + } + } + } + }, + "com.amazonaws.pcs#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#Endpoint" + } + }, + "com.amazonaws.pcs#ErrorInfo": { + "type": "structure", + "members": { + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The short-form error code.
" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The detailed error information.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An error that occurred during resource creation.
" + } + }, + "com.amazonaws.pcs#ErrorInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#ErrorInfo" + } + }, + "com.amazonaws.pcs#GetCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#GetClusterRequest" + }, + "output": { + "target": "com.amazonaws.pcs#GetClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns detailed information about a running cluster in your account. This API action\n provides networking information, endpoint information for communication with the scheduler,\n and provisioning status.
", + "smithy.api#readonly": {}, + "smithy.api#tags": ["Cluster"] + } + }, + "com.amazonaws.pcs#GetClusterRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster of the queue.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#GetClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.pcs#Cluster", + "traits": { + "smithy.api#documentation": "The cluster resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#GetComputeNodeGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#GetComputeNodeGroupRequest" + }, + "output": { + "target": "com.amazonaws.pcs#GetComputeNodeGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns detailed information about a compute node group. This API action provides\n networking information, EC2 instance type, compute node group status, and scheduler (such\n as Slurm) configuration.
", + "smithy.api#readonly": {}, + "smithy.api#tags": ["ComputeNodeGroup"] + } + }, + "com.amazonaws.pcs#GetComputeNodeGroupRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster.
", + "smithy.api#required": {} + } + }, + "computeNodeGroupIdentifier": { + "target": "com.amazonaws.pcs#ComputeNodeGroupIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the compute node group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#GetComputeNodeGroupResponse": { + "type": "structure", + "members": { + "computeNodeGroup": { + "target": "com.amazonaws.pcs#ComputeNodeGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#GetQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#GetQueueRequest" + }, + "output": { + "target": "com.amazonaws.pcs#GetQueueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns detailed information about a queue. The information includes the compute node\n groups that the queue uses to schedule jobs.
", + "smithy.api#readonly": {}, + "smithy.api#tags": ["Queue"] + } + }, + "com.amazonaws.pcs#GetQueueRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster of the queue.
", + "smithy.api#required": {} + } + }, + "queueIdentifier": { + "target": "com.amazonaws.pcs#QueueIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the queue.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#GetQueueResponse": { + "type": "structure", + "members": { + "queue": { + "target": "com.amazonaws.pcs#Queue" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#InstanceConfig": { + "type": "structure", + "members": { + "instanceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.
\n Example: t2.xlarge\n
An EC2 instance configuration Amazon Web Services PCS uses to launch compute nodes.
" + } + }, + "com.amazonaws.pcs#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#InstanceConfig" + } + }, + "com.amazonaws.pcs#InstanceProfileArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/.{1,128}$" + } + }, + "com.amazonaws.pcs#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Amazon Web Services PCS can't process your request right now. Try again later.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.pcs#ListClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#ListClustersRequest" + }, + "output": { + "target": "com.amazonaws.pcs#ListClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of running clusters in your account.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "clusters" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["Cluster"] + } + }, + "com.amazonaws.pcs#ListClustersRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
The maximum number of results that are returned per call.\n You can use nextToken to obtain further pages of results. The default \n is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses \n the default.
The list of clusters.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
Returns a list of all compute node groups associated with a cluster.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "computeNodeGroups" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["ComputeNodeGroup"] + } + }, + "com.amazonaws.pcs#ListComputeNodeGroupsRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster to list compute node groups for.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
The maximum number of results that are returned per call.\n You can use nextToken to obtain further pages of results. The default \n is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses \n the default.
The list of compute node groups for the cluster.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
Returns a list of all queues associated with a cluster.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "queues" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["Queue"] + } + }, + "com.amazonaws.pcs#ListQueuesRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster to list queues for.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
The maximum number of results that are returned per call.\n You can use nextToken to obtain further pages of results. The default \n is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses \n the default.
The list of queues associated with the cluster.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
Returns a list of all tags on an Amazon Web Services PCS resource.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcs#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.pcs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list tags.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.pcs#ClusterResource", + "ids": { + "clusterIdentifier": "resourceArn" + } + }, + { + "resource": "com.amazonaws.pcs#QueueResource", + "ids": { + "clusterIdentifier": "resourceArn", + "queueIdentifier": "resourceArn" + } + }, + { + "resource": "com.amazonaws.pcs#ComputeNodeGroupResource", + "ids": { + "clusterIdentifier": "resourceArn", + "computeNodeGroupIdentifier": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.pcs#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.pcs#ResponseTagMap", + "traits": { + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.pcs#Networking": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.pcs#SubnetIdList", + "traits": { + "smithy.api#documentation": "The ID of the subnet where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to\n enable communication between managed controllers and Amazon Web Services PCS resources. The subnet must\n have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS\n Local Zone.
\n Example: subnet-abcd1234\n
The list of security group IDs associated \n with the Elastic Network Interface (ENI) created in subnets.
\nThe following rules are required:
\nInbound rule 1
\nProtocol: All
\nPorts: All
\nSource: Self
\nOutbound rule 1
\nProtocol: All
\nPorts: All
\nDestination: 0.0.0.0/0 (IPv4)
\nOutbound rule 2
\nProtocol: All
\nPorts: All
\nDestination: Self
\nThe networking configuration for the cluster's control plane.
" + } + }, + "com.amazonaws.pcs#NetworkingRequest": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.pcs#SubnetIdList", + "traits": { + "smithy.api#documentation": "The list of subnet IDs where Amazon Web Services PCS creates an \n Elastic Network Interface (ENI) to enable communication between managed controllers \n and Amazon Web Services PCS resources. Subnet IDs have the form subnet-0123456789abcdef0.
Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.
\nAmazon Web Services PCS currently supports only 1 subnet in this list.
\nA list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The networking configuration for the cluster's control plane.
" + } + }, + "com.amazonaws.pcs#PurchaseOption": { + "type": "enum", + "members": { + "ONDEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONDEMAND" + } + }, + "SPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT" + } + } + } + }, + "com.amazonaws.pcs#Queue": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.pcs#QueueName", + "traits": { + "smithy.api#documentation": "The name that identifies the queue.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The generated unique ID of the queue.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the queue.
", + "smithy.api#required": {} + } + }, + "clusterId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the cluster of the queue.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "status": { + "target": "com.amazonaws.pcs#QueueStatus", + "traits": { + "smithy.api#documentation": "The provisioning status of the queue.
\nThe provisioning status doesn't indicate the overall health of the queue.
\nThe list of compute node group configurations associated with the queue. Queues \n assign jobs to associated compute node groups.
", + "smithy.api#required": {} + } + }, + "errorInfo": { + "target": "com.amazonaws.pcs#ErrorInfoList", + "traits": { + "smithy.api#documentation": "The list of errors that occurred during queue provisioning.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A queue resource.
" + } + }, + "com.amazonaws.pcs#QueueIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,25})$" + } + }, + "com.amazonaws.pcs#QueueList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#QueueSummary" + } + }, + "com.amazonaws.pcs#QueueName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#pattern": "^(?!pcs_)^(?![A-Za-z0-9]{10}$)[A-Za-z][A-Za-z0-9-]+$" + } + }, + "com.amazonaws.pcs#QueueResource": { + "type": "resource", + "identifiers": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier" + }, + "queueIdentifier": { + "target": "com.amazonaws.pcs#QueueIdentifier" + } + }, + "create": { + "target": "com.amazonaws.pcs#CreateQueue" + }, + "update": { + "target": "com.amazonaws.pcs#UpdateQueue" + }, + "operations": [ + { + "target": "com.amazonaws.pcs#DeleteQueue" + }, + { + "target": "com.amazonaws.pcs#GetQueue" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.pcs#ListQueues" + } + ], + "traits": { + "aws.api#arn": { + "template": "cluster/{clusterIdentifier}/queue/{queueIdentifier}" + }, + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#iamResource": { + "name": "queue" + } + } + }, + "com.amazonaws.pcs#QueueStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.pcs#QueueSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.pcs#QueueName", + "traits": { + "smithy.api#documentation": "The name that identifies the queue.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The generated unique ID of the queue.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the queue.
", + "smithy.api#required": {} + } + }, + "clusterId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the cluster of the queue.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "status": { + "target": "com.amazonaws.pcs#QueueStatus", + "traits": { + "smithy.api#documentation": "The provisioning status of the queue.
\nThe provisioning status doesn't indicate the overall health of the queue.
\nThe object returned by the ListQueues API action.
This API action isn't intended for you to use.
\nAmazon Web Services PCS uses this API action to register the compute nodes it launches in your account.
" + } + }, + "com.amazonaws.pcs#RegisterComputeNodeGroupInstanceRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster to register the compute node group instance in.
", + "smithy.api#required": {} + } + }, + "bootstrapId": { + "target": "com.amazonaws.pcs#BootstrapId", + "traits": { + "smithy.api#documentation": "The client-generated token to allow for retries.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#RegisterComputeNodeGroupInstanceResponse": { + "type": "structure", + "members": { + "nodeID": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The scheduler node ID for this instance.
", + "smithy.api#required": {} + } + }, + "sharedSecret": { + "target": "com.amazonaws.pcs#SharedSecret", + "traits": { + "smithy.api#documentation": "For the Slurm scheduler, this is the shared Munge key the scheduler uses to\n authenticate compute node group instances.
", + "smithy.api#required": {} + } + }, + "endpoints": { + "target": "com.amazonaws.pcs#Endpoints", + "traits": { + "smithy.api#documentation": "The list of endpoints available for interaction with the scheduler.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#RequestTagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.pcs#TagKey" + }, + "value": { + "target": "com.amazonaws.pcs#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.pcs#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the resource that was not found.\n
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The type or category of the resource that was not found.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The requested resource can't be found. The cluster, node group, or queue you're\n attempting to get, update, list, or delete doesn't exist.
\n\n Examples\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.pcs#ResponseTagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.pcs#TagKey" + }, + "value": { + "target": "com.amazonaws.pcs#TagValue" + } + }, + "com.amazonaws.pcs#SBClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 100 + } + } + }, + "com.amazonaws.pcs#ScalingConfiguration": { + "type": "structure", + "members": { + "minInstanceCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The lower bound of the number of instances allowed in the compute fleet.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "maxInstanceCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The upper bound of the number of instances allowed in the compute fleet.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the boundaries of the compute node group auto scaling.
" + } + }, + "com.amazonaws.pcs#ScalingConfigurationRequest": { + "type": "structure", + "members": { + "minInstanceCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The lower bound of the number of instances allowed in the compute fleet.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "maxInstanceCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The upper bound of the number of instances allowed in the compute fleet.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the boundaries of the compute node group auto scaling.
" + } + }, + "com.amazonaws.pcs#Scheduler": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.pcs#SchedulerType", + "traits": { + "smithy.api#documentation": "The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The cluster management and job scheduling software associated with the cluster.
" + } + }, + "com.amazonaws.pcs#SchedulerRequest": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.pcs#SchedulerType", + "traits": { + "smithy.api#documentation": "The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The cluster management and job scheduling software associated with the cluster.
" + } + }, + "com.amazonaws.pcs#SchedulerType": { + "type": "enum", + "members": { + "SLURM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SLURM" + } + } + } + }, + "com.amazonaws.pcs#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^sg-\\w{8,17}$" + } + }, + "com.amazonaws.pcs#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#SecurityGroupId" + } + }, + "com.amazonaws.pcs#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The service code associated with the quota that was exceeded.\n
", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the resource that caused the quota to be exceeded.\n
" + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The type or category of the resource that caused the quota to be exceeded.\n
" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The quota code of the service quota that was exceeded.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "You exceeded your service quota. Service quotas, also referred to as limits, are the\n maximum number of service resources or operations for your Amazon Web Services account. To learn how to\n increase your service quota, see Requesting a quota\n increase in the Service Quotas User Guide\n
\n\n Examples\n
\nThe max number of clusters or queues has been reached for the account.
\nThe max number of compute node groups has been reached for the associated\n cluster.
\nThe total of maxInstances across all compute node groups has been\n reached for associated cluster.
The Amazon Resource Name (ARN) of the the shared Slurm key.
", + "smithy.api#required": {} + } + }, + "secretVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the shared Slurm key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The shared Slurm key for authentication, also known as the cluster secret.
" + } + }, + "com.amazonaws.pcs#SlurmCustomSetting": { + "type": "structure", + "members": { + "parameterName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Amazon Web Services PCS supports configuration of the following Slurm parameters: \n Prolog\n , \n Epilog\n , and \n SelectTypeParameters\n .
The values for the configured Slurm settings.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Additional settings that directly map to Slurm settings.
" + } + }, + "com.amazonaws.pcs#SlurmCustomSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#SlurmCustomSetting" + } + }, + "com.amazonaws.pcs#SpotAllocationStrategy": { + "type": "enum", + "members": { + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowest-price" + } + }, + "CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-optimized" + } + }, + "PRICE_CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "price-capacity-optimized" + } + } + } + }, + "com.amazonaws.pcs#SpotOptions": { + "type": "structure", + "members": { + "allocationStrategy": { + "target": "com.amazonaws.pcs#SpotAllocationStrategy", + "traits": { + "smithy.api#documentation": "The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. \n Amazon Web Services PCS supports lowest price, \n capacity optimized, and \n price capacity optimized. \n For more information, see Use \n allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand\n capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option,\n it defaults to price capacity optimized.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional configuration when you specify SPOT as the\n purchaseOption for the CreateComputeNodeGroup API action.
Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag\n value. The tag key and tag value are case-sensitive strings. The tag value can be an empty\n (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify\n an existing tag key and a new tag value.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcs#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.pcs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.pcs#RequestTagMap", + "traits": { + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.pcs#ClusterResource", + "ids": { + "clusterIdentifier": "resourceArn" + } + }, + { + "resource": "com.amazonaws.pcs#QueueResource", + "ids": { + "clusterIdentifier": "resourceArn", + "queueIdentifier": "resourceArn" + } + }, + { + "resource": "com.amazonaws.pcs#ComputeNodeGroupResource", + "ids": { + "clusterIdentifier": "resourceArn", + "computeNodeGroupIdentifier": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.pcs#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.pcs#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "\n The number of seconds to wait before retrying the request.\n
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.pcs#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}", "aws:TagKeys"], + "smithy.api#documentation": "Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the\n Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcs#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.pcs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.pcs#TagKeys", + "traits": { + "aws.iam#conditionKeyValue": "aws:TagKeys", + "smithy.api#documentation": "1 or more tag keys to remove from the resource. Specify only tag keys and not tag\n values.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.pcs#ClusterResource", + "ids": { + "clusterIdentifier": "resourceArn" + } + }, + { + "resource": "com.amazonaws.pcs#QueueResource", + "ids": { + "clusterIdentifier": "resourceArn", + "queueIdentifier": "resourceArn" + } + }, + { + "resource": "com.amazonaws.pcs#ComputeNodeGroupResource", + "ids": { + "clusterIdentifier": "resourceArn", + "computeNodeGroupIdentifier": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.pcs#UpdateComputeNodeGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#UpdateComputeNodeGroupRequest" + }, + "output": { + "target": "com.amazonaws.pcs#UpdateComputeNodeGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a compute node group. You can update many of the fields related to your compute\n node group including the configurations for networking, compute nodes, and settings\n specific to your scheduler (such as Slurm).
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["ComputeNodeGroup"] + } + }, + "com.amazonaws.pcs#UpdateComputeNodeGroupRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster of the compute node group.
", + "smithy.api#required": {} + } + }, + "computeNodeGroupIdentifier": { + "target": "com.amazonaws.pcs#ComputeNodeGroupIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the compute node group.
", + "smithy.api#required": {} + } + }, + "amiId": { + "target": "com.amazonaws.pcs#AmiId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances.\n If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch\n template.
" + } + }, + "subnetIds": { + "target": "com.amazonaws.pcs#StringList", + "traits": { + "smithy.api#documentation": "The list of subnet IDs where the compute node group provisions instances.\n The subnets must be in the same VPC as the cluster.
" + } + }, + "customLaunchTemplate": { + "target": "com.amazonaws.pcs#CustomLaunchTemplate" + }, + "purchaseOption": { + "target": "com.amazonaws.pcs#PurchaseOption", + "traits": { + "smithy.api#documentation": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand\n and Spot instances. For more information, see Instance\n purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this\n option, it defaults to On-Demand.
" + } + }, + "spotOptions": { + "target": "com.amazonaws.pcs#SpotOptions" + }, + "scalingConfiguration": { + "target": "com.amazonaws.pcs#ScalingConfigurationRequest", + "traits": { + "smithy.api#documentation": "Specifies the boundaries of the compute node group auto scaling.
" + } + }, + "iamInstanceProfileArn": { + "target": "com.amazonaws.pcs#InstanceProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances\n correctly.
Additional options related to the Slurm scheduler.
" + } + }, + "clientToken": { + "target": "com.amazonaws.pcs#SBClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#UpdateComputeNodeGroupResponse": { + "type": "structure", + "members": { + "computeNodeGroup": { + "target": "com.amazonaws.pcs#ComputeNodeGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#UpdateComputeNodeGroupSlurmConfigurationRequest": { + "type": "structure", + "members": { + "slurmCustomSettings": { + "target": "com.amazonaws.pcs#SlurmCustomSettings", + "traits": { + "smithy.api#documentation": "Additional Slurm-specific configuration that directly maps to Slurm settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional options related to the Slurm scheduler.
" + } + }, + "com.amazonaws.pcs#UpdateQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#UpdateQueueRequest" + }, + "output": { + "target": "com.amazonaws.pcs#UpdateQueueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the compute node group configuration of a queue. Use this API to change the\n compute node groups that the queue can send jobs to.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Queue"] + } + }, + "com.amazonaws.pcs#UpdateQueueRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the cluster of the queue.
", + "smithy.api#required": {} + } + }, + "queueIdentifier": { + "target": "com.amazonaws.pcs#QueueIdentifier", + "traits": { + "smithy.api#documentation": "The name or ID of the queue.
", + "smithy.api#required": {} + } + }, + "computeNodeGroupConfigurations": { + "target": "com.amazonaws.pcs#ComputeNodeGroupConfigurationList", + "traits": { + "smithy.api#documentation": "The list of compute node group configurations to associate with the queue. Queues\n assign jobs to associated compute node groups.
" + } + }, + "clientToken": { + "target": "com.amazonaws.pcs#SBClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#UpdateQueueResponse": { + "type": "structure", + "members": { + "queue": { + "target": "com.amazonaws.pcs#Queue" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.pcs#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "\n The specific reason or cause of the validation error.\n
", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.pcs#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "\n A list of fields or properties that failed validation.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request isn't valid.
\n\n Examples\n
\nYour request contains malformed JSON or unsupported characters.
\nThe scheduler version isn't supported.
\nThere are networking related errors, such as network validation failure.
\nAMI type is CUSTOM and the launch template doesn't define the AMI ID,\n or the AMI type is AL2 and the launch template defines the AMI.
The name of the exception.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The message body of the exception.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stores information about a field in a request that caused an exception.
" + } + }, + "com.amazonaws.pcs#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcs#ValidationExceptionField" + } + }, + "com.amazonaws.pcs#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + } + } +}