@aws-sdk/client-compute-optimizer-automation 3.938.0

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

@@ -0,0 +1,110 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComputeOptimizerAutomationClient";
+import { UpdateEnrollmentConfigurationRequest, UpdateEnrollmentConfigurationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateEnrollmentConfigurationCommand}.
+ */
+export interface UpdateEnrollmentConfigurationCommandInput extends UpdateEnrollmentConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateEnrollmentConfigurationCommand}.
+ */
+export interface UpdateEnrollmentConfigurationCommandOutput extends UpdateEnrollmentConfigurationResponse, __MetadataBearer {
+}
+declare const UpdateEnrollmentConfigurationCommand_base: {
+    new (input: UpdateEnrollmentConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateEnrollmentConfigurationCommandInput, UpdateEnrollmentConfigurationCommandOutput, ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateEnrollmentConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateEnrollmentConfigurationCommandInput, UpdateEnrollmentConfigurationCommandOutput, ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates your account’s Compute Optimizer Automation enrollment configuration. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ComputeOptimizerAutomationClient, UpdateEnrollmentConfigurationCommand } from "@aws-sdk/client-compute-optimizer-automation"; // ES Modules import
+ * // const { ComputeOptimizerAutomationClient, UpdateEnrollmentConfigurationCommand } = require("@aws-sdk/client-compute-optimizer-automation"); // CommonJS import
+ * // import type { ComputeOptimizerAutomationClientConfig } from "@aws-sdk/client-compute-optimizer-automation";
+ * const config = {}; // type is ComputeOptimizerAutomationClientConfig
+ * const client = new ComputeOptimizerAutomationClient(config);
+ * const input = { // UpdateEnrollmentConfigurationRequest
+ *   status: "Active" || "Inactive" || "Pending" || "Failed", // required
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateEnrollmentConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateEnrollmentConfigurationResponse
+ * //   status: "Active" || "Inactive" || "Pending" || "Failed", // required
+ * //   statusReason: "STRING_VALUE",
+ * //   lastUpdatedTimestamp: new Date("TIMESTAMP"), // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateEnrollmentConfigurationCommandInput - {@link UpdateEnrollmentConfigurationCommandInput}
+ * @returns {@link UpdateEnrollmentConfigurationCommandOutput}
+ * @see {@link UpdateEnrollmentConfigurationCommandInput} for command's `input` shape.
+ * @see {@link UpdateEnrollmentConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link ComputeOptimizerAutomationClientResolvedConfig | config} for ComputeOptimizerAutomationClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p> You do not have sufficient permissions to perform this action. </p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p> You are not authorized to perform this action. </p>
+ *
+ * @throws {@link IdempotencyTokenInUseException} (client fault)
+ *  <p> The specified client token is already in use. </p>
+ *
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
+ *  <p>Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p> An internal error occurred while processing the request. </p>
+ *
+ * @throws {@link InvalidParameterValueException} (client fault)
+ *  <p> One or more parameter values are not valid. </p>
+ *
+ * @throws {@link NotManagementAccountException} (client fault)
+ *  <p> The operation can only be performed by a management account. </p>
+ *
+ * @throws {@link OptInRequiredException} (client fault)
+ *  <p> The account must be opted in to Compute Optimizer Automation before performing this action. </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p> The specified resource was not found. </p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p> The service is temporarily unavailable. </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p> The request was denied due to request throttling. </p>
+ *
+ * @throws {@link ComputeOptimizerAutomationServiceException}
+ * <p>Base exception class for all service exceptions from ComputeOptimizerAutomation service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateEnrollmentConfigurationCommand extends UpdateEnrollmentConfigurationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateEnrollmentConfigurationRequest;
+            output: UpdateEnrollmentConfigurationResponse;
+        };
+        sdk: {
+            input: UpdateEnrollmentConfigurationCommandInput;
+            output: UpdateEnrollmentConfigurationCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,23 @@
+export * from "./AssociateAccountsCommand";
+export * from "./CreateAutomationRuleCommand";
+export * from "./DeleteAutomationRuleCommand";
+export * from "./DisassociateAccountsCommand";
+export * from "./GetAutomationEventCommand";
+export * from "./GetAutomationRuleCommand";
+export * from "./GetEnrollmentConfigurationCommand";
+export * from "./ListAccountsCommand";
+export * from "./ListAutomationEventStepsCommand";
+export * from "./ListAutomationEventSummariesCommand";
+export * from "./ListAutomationEventsCommand";
+export * from "./ListAutomationRulePreviewCommand";
+export * from "./ListAutomationRulePreviewSummariesCommand";
+export * from "./ListAutomationRulesCommand";
+export * from "./ListRecommendedActionSummariesCommand";
+export * from "./ListRecommendedActionsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./RollbackAutomationEventCommand";
+export * from "./StartAutomationEventCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateAutomationRuleCommand";
+export * from "./UpdateEnrollmentConfigurationCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,38 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | undefined | Provider<string | undefined>;
+    useDualstackEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+    readonly UseDualStack: {
+        readonly type: "builtInParams";
+        readonly name: "useDualstackEndpoint";
+    };
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string | undefined;
+    UseDualStack?: boolean | undefined;
+    UseFIPS?: boolean | undefined;
+    Endpoint?: string | undefined;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface ComputeOptimizerAutomationExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * <p> Automation is a feature within Amazon Web Services Compute Optimizer that enables you to apply optimization recommendations to your Amazon Web Services resources, reducing costs and improving performance. You can apply recommended actions directly or create automation rules that implement recommendations on a recurring schedule when they match your specified criteria. With automation rules, set criteria such as Amazon Web Services Region and Resource Tags to target specific geographies and workloads. Configure rules to run daily, weekly, or monthly, and Compute Optimizer continuously evaluates new recommendations against your criteria. Track automation events over time, examine detailed step history, estimate savings achieved, and reverse actions directly from Compute Optimizer when needed. </p>
+ *
+ * @packageDocumentation
+ */
+export * from "./ComputeOptimizerAutomationClient";
+export * from "./ComputeOptimizerAutomation";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { ComputeOptimizerAutomationExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models/enums";
+export * from "./models/errors";
+export type * from "./models/models_0";
+export { ComputeOptimizerAutomationServiceException } from "./models/ComputeOptimizerAutomationServiceException";

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

@@ -0,0 +1,14 @@
+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 ComputeOptimizerAutomation service.
+ */
+export declare class ComputeOptimizerAutomationServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1,178 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const OrganizationRuleMode: {
+    readonly ANY_ALLOWED: "AnyAllowed";
+    readonly NONE_ALLOWED: "NoneAllowed";
+};
+/**
+ * @public
+ */
+export type OrganizationRuleMode = (typeof OrganizationRuleMode)[keyof typeof OrganizationRuleMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const EnrollmentStatus: {
+    readonly ACTIVE: "Active";
+    readonly FAILED: "Failed";
+    readonly INACTIVE: "Inactive";
+    readonly PENDING: "Pending";
+};
+/**
+ * @public
+ */
+export type EnrollmentStatus = (typeof EnrollmentStatus)[keyof typeof EnrollmentStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const SavingsEstimationMode: {
+    readonly AFTER_DISCOUNT: "AfterDiscount";
+    readonly BEFORE_DISCOUNT: "BeforeDiscount";
+};
+/**
+ * @public
+ */
+export type SavingsEstimationMode = (typeof SavingsEstimationMode)[keyof typeof SavingsEstimationMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const EventStatus: {
+    readonly CANCELLED: "Cancelled";
+    readonly COMPLETE: "Complete";
+    readonly FAILED: "Failed";
+    readonly IN_PROGRESS: "InProgress";
+    readonly READY: "Ready";
+    readonly ROLLBACK_COMPLETE: "RollbackComplete";
+    readonly ROLLBACK_FAILED: "RollbackFailed";
+    readonly ROLLBACK_IN_PROGRESS: "RollbackInProgress";
+    readonly ROLLBACK_READY: "RollbackReady";
+};
+/**
+ * @public
+ */
+export type EventStatus = (typeof EventStatus)[keyof typeof EventStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const EventType: {
+    readonly SNAPSHOT_AND_DELETE_UNATTACHED_EBS_VOLUME: "SnapshotAndDeleteUnattachedEbsVolume";
+    readonly UPGRADE_EBS_VOLUME_TYPE: "UpgradeEbsVolumeType";
+};
+/**
+ * @public
+ */
+export type EventType = (typeof EventType)[keyof typeof EventType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ResourceType: {
+    readonly EBS_VOLUME: "EbsVolume";
+};
+/**
+ * @public
+ */
+export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
+/**
+ * @public
+ * @enum
+ */
+export declare const StepStatus: {
+    readonly COMPLETE: "Complete";
+    readonly FAILED: "Failed";
+    readonly IN_PROGRESS: "InProgress";
+    readonly READY: "Ready";
+};
+/**
+ * @public
+ */
+export type StepStatus = (typeof StepStatus)[keyof typeof StepStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const StepType: {
+    readonly CREATE_EBS_SNAPSHOT: "CreateEbsSnapshot";
+    readonly CREATE_EBS_VOLUME: "CreateEbsVolume";
+    readonly DELETE_EBS_VOLUME: "DeleteEbsVolume";
+    readonly MODIFY_EBS_VOLUME: "ModifyEbsVolume";
+};
+/**
+ * @public
+ */
+export type StepType = (typeof StepType)[keyof typeof StepType];
+/**
+ * @public
+ * @enum
+ */
+export declare const RuleApplyOrder: {
+    readonly AFTER_ACCOUNT_RULES: "AfterAccountRules";
+    readonly BEFORE_ACCOUNT_RULES: "BeforeAccountRules";
+};
+/**
+ * @public
+ */
+export type RuleApplyOrder = (typeof RuleApplyOrder)[keyof typeof RuleApplyOrder];
+/**
+ * @public
+ * @enum
+ */
+export declare const RecommendedActionType: {
+    readonly SNAPSHOT_AND_DELETE_UNATTACHED_EBS_VOLUME: "SnapshotAndDeleteUnattachedEbsVolume";
+    readonly UPGRADE_EBS_VOLUME_TYPE: "UpgradeEbsVolumeType";
+};
+/**
+ * @public
+ */
+export type RecommendedActionType = (typeof RecommendedActionType)[keyof typeof RecommendedActionType];
+/**
+ * @public
+ * @enum
+ */
+export declare const RuleType: {
+    readonly ACCOUNT_RULE: "AccountRule";
+    readonly ORGANIZATIONAL_RULE: "OrganizationRule";
+};
+/**
+ * @public
+ */
+export type RuleType = (typeof RuleType)[keyof typeof RuleType];
+/**
+ * @public
+ * @enum
+ */
+export declare const RuleStatus: {
+    readonly ACTIVE: "Active";
+    readonly INACTIVE: "Inactive";
+};
+/**
+ * @public
+ */
+export type RuleStatus = (typeof RuleStatus)[keyof typeof RuleStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const ComparisonOperator: {
+    readonly NUMERIC_EQUALS: "NumericEquals";
+    readonly NUMERIC_GREATER_THAN: "NumericGreaterThan";
+    readonly NUMERIC_GREATER_THAN_EQUALS: "NumericGreaterThanEquals";
+    readonly NUMERIC_LESS_THAN: "NumericLessThan";
+    readonly NUMERIC_LESS_THAN_EQUALS: "NumericLessThanEquals";
+    readonly NUMERIC_NOT_EQUALS: "NumericNotEquals";
+    readonly STRING_EQUALS: "StringEquals";
+    readonly STRING_EQUALS_IGNORE_CASE: "StringEqualsIgnoreCase";
+    readonly STRING_LIKE: "StringLike";
+    readonly STRING_NOT_EQUALS: "StringNotEquals";
+    readonly STRING_NOT_EQUALS_IGNORE_CASE: "StringNotEqualsIgnoreCase";
+    readonly STRING_NOT_LIKE: "StringNotLike";
+};
+/**
+ * @public
+ */
+export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof ComparisonOperator];

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

@@ -0,0 +1,146 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { ComputeOptimizerAutomationServiceException as __BaseException } from "./ComputeOptimizerAutomationServiceException";
+/**
+ * <p> You do not have sufficient permissions to perform this action. </p>
+ * @public
+ */
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+/**
+ * <p> You are not authorized to perform this action. </p>
+ * @public
+ */
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
+}
+/**
+ * <p> The specified client token is already in use. </p>
+ * @public
+ */
+export declare class IdempotencyTokenInUseException extends __BaseException {
+    readonly name: "IdempotencyTokenInUseException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<IdempotencyTokenInUseException, __BaseException>);
+}
+/**
+ * <p>Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.</p>
+ * @public
+ */
+export declare class IdempotentParameterMismatchException extends __BaseException {
+    readonly name: "IdempotentParameterMismatchException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
+}
+/**
+ * <p> An internal error occurred while processing the request. </p>
+ * @public
+ */
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * <p> One or more parameter values are not valid. </p>
+ * @public
+ */
+export declare class InvalidParameterValueException extends __BaseException {
+    readonly name: "InvalidParameterValueException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
+}
+/**
+ * <p> The operation can only be performed by a management account. </p>
+ * @public
+ */
+export declare class NotManagementAccountException extends __BaseException {
+    readonly name: "NotManagementAccountException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NotManagementAccountException, __BaseException>);
+}
+/**
+ * <p> The account must be opted in to Compute Optimizer Automation before performing this action. </p>
+ * @public
+ */
+export declare class OptInRequiredException extends __BaseException {
+    readonly name: "OptInRequiredException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<OptInRequiredException, __BaseException>);
+}
+/**
+ * <p> The service is temporarily unavailable. </p>
+ * @public
+ */
+export declare class ServiceUnavailableException extends __BaseException {
+    readonly name: "ServiceUnavailableException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
+}
+/**
+ * <p> The request was denied due to request throttling. </p>
+ * @public
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+/**
+ * <p> The specified resource was not found. </p>
+ * @public
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * <p> The request would exceed service quotas. </p>
+ * @public
+ */
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}