@aws-sdk/client-pricing-plan-manager 3.1099.0

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

@@ -0,0 +1,144 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateSubscriptionInput, UpdateSubscriptionOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link UpdateSubscriptionCommand}.
+ */
+export interface UpdateSubscriptionCommandInput extends UpdateSubscriptionInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateSubscriptionCommand}.
+ */
+export interface UpdateSubscriptionCommandOutput extends UpdateSubscriptionOutput, __MetadataBearer {
+}
+declare const UpdateSubscriptionCommand_base: {
+    new (input: UpdateSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<UpdateSubscriptionCommandInput, UpdateSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: UpdateSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<UpdateSubscriptionCommandInput, UpdateSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Changes the plan tier of an existing subscription.</p> <note> <p>Upgrades take effect immediately. Downgrades are scheduled and the current tier remains unchanged until the end of the billing cycle (calendar month). You cannot update a subscription while a scheduled change is pending. To make a new change, first cancel the pending change using <code>CancelSubscriptionChange</code>.</p> <p>This operation replaces the plan tier value. If you omit the optional <code>usageLevel</code> field, it is reset to the default.</p> </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PricingPlanManagerClient, UpdateSubscriptionCommand } from "@aws-sdk/client-pricing-plan-manager"; // ES Modules import
+ * // const { PricingPlanManagerClient, UpdateSubscriptionCommand } = require("@aws-sdk/client-pricing-plan-manager"); // CommonJS import
+ * // import type { PricingPlanManagerClientConfig } from "@aws-sdk/client-pricing-plan-manager";
+ * const config = {}; // type is PricingPlanManagerClientConfig
+ * const client = new PricingPlanManagerClient(config);
+ * const input = { // UpdateSubscriptionInput
+ *   arn: "STRING_VALUE", // required
+ *   planTier: "STRING_VALUE", // required
+ *   usageLevel: "STRING_VALUE",
+ *   ifMatch: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateSubscriptionCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateSubscriptionOutput
+ * //   subscription: { // Subscription
+ * //     arn: "STRING_VALUE", // required
+ * //     planFamily: "STRING_VALUE", // required
+ * //     planTier: "STRING_VALUE", // required
+ * //     usageLevel: "STRING_VALUE",
+ * //     scheduledChange: { // ScheduledChange
+ * //       changeType: "DOWNGRADE" || "CANCELLATION", // required
+ * //       effectiveDate: new Date("TIMESTAMP"),
+ * //       planTier: "STRING_VALUE",
+ * //       usageLevel: "STRING_VALUE",
+ * //     },
+ * //     status: "PENDING_APPROVAL" || "ACTIVE" || "SYNC_IN_PROGRESS" || "FAILED", // required
+ * //     statusReason: "STRING_VALUE",
+ * //     resourceArns: [ // ResourceArns // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     createdAt: new Date("TIMESTAMP"), // required
+ * //     updatedAt: new Date("TIMESTAMP"), // required
+ * //   },
+ * //   eTag: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateSubscriptionCommandInput - {@link UpdateSubscriptionCommandInput}
+ * @returns {@link UpdateSubscriptionCommandOutput}
+ * @see {@link UpdateSubscriptionCommandInput} for command's `input` shape.
+ * @see {@link UpdateSubscriptionCommandOutput} for command's `response` shape.
+ * @see {@link PricingPlanManagerClientResolvedConfig | config} for PricingPlanManagerClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request conflicts with the current state of the resource. This typically occurs when the <code>ETag</code> value in the <code>If-Match</code> header does not match the current version of the subscription. Retrieve the latest version and retry.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unexpected error occurred on the server. Retry the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request would exceed a service limit. You have reached the maximum number of subscriptions allowed for your account.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.</p>
+ *
+ * @throws {@link PricingPlanManagerServiceException}
+ * <p>Base exception class for all service exceptions from PricingPlanManager service.</p>
+ *
+ *
+ * @example Update a subscription plan tier
+ * ```javascript
+ * //
+ * const input = {
+ *   arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
+ *   ifMatch: "1",
+ *   planTier: "BUSINESS"
+ * };
+ * const command = new UpdateSubscriptionCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   eTag: "2",
+ *   subscription: {
+ *     arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
+ *     createdAt: "2025-01-15T10:30:00Z",
+ *     planFamily: "CloudFront",
+ *     planTier: "BUSINESS",
+ *     resourceArns: [
+ *       "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
+ *       "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
+ *     ],
+ *     status: "SYNC_IN_PROGRESS",
+ *     updatedAt: "2025-01-16T08:00:00Z"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class UpdateSubscriptionCommand extends UpdateSubscriptionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateSubscriptionInput;
+            output: UpdateSubscriptionOutput;
+        };
+        sdk: {
+            input: UpdateSubscriptionCommandInput;
+            output: UpdateSubscriptionCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,9 @@
+export * from "./ApprovePaidSubscriptionCommand";
+export * from "./AssociateResourcesToSubscriptionCommand";
+export * from "./CancelSubscriptionChangeCommand";
+export * from "./CancelSubscriptionCommand";
+export * from "./CreateSubscriptionCommand";
+export * from "./DisassociateResourcesFromSubscriptionCommand";
+export * from "./GetSubscriptionCommand";
+export * from "./ListSubscriptionsCommand";
+export * from "./UpdateSubscriptionCommand";

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

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

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

@@ -0,0 +1,2 @@
+import { BinaryDecisionDiagram } from "@smithy/core/endpoints";
+export declare const bdd: BinaryDecisionDiagram;

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

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

package/dist-types/extensionConfiguration.d.ts

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

package/dist-types/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * <p>Manages flat-rate pricing subscriptions for supported AWS services. Use this API to create, approve, update, and cancel subscriptions; associate and disassociate resources; and retrieve subscription details. With a flat-rate pricing subscription, you pay a fixed recurring fee for eligible resources instead of usage-based pricing.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./PricingPlanManagerClient";
+export * from "./PricingPlanManager";
+export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { PricingPlanManagerExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export { Command as $Command } from "@smithy/core/client";
+export * from "./schemas/schemas_0";
+export * from "./pagination";
+export * from "./models/enums";
+export * from "./models/errors";
+export * from "./models/models_0";
+export { PricingPlanManagerServiceException } from "./models/PricingPlanManagerServiceException";

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

@@ -0,0 +1,14 @@
+import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/core/client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from PricingPlanManager service.
+ */
+export declare class PricingPlanManagerServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1,38 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const ApprovalMode: {
+    readonly IMMEDIATE: "IMMEDIATE";
+    readonly MANUAL: "MANUAL";
+};
+/**
+ * @public
+ */
+export type ApprovalMode = (typeof ApprovalMode)[keyof typeof ApprovalMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const ScheduledChangeType: {
+    readonly CANCELLATION: "CANCELLATION";
+    readonly DOWNGRADE: "DOWNGRADE";
+};
+/**
+ * @public
+ */
+export type ScheduledChangeType = (typeof ScheduledChangeType)[keyof typeof ScheduledChangeType];
+/**
+ * @public
+ * @enum
+ */
+export declare const Status: {
+    readonly ACTIVE: "ACTIVE";
+    readonly FAILED: "FAILED";
+    readonly PENDING_APPROVAL: "PENDING_APPROVAL";
+    readonly SYNC_IN_PROGRESS: "SYNC_IN_PROGRESS";
+};
+/**
+ * @public
+ */
+export type Status = (typeof Status)[keyof typeof Status];

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

@@ -0,0 +1,101 @@
+import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
+import { PricingPlanManagerServiceException as __BaseException } from "./PricingPlanManagerServiceException";
+/**
+ * <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
+ * @public
+ */
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+/**
+ * <p>The request conflicts with the current state of the resource. This typically occurs when the <code>ETag</code> value in the <code>If-Match</code> header does not match the current version of the subscription. Retrieve the latest version and retry.</p>
+ * @public
+ */
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    /**
+     * <p>The identifier of the resource that has a conflicting state.</p>
+     * @public
+     */
+    resourceId: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+/**
+ * <p>An unexpected error occurred on the server. Retry the request.</p>
+ * @public
+ */
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
+ * @public
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * <p>The identifier of the resource that was not found.</p>
+     * @public
+     */
+    resourceId: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
+ * @public
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+/**
+ * <p>The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.</p>
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * <p>The identifier of the resource that failed validation.</p>
+     * @public
+     */
+    resourceId?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * <p>The request would exceed a service limit. You have reached the maximum number of subscriptions allowed for your account.</p>
+ * @public
+ */
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}