@aws-sdk/client-athena 3.321.1 → 3.325.0

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

@@ -0,0 +1,78 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
+import { PutCapacityAssignmentConfigurationInput, PutCapacityAssignmentConfigurationOutput } from "../models/models_0";
+/**
+ * @public
+ *
+ * The input for {@link PutCapacityAssignmentConfigurationCommand}.
+ */
+export interface PutCapacityAssignmentConfigurationCommandInput extends PutCapacityAssignmentConfigurationInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutCapacityAssignmentConfigurationCommand}.
+ */
+export interface PutCapacityAssignmentConfigurationCommandOutput extends PutCapacityAssignmentConfigurationOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AthenaClient, PutCapacityAssignmentConfigurationCommand } from "@aws-sdk/client-athena"; // ES Modules import
+ * // const { AthenaClient, PutCapacityAssignmentConfigurationCommand } = require("@aws-sdk/client-athena"); // CommonJS import
+ * const client = new AthenaClient(config);
+ * const input = { // PutCapacityAssignmentConfigurationInput
+ *   CapacityReservationName: "STRING_VALUE", // required
+ *   CapacityAssignments: [ // CapacityAssignmentsList // required
+ *     { // CapacityAssignment
+ *       WorkGroupNames: [ // WorkGroupNamesList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   ],
+ * };
+ * const command = new PutCapacityAssignmentConfigurationCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param PutCapacityAssignmentConfigurationCommandInput - {@link PutCapacityAssignmentConfigurationCommandInput}
+ * @returns {@link PutCapacityAssignmentConfigurationCommandOutput}
+ * @see {@link PutCapacityAssignmentConfigurationCommandInput} for command's `input` shape.
+ * @see {@link PutCapacityAssignmentConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Indicates a platform issue, which may be due to a transient condition or
+ *             outage.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>Indicates that something is wrong with the input to the request. For example, a
+ *             required parameter may be missing or out of range.</p>
+ *
+ *
+ */
+export declare class PutCapacityAssignmentConfigurationCommand extends $Command<PutCapacityAssignmentConfigurationCommandInput, PutCapacityAssignmentConfigurationCommandOutput, AthenaClientResolvedConfig> {
+    readonly input: PutCapacityAssignmentConfigurationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutCapacityAssignmentConfigurationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutCapacityAssignmentConfigurationCommandInput, PutCapacityAssignmentConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -20,11 +20,9 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
 /**
  * @public
  * <p>Adds one or more tags to an Athena resource. A tag is a label that you
- *             assign to a resource. In Athena, a resource can be a workgroup or data
- *             catalog. Each tag consists of a key and an optional value, both of which you define. For
- *             example, you can use tags to categorize Athena workgroups or data catalogs
- *             by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to
- *             search and filter workgroups or data catalogs in your account. For best practices, see
+ *             assign to a resource. Each tag consists of a key and an optional value, both of which you define. For
+ *             example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to
+ *             search and filter the resources in your account. For best practices, see
  *             <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode
  *             characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use
  *             letters and numbers representable in UTF-8, and the following characters: + - = . _ : /

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

@@ -19,7 +19,7 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
 }
 /**
  * @public
- * <p>Removes one or more tags from a data catalog or workgroup resource.</p>
+ * <p>Removes one or more tags from an Athena resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -0,0 +1,72 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
+import { UpdateCapacityReservationInput, UpdateCapacityReservationOutput } from "../models/models_0";
+/**
+ * @public
+ *
+ * The input for {@link UpdateCapacityReservationCommand}.
+ */
+export interface UpdateCapacityReservationCommandInput extends UpdateCapacityReservationInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateCapacityReservationCommand}.
+ */
+export interface UpdateCapacityReservationCommandOutput extends UpdateCapacityReservationOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates the number of requested data processing units for the capacity reservation with the specified name.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AthenaClient, UpdateCapacityReservationCommand } from "@aws-sdk/client-athena"; // ES Modules import
+ * // const { AthenaClient, UpdateCapacityReservationCommand } = require("@aws-sdk/client-athena"); // CommonJS import
+ * const client = new AthenaClient(config);
+ * const input = { // UpdateCapacityReservationInput
+ *   TargetDpus: Number("int"), // required
+ *   Name: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateCapacityReservationCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param UpdateCapacityReservationCommandInput - {@link UpdateCapacityReservationCommandInput}
+ * @returns {@link UpdateCapacityReservationCommandOutput}
+ * @see {@link UpdateCapacityReservationCommandInput} for command's `input` shape.
+ * @see {@link UpdateCapacityReservationCommandOutput} for command's `response` shape.
+ * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Indicates a platform issue, which may be due to a transient condition or
+ *             outage.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>Indicates that something is wrong with the input to the request. For example, a
+ *             required parameter may be missing or out of range.</p>
+ *
+ *
+ */
+export declare class UpdateCapacityReservationCommand extends $Command<UpdateCapacityReservationCommandInput, UpdateCapacityReservationCommandOutput, AthenaClientResolvedConfig> {
+    readonly input: UpdateCapacityReservationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateCapacityReservationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateCapacityReservationCommandInput, UpdateCapacityReservationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,6 +1,8 @@
 export * from "./BatchGetNamedQueryCommand";
 export * from "./BatchGetPreparedStatementCommand";
 export * from "./BatchGetQueryExecutionCommand";
+export * from "./CancelCapacityReservationCommand";
+export * from "./CreateCapacityReservationCommand";
 export * from "./CreateDataCatalogCommand";
 export * from "./CreateNamedQueryCommand";
 export * from "./CreateNotebookCommand";
@@ -16,6 +18,8 @@ export * from "./ExportNotebookCommand";
 export * from "./GetCalculationExecutionCodeCommand";
 export * from "./GetCalculationExecutionCommand";
 export * from "./GetCalculationExecutionStatusCommand";
+export * from "./GetCapacityAssignmentConfigurationCommand";
+export * from "./GetCapacityReservationCommand";
 export * from "./GetDataCatalogCommand";
 export * from "./GetDatabaseCommand";
 export * from "./GetNamedQueryCommand";
@@ -31,6 +35,7 @@ export * from "./GetWorkGroupCommand";
 export * from "./ImportNotebookCommand";
 export * from "./ListApplicationDPUSizesCommand";
 export * from "./ListCalculationExecutionsCommand";
+export * from "./ListCapacityReservationsCommand";
 export * from "./ListDataCatalogsCommand";
 export * from "./ListDatabasesCommand";
 export * from "./ListEngineVersionsCommand";
@@ -44,6 +49,7 @@ export * from "./ListSessionsCommand";
 export * from "./ListTableMetadataCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ListWorkGroupsCommand";
+export * from "./PutCapacityAssignmentConfigurationCommand";
 export * from "./StartCalculationExecutionCommand";
 export * from "./StartQueryExecutionCommand";
 export * from "./StartSessionCommand";
@@ -52,6 +58,7 @@ export * from "./StopQueryExecutionCommand";
 export * from "./TagResourceCommand";
 export * from "./TerminateSessionCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateCapacityReservationCommand";
 export * from "./UpdateDataCatalogCommand";
 export * from "./UpdateNamedQueryCommand";
 export * from "./UpdateNotebookCommand";

package/dist-types/models/models_0.d.ts

@@ -650,11 +650,25 @@ export interface BatchGetQueryExecutionOutput {
 }
 /**
  * @public
- * <p>A label that you assign to a resource. In Athena, a resource can be a
- *             workgroup or data catalog. Each tag consists of a key and an optional value, both of
+ */
+export interface CancelCapacityReservationInput {
+    /**
+     * <p>The name of the capacity reservation to cancel.</p>
+     */
+    Name: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CancelCapacityReservationOutput {
+}
+/**
+ * @public
+ * <p>A label that you assign to a resource. Athena resources include
+ *             workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an optional value, both of
  *             which you define. For example, you can use tags to categorize Athena
- *             workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of
- *             tag keys to make it easier to search and filter workgroups or data catalogs in your
+ *             resources by purpose, owner, or environment. Use a consistent set of
+ *             tag keys to make it easier to search and filter the resources in your
  *             account. For best practices, see <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode
  *             characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use
  *             letters and numbers representable in UTF-8, and the following characters: + - = . _ : /
@@ -675,6 +689,28 @@ export interface Tag {
      */
     Value?: string;
 }
+/**
+ * @public
+ */
+export interface CreateCapacityReservationInput {
+    /**
+     * <p>The number of requested data processing units.</p>
+     */
+    TargetDpus: number | undefined;
+    /**
+     * <p>The name of the capacity reservation to create.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>The tags for the capacity reservation.</p>
+     */
+    Tags?: Tag[];
+}
+/**
+ * @public
+ */
+export interface CreateCapacityReservationOutput {
+}
 /**
  * @public
  * @enum
@@ -1407,6 +1443,151 @@ export interface GetCalculationExecutionStatusResponse {
      */
     Statistics?: CalculationStatistics;
 }
+/**
+ * @public
+ */
+export interface GetCapacityAssignmentConfigurationInput {
+    /**
+     * <p>The name of the capacity reservation to retrieve the capacity assignment configuration for.</p>
+     */
+    CapacityReservationName: string | undefined;
+}
+/**
+ * @public
+ * <p>A mapping between one or more workgroups and a capacity reservation.</p>
+ */
+export interface CapacityAssignment {
+    /**
+     * <p>The list of workgroup names for the capacity assignment.</p>
+     */
+    WorkGroupNames?: string[];
+}
+/**
+ * @public
+ * <p>Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.</p>
+ */
+export interface CapacityAssignmentConfiguration {
+    /**
+     * <p>The name of the reservation that the capacity assignment configuration is for.</p>
+     */
+    CapacityReservationName?: string;
+    /**
+     * <p>The list of assignments that make up the capacity assignment configuration.</p>
+     */
+    CapacityAssignments?: CapacityAssignment[];
+}
+/**
+ * @public
+ */
+export interface GetCapacityAssignmentConfigurationOutput {
+    /**
+     * <p>The requested capacity assignment configuration for the specified capacity reservation.</p>
+     */
+    CapacityAssignmentConfiguration: CapacityAssignmentConfiguration | undefined;
+}
+/**
+ * @public
+ */
+export interface GetCapacityReservationInput {
+    /**
+     * <p>The name of the capacity reservation.</p>
+     */
+    Name: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const CapacityAllocationStatus: {
+    readonly FAILED: "FAILED";
+    readonly PENDING: "PENDING";
+    readonly SUCCEEDED: "SUCCEEDED";
+};
+/**
+ * @public
+ */
+export type CapacityAllocationStatus = (typeof CapacityAllocationStatus)[keyof typeof CapacityAllocationStatus];
+/**
+ * @public
+ * <p>Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.</p>
+ */
+export interface CapacityAllocation {
+    /**
+     * <p>The status of the capacity allocation.</p>
+     */
+    Status: CapacityAllocationStatus | string | undefined;
+    /**
+     * <p>The status message of the capacity allocation.</p>
+     */
+    StatusMessage?: string;
+    /**
+     * <p>The time when the capacity allocation was requested.</p>
+     */
+    RequestTime: Date | undefined;
+    /**
+     * <p>The time when the capacity allocation request was completed.</p>
+     */
+    RequestCompletionTime?: Date;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const CapacityReservationStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly CANCELLED: "CANCELLED";
+    readonly CANCELLING: "CANCELLING";
+    readonly FAILED: "FAILED";
+    readonly PENDING: "PENDING";
+    readonly UPDATE_PENDING: "UPDATE_PENDING";
+};
+/**
+ * @public
+ */
+export type CapacityReservationStatus = (typeof CapacityReservationStatus)[keyof typeof CapacityReservationStatus];
+/**
+ * @public
+ * <p>A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.</p>
+ */
+export interface CapacityReservation {
+    /**
+     * <p>The name of the capacity reservation.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>The status of the capacity reservation.</p>
+     */
+    Status: CapacityReservationStatus | string | undefined;
+    /**
+     * <p>The number of data processing units requested.</p>
+     */
+    TargetDpus: number | undefined;
+    /**
+     * <p>The number of data processing units currently allocated.</p>
+     */
+    AllocatedDpus: number | undefined;
+    /**
+     * <p>Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.</p>
+     */
+    LastAllocation?: CapacityAllocation;
+    /**
+     * <p>The time of the most recent capacity allocation that succeeded.</p>
+     */
+    LastSuccessfulAllocationTime?: Date;
+    /**
+     * <p>The time in UTC epoch millis when the capacity reservation was created.</p>
+     */
+    CreationTime: Date | undefined;
+}
+/**
+ * @public
+ */
+export interface GetCapacityReservationOutput {
+    /**
+     * <p>The requested capacity reservation structure.</p>
+     */
+    CapacityReservation: CapacityReservation | undefined;
+}
 /**
  * @public
  */
@@ -1882,7 +2063,7 @@ export interface EngineConfiguration {
     /**
      * <p>The number of DPUs to use for the coordinator. A coordinator is a special executor
      *             that orchestrates processing work and manages other executors in a notebook
-     *             session.</p>
+     *             session. The default is 1.</p>
      */
     CoordinatorDpuSize?: number;
     /**
@@ -1891,7 +2072,7 @@ export interface EngineConfiguration {
     MaxConcurrentDpus: number | undefined;
     /**
      * <p>The default number of DPUs to use for executors. An executor is the smallest unit of
-     *             compute that a notebook session can request from Athena.</p>
+     *             compute that a notebook session can request from Athena. The default is 1.</p>
      */
     DefaultExecutorDpuSize?: number;
     /**
@@ -2379,6 +2560,35 @@ export interface ListCalculationExecutionsResponse {
      */
     Calculations?: CalculationSummary[];
 }
+/**
+ * @public
+ */
+export interface ListCapacityReservationsInput {
+    /**
+     * <p>A token generated by the Athena service that specifies where to continue
+     *             pagination if a previous request was truncated.</p>
+     */
+    NextToken?: string;
+    /**
+     * <p>Specifies the maximum number of results to return.</p>
+     */
+    MaxResults?: number;
+}
+/**
+ * @public
+ */
+export interface ListCapacityReservationsOutput {
+    /**
+     * <p>A token generated by the Athena service that specifies where to continue
+     *             pagination if a previous request was truncated. To obtain the next set of pages, pass in
+     *             the NextToken from the response object of the previous page call.</p>
+     */
+    NextToken?: string;
+    /**
+     * <p>The capacity reservations for the current account.</p>
+     */
+    CapacityReservations: CapacityReservation[] | undefined;
+}
 /**
  * @public
  */
@@ -3052,6 +3262,24 @@ export interface ListWorkGroupsOutput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
+export interface PutCapacityAssignmentConfigurationInput {
+    /**
+     * <p>The name of the capacity reservation to put a capacity assignment configuration for.</p>
+     */
+    CapacityReservationName: string | undefined;
+    /**
+     * <p>The list of assignments for the capacity assignment configuration.</p>
+     */
+    CapacityAssignments: CapacityAssignment[] | undefined;
+}
+/**
+ * @public
+ */
+export interface PutCapacityAssignmentConfigurationOutput {
+}
 /**
  * @public
  * <p>Contains configuration information for the calculation.</p>
@@ -3322,12 +3550,12 @@ export interface StopQueryExecutionOutput {
  */
 export interface TagResourceInput {
     /**
-     * <p>Specifies the ARN of the Athena resource (workgroup or data catalog) to
+     * <p>Specifies the ARN of the Athena resource to
      *             which tags are to be added.</p>
      */
     ResourceARN: string | undefined;
     /**
-     * <p>A collection of one or more tags, separated by commas, to be added to an Athena workgroup or data catalog resource.</p>
+     * <p>A collection of one or more tags, separated by commas, to be added to an Athena resource.</p>
      */
     Tags: Tag[] | undefined;
 }
@@ -3392,6 +3620,24 @@ export interface UntagResourceInput {
  */
 export interface UntagResourceOutput {
 }
+/**
+ * @public
+ */
+export interface UpdateCapacityReservationInput {
+    /**
+     * <p>The new number of requested data processing units.</p>
+     */
+    TargetDpus: number | undefined;
+    /**
+     * <p>The name of the capacity reservation.</p>
+     */
+    Name: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateCapacityReservationOutput {
+}
 /**
  * @public
  */

package/dist-types/pagination/ListCapacityReservationsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListCapacityReservationsCommandInput, ListCapacityReservationsCommandOutput } from "../commands/ListCapacityReservationsCommand";
+import { AthenaPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare function paginateListCapacityReservations(config: AthenaPaginationConfiguration, input: ListCapacityReservationsCommandInput, ...additionalArguments: any): Paginator<ListCapacityReservationsCommandOutput>;

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

@@ -2,6 +2,7 @@ export * from "./GetQueryResultsPaginator";
 export * from "./Interfaces";
 export * from "./ListApplicationDPUSizesPaginator";
 export * from "./ListCalculationExecutionsPaginator";
+export * from "./ListCapacityReservationsPaginator";
 export * from "./ListDataCatalogsPaginator";
 export * from "./ListDatabasesPaginator";
 export * from "./ListEngineVersionsPaginator";