@aws-sdk/client-pcs 3.641.0

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

@@ -0,0 +1,150 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListQueuesRequest, ListQueuesResponse } from "../models/models_0";
+import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient";
+/**
+ * @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 {
+}
+declare const ListQueuesCommand_base: {
+    new (input: ListQueuesCommandInput): import("@smithy/smithy-client").CommandImpl<ListQueuesCommandInput, ListQueuesCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListQueuesCommandInput): import("@smithy/smithy-client").CommandImpl<ListQueuesCommandInput, ListQueuesCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of all queues associated with a cluster.</p>
+ * @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)
+ *  <p>You don't have permission to perform the action.</p>
+ *          <p>
+ *             <u>Examples</u>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>The launch template instance profile doesn't pass <code>iam:PassRole</code>
+ *                verification.</p>
+ *             </li>
+ *             <li>
+ *                <p>There is a mismatch between the account ID and cluster ID.</p>
+ *             </li>
+ *             <li>
+ *                <p>The cluster ID doesn't exist.</p>
+ *             </li>
+ *             <li>
+ *                <p>The EC2 instance isn't present.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>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.</p>
+ *          <p>
+ *             <u>Examples</u>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>A cluster with the same name already exists.</p>
+ *             </li>
+ *             <li>
+ *                <p>A cluster isn't in <code>ACTIVE</code> status.</p>
+ *             </li>
+ *             <li>
+ *                <p>A cluster to delete is in an unstable state. For example, because it still has
+ *                   <code>ACTIVE</code> node groups or queues.</p>
+ *             </li>
+ *             <li>
+ *                <p>A queue already exists in a cluster.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Amazon Web Services PCS can't process your request right now. Try again later.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>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.</p>
+ *          <p>
+ *             <u>Examples</u>
+ *          </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Your request exceeded a request rate quota. Check the resource's request rate quota and try again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request isn't valid.</p>
+ *          <p>
+ *             <u>Examples</u>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>Your request contains malformed JSON or unsupported characters.</p>
+ *             </li>
+ *             <li>
+ *                <p>The scheduler version isn't supported.</p>
+ *             </li>
+ *             <li>
+ *                <p>There are networking related errors, such as network validation failure.</p>
+ *             </li>
+ *             <li>
+ *                <p>AMI type is <code>CUSTOM</code> and the launch template doesn't define the AMI ID,
+ *             or the AMI type is AL2 and the launch template defines the AMI.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link PCSServiceException}
+ * <p>Base exception class for all service exceptions from PCS service.</p>
+ *
+ * @public
+ */
+export declare class ListQueuesCommand extends ListQueuesCommand_base {
+}

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

@@ -0,0 +1,69 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
+import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient";
+/**
+ * @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 {
+}
+declare const ListTagsForResourceCommand_base: {
+    new (input: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of all tags on an Amazon Web Services PCS resource.</p>
+ * @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
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
+ * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
+ * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
+ * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>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.</p>
+ *          <p>
+ *             <u>Examples</u>
+ *          </p>
+ *
+ * @throws {@link PCSServiceException}
+ * <p>Base exception class for all service exceptions from PCS service.</p>
+ *
+ * @public
+ */
+export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
+}

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

@@ -0,0 +1,97 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { RegisterComputeNodeGroupInstanceRequest, RegisterComputeNodeGroupInstanceResponse } from "../models/models_0";
+import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient";
+/**
+ * @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 {
+}
+declare const RegisterComputeNodeGroupInstanceCommand_base: {
+    new (input: RegisterComputeNodeGroupInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterComputeNodeGroupInstanceCommandInput, RegisterComputeNodeGroupInstanceCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: RegisterComputeNodeGroupInstanceCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterComputeNodeGroupInstanceCommandInput, RegisterComputeNodeGroupInstanceCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <important>
+ *             <p>This API action isn't intended for you to use.</p>
+ *          </important>
+ *          <p>Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.</p>
+ * @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)
+ *  <p>You don't have permission to perform the action.</p>
+ *          <p>
+ *             <u>Examples</u>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>The launch template instance profile doesn't pass <code>iam:PassRole</code>
+ *                verification.</p>
+ *             </li>
+ *             <li>
+ *                <p>There is a mismatch between the account ID and cluster ID.</p>
+ *             </li>
+ *             <li>
+ *                <p>The cluster ID doesn't exist.</p>
+ *             </li>
+ *             <li>
+ *                <p>The EC2 instance isn't present.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Amazon Web Services PCS can't process your request right now. Try again later.</p>
+ *
+ * @throws {@link PCSServiceException}
+ * <p>Base exception class for all service exceptions from PCS service.</p>
+ *
+ * @public
+ */
+export declare class RegisterComputeNodeGroupInstanceCommand extends RegisterComputeNodeGroupInstanceCommand_base {
+}

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

@@ -0,0 +1,71 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { TagResourceRequest } from "../models/models_0";
+import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient";
+/**
+ * @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 {
+}
+declare const TagResourceCommand_base: {
+    new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>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.</p>
+ * @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
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>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.</p>
+ *          <p>
+ *             <u>Examples</u>
+ *          </p>
+ *
+ * @throws {@link PCSServiceException}
+ * <p>Base exception class for all service exceptions from PCS service.</p>
+ *
+ * @public
+ */
+export declare class TagResourceCommand extends TagResourceCommand_base {
+}

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

@@ -0,0 +1,69 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UntagResourceRequest } from "../models/models_0";
+import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient";
+/**
+ * @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 {
+}
+declare const UntagResourceCommand_base: {
+    new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>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.</p>
+ * @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)
+ *  <p>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.</p>
+ *          <p>
+ *             <u>Examples</u>
+ *          </p>
+ *
+ * @throws {@link PCSServiceException}
+ * <p>Base exception class for all service exceptions from PCS service.</p>
+ *
+ * @public
+ */
+export declare class UntagResourceCommand extends UntagResourceCommand_base {
+}