@aws-sdk/client-pricing-plan-manager 3.1099.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +244 -0
- package/dist-cjs/index.js +729 -0
- package/dist-es/PricingPlanManager.js +29 -0
- package/dist-es/PricingPlanManagerClient.js +47 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
- package/dist-es/commandBuilder.js +6 -0
- package/dist-es/commands/ApprovePaidSubscriptionCommand.js +4 -0
- package/dist-es/commands/AssociateResourcesToSubscriptionCommand.js +4 -0
- package/dist-es/commands/CancelSubscriptionChangeCommand.js +4 -0
- package/dist-es/commands/CancelSubscriptionCommand.js +4 -0
- package/dist-es/commands/CreateSubscriptionCommand.js +4 -0
- package/dist-es/commands/DisassociateResourcesFromSubscriptionCommand.js +4 -0
- package/dist-es/commands/GetSubscriptionCommand.js +4 -0
- package/dist-es/commands/ListSubscriptionsCommand.js +4 -0
- package/dist-es/commands/UpdateSubscriptionCommand.js +4 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/endpoint/EndpointParameters.js +9 -0
- package/dist-es/endpoint/bdd.js +19 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +10 -0
- package/dist-es/models/PricingPlanManagerServiceException.js +8 -0
- package/dist-es/models/enums.js +14 -0
- package/dist-es/models/errors.js +91 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListSubscriptionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/runtimeConfig.browser.js +29 -0
- package/dist-es/runtimeConfig.js +43 -0
- package/dist-es/runtimeConfig.native.js +9 -0
- package/dist-es/runtimeConfig.shared.js +40 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +258 -0
- package/dist-types/PricingPlanManager.d.ts +81 -0
- package/dist-types/PricingPlanManagerClient.d.ts +195 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commandBuilder.d.ts +18 -0
- package/dist-types/commands/ApprovePaidSubscriptionCommand.d.ts +138 -0
- package/dist-types/commands/AssociateResourcesToSubscriptionCommand.d.ts +145 -0
- package/dist-types/commands/CancelSubscriptionChangeCommand.d.ts +138 -0
- package/dist-types/commands/CancelSubscriptionCommand.d.ts +142 -0
- package/dist-types/commands/CreateSubscriptionCommand.d.ts +184 -0
- package/dist-types/commands/DisassociateResourcesFromSubscriptionCommand.d.ts +144 -0
- package/dist-types/commands/GetSubscriptionCommand.d.ts +132 -0
- package/dist-types/commands/ListSubscriptionsCommand.d.ts +135 -0
- package/dist-types/commands/UpdateSubscriptionCommand.d.ts +144 -0
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +38 -0
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +18 -0
- package/dist-types/models/PricingPlanManagerServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +38 -0
- package/dist-types/models/errors.d.ts +101 -0
- package/dist-types/models/models_0.d.ts +474 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListSubscriptionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/runtimeConfig.browser.d.ts +57 -0
- package/dist-types/runtimeConfig.d.ts +57 -0
- package/dist-types/runtimeConfig.native.d.ts +56 -0
- package/dist-types/runtimeConfig.shared.d.ts +28 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +46 -0
- package/dist-types/ts3.4/PricingPlanManager.d.ts +172 -0
- package/dist-types/ts3.4/PricingPlanManagerClient.d.ts +157 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +25 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
- package/dist-types/ts3.4/commandBuilder.d.ts +40 -0
- package/dist-types/ts3.4/commands/ApprovePaidSubscriptionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/AssociateResourcesToSubscriptionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CancelSubscriptionChangeCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CancelSubscriptionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateSubscriptionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DisassociateResourcesFromSubscriptionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetSubscriptionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListSubscriptionsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateSubscriptionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +39 -0
- package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +10 -0
- package/dist-types/ts3.4/index.d.ts +13 -0
- package/dist-types/ts3.4/models/PricingPlanManagerServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +17 -0
- package/dist-types/ts3.4/models/errors.d.ts +40 -0
- package/dist-types/ts3.4/models/models_0.d.ts +116 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist-types/ts3.4/pagination/ListSubscriptionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +99 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +31 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +41 -0
- package/package.json +69 -0
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ApprovePaidSubscriptionInput, ApprovePaidSubscriptionOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ApprovePaidSubscriptionCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ApprovePaidSubscriptionCommandInput extends ApprovePaidSubscriptionInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ApprovePaidSubscriptionCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ApprovePaidSubscriptionCommandOutput extends ApprovePaidSubscriptionOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ApprovePaidSubscriptionCommand_base: {
|
|
22
|
+
new (input: ApprovePaidSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<ApprovePaidSubscriptionCommandInput, ApprovePaidSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ApprovePaidSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<ApprovePaidSubscriptionCommandInput, ApprovePaidSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Approves a subscription that is in <code>PENDING_APPROVAL</code> status, activating it and starting billing.</p> <note> <p>This operation requires the current <code>ETag</code> value for concurrency control. Retrieve it from a previous <code>GetSubscription</code> or <code>ListSubscriptions</code> response.</p> </note>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { PricingPlanManagerClient, ApprovePaidSubscriptionCommand } from "@aws-sdk/client-pricing-plan-manager"; // ES Modules import
|
|
32
|
+
* // const { PricingPlanManagerClient, ApprovePaidSubscriptionCommand } = require("@aws-sdk/client-pricing-plan-manager"); // CommonJS import
|
|
33
|
+
* // import type { PricingPlanManagerClientConfig } from "@aws-sdk/client-pricing-plan-manager";
|
|
34
|
+
* const config = {}; // type is PricingPlanManagerClientConfig
|
|
35
|
+
* const client = new PricingPlanManagerClient(config);
|
|
36
|
+
* const input = { // ApprovePaidSubscriptionInput
|
|
37
|
+
* arn: "STRING_VALUE", // required
|
|
38
|
+
* ifMatch: "STRING_VALUE", // required
|
|
39
|
+
* clientToken: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ApprovePaidSubscriptionCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ApprovePaidSubscriptionOutput
|
|
44
|
+
* // subscription: { // Subscription
|
|
45
|
+
* // arn: "STRING_VALUE", // required
|
|
46
|
+
* // planFamily: "STRING_VALUE", // required
|
|
47
|
+
* // planTier: "STRING_VALUE", // required
|
|
48
|
+
* // usageLevel: "STRING_VALUE",
|
|
49
|
+
* // scheduledChange: { // ScheduledChange
|
|
50
|
+
* // changeType: "DOWNGRADE" || "CANCELLATION", // required
|
|
51
|
+
* // effectiveDate: new Date("TIMESTAMP"),
|
|
52
|
+
* // planTier: "STRING_VALUE",
|
|
53
|
+
* // usageLevel: "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // status: "PENDING_APPROVAL" || "ACTIVE" || "SYNC_IN_PROGRESS" || "FAILED", // required
|
|
56
|
+
* // statusReason: "STRING_VALUE",
|
|
57
|
+
* // resourceArns: [ // ResourceArns // required
|
|
58
|
+
* // "STRING_VALUE",
|
|
59
|
+
* // ],
|
|
60
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
61
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
62
|
+
* // },
|
|
63
|
+
* // eTag: "STRING_VALUE", // required
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param ApprovePaidSubscriptionCommandInput - {@link ApprovePaidSubscriptionCommandInput}
|
|
69
|
+
* @returns {@link ApprovePaidSubscriptionCommandOutput}
|
|
70
|
+
* @see {@link ApprovePaidSubscriptionCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link ApprovePaidSubscriptionCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link PricingPlanManagerClientResolvedConfig | config} for PricingPlanManagerClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ConflictException} (client fault)
|
|
78
|
+
* <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>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <p>An unexpected error occurred on the server. Retry the request.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
87
|
+
* <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <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>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link PricingPlanManagerServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from PricingPlanManager service.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
96
|
+
* @example Approve a pending paid subscription
|
|
97
|
+
* ```javascript
|
|
98
|
+
* //
|
|
99
|
+
* const input = {
|
|
100
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
101
|
+
* ifMatch: "1"
|
|
102
|
+
* };
|
|
103
|
+
* const command = new ApprovePaidSubscriptionCommand(input);
|
|
104
|
+
* const response = await client.send(command);
|
|
105
|
+
* /* response is
|
|
106
|
+
* {
|
|
107
|
+
* eTag: "2",
|
|
108
|
+
* subscription: {
|
|
109
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
110
|
+
* createdAt: "2025-01-15T10:30:00Z",
|
|
111
|
+
* planFamily: "CloudFront",
|
|
112
|
+
* planTier: "PRO",
|
|
113
|
+
* resourceArns: [
|
|
114
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
115
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
|
|
116
|
+
* ],
|
|
117
|
+
* status: "SYNC_IN_PROGRESS",
|
|
118
|
+
* updatedAt: "2025-01-15T10:35:00Z"
|
|
119
|
+
* }
|
|
120
|
+
* }
|
|
121
|
+
* *\/
|
|
122
|
+
* ```
|
|
123
|
+
*
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
export declare class ApprovePaidSubscriptionCommand extends ApprovePaidSubscriptionCommand_base {
|
|
127
|
+
/** @internal type navigation helper, not in runtime. */
|
|
128
|
+
protected static __types: {
|
|
129
|
+
api: {
|
|
130
|
+
input: ApprovePaidSubscriptionInput;
|
|
131
|
+
output: ApprovePaidSubscriptionOutput;
|
|
132
|
+
};
|
|
133
|
+
sdk: {
|
|
134
|
+
input: ApprovePaidSubscriptionCommandInput;
|
|
135
|
+
output: ApprovePaidSubscriptionCommandOutput;
|
|
136
|
+
};
|
|
137
|
+
};
|
|
138
|
+
}
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { AssociateResourcesToSubscriptionInput, AssociateResourcesToSubscriptionOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link AssociateResourcesToSubscriptionCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface AssociateResourcesToSubscriptionCommandInput extends AssociateResourcesToSubscriptionInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link AssociateResourcesToSubscriptionCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface AssociateResourcesToSubscriptionCommandOutput extends AssociateResourcesToSubscriptionOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const AssociateResourcesToSubscriptionCommand_base: {
|
|
22
|
+
new (input: AssociateResourcesToSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<AssociateResourcesToSubscriptionCommandInput, AssociateResourcesToSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: AssociateResourcesToSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<AssociateResourcesToSubscriptionCommandInput, AssociateResourcesToSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Adds one or more resources to an existing subscription. The subscription must be in an active state that is not pending other changes.</p> <note> <p>For subscriptions in the CloudFront plan family, the associated resources must include exactly one Amazon CloudFront distribution and one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones, and CloudFront KeyValueStores.</p> </note>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { PricingPlanManagerClient, AssociateResourcesToSubscriptionCommand } from "@aws-sdk/client-pricing-plan-manager"; // ES Modules import
|
|
32
|
+
* // const { PricingPlanManagerClient, AssociateResourcesToSubscriptionCommand } = require("@aws-sdk/client-pricing-plan-manager"); // CommonJS import
|
|
33
|
+
* // import type { PricingPlanManagerClientConfig } from "@aws-sdk/client-pricing-plan-manager";
|
|
34
|
+
* const config = {}; // type is PricingPlanManagerClientConfig
|
|
35
|
+
* const client = new PricingPlanManagerClient(config);
|
|
36
|
+
* const input = { // AssociateResourcesToSubscriptionInput
|
|
37
|
+
* arn: "STRING_VALUE", // required
|
|
38
|
+
* resourceArns: [ // ResourceArns // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* ifMatch: "STRING_VALUE", // required
|
|
42
|
+
* clientToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new AssociateResourcesToSubscriptionCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // AssociateResourcesToSubscriptionOutput
|
|
47
|
+
* // subscription: { // Subscription
|
|
48
|
+
* // arn: "STRING_VALUE", // required
|
|
49
|
+
* // planFamily: "STRING_VALUE", // required
|
|
50
|
+
* // planTier: "STRING_VALUE", // required
|
|
51
|
+
* // usageLevel: "STRING_VALUE",
|
|
52
|
+
* // scheduledChange: { // ScheduledChange
|
|
53
|
+
* // changeType: "DOWNGRADE" || "CANCELLATION", // required
|
|
54
|
+
* // effectiveDate: new Date("TIMESTAMP"),
|
|
55
|
+
* // planTier: "STRING_VALUE",
|
|
56
|
+
* // usageLevel: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // status: "PENDING_APPROVAL" || "ACTIVE" || "SYNC_IN_PROGRESS" || "FAILED", // required
|
|
59
|
+
* // statusReason: "STRING_VALUE",
|
|
60
|
+
* // resourceArns: [ // ResourceArns // required
|
|
61
|
+
* // "STRING_VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
64
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
65
|
+
* // },
|
|
66
|
+
* // eTag: "STRING_VALUE", // required
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param AssociateResourcesToSubscriptionCommandInput - {@link AssociateResourcesToSubscriptionCommandInput}
|
|
72
|
+
* @returns {@link AssociateResourcesToSubscriptionCommandOutput}
|
|
73
|
+
* @see {@link AssociateResourcesToSubscriptionCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link AssociateResourcesToSubscriptionCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link PricingPlanManagerClientResolvedConfig | config} for PricingPlanManagerClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
78
|
+
* <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ConflictException} (client fault)
|
|
81
|
+
* <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>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InternalServerException} (server fault)
|
|
84
|
+
* <p>An unexpected error occurred on the server. Retry the request.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
87
|
+
* <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
90
|
+
* <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ValidationException} (client fault)
|
|
93
|
+
* <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>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link PricingPlanManagerServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from PricingPlanManager service.</p>
|
|
97
|
+
*
|
|
98
|
+
*
|
|
99
|
+
* @example Associate additional resources to a subscription
|
|
100
|
+
* ```javascript
|
|
101
|
+
* //
|
|
102
|
+
* const input = {
|
|
103
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
104
|
+
* ifMatch: "1",
|
|
105
|
+
* resourceArns: [
|
|
106
|
+
* "arn:aws:route53:::hostedzone/Z0123456789EXAMPLE"
|
|
107
|
+
* ]
|
|
108
|
+
* };
|
|
109
|
+
* const command = new AssociateResourcesToSubscriptionCommand(input);
|
|
110
|
+
* const response = await client.send(command);
|
|
111
|
+
* /* response is
|
|
112
|
+
* {
|
|
113
|
+
* eTag: "2",
|
|
114
|
+
* subscription: {
|
|
115
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
116
|
+
* createdAt: "2025-01-15T10:30:00Z",
|
|
117
|
+
* planFamily: "CloudFront",
|
|
118
|
+
* planTier: "PRO",
|
|
119
|
+
* resourceArns: [
|
|
120
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
121
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4",
|
|
122
|
+
* "arn:aws:route53:::hostedzone/Z0123456789EXAMPLE"
|
|
123
|
+
* ],
|
|
124
|
+
* status: "SYNC_IN_PROGRESS",
|
|
125
|
+
* updatedAt: "2025-01-18T11:00:00Z"
|
|
126
|
+
* }
|
|
127
|
+
* }
|
|
128
|
+
* *\/
|
|
129
|
+
* ```
|
|
130
|
+
*
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
export declare class AssociateResourcesToSubscriptionCommand extends AssociateResourcesToSubscriptionCommand_base {
|
|
134
|
+
/** @internal type navigation helper, not in runtime. */
|
|
135
|
+
protected static __types: {
|
|
136
|
+
api: {
|
|
137
|
+
input: AssociateResourcesToSubscriptionInput;
|
|
138
|
+
output: AssociateResourcesToSubscriptionOutput;
|
|
139
|
+
};
|
|
140
|
+
sdk: {
|
|
141
|
+
input: AssociateResourcesToSubscriptionCommandInput;
|
|
142
|
+
output: AssociateResourcesToSubscriptionCommandOutput;
|
|
143
|
+
};
|
|
144
|
+
};
|
|
145
|
+
}
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CancelSubscriptionChangeInput, CancelSubscriptionChangeOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CancelSubscriptionChangeCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CancelSubscriptionChangeCommandInput extends CancelSubscriptionChangeInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CancelSubscriptionChangeCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CancelSubscriptionChangeCommandOutput extends CancelSubscriptionChangeOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CancelSubscriptionChangeCommand_base: {
|
|
22
|
+
new (input: CancelSubscriptionChangeCommandInput): import("@smithy/core/client").CommandImpl<CancelSubscriptionChangeCommandInput, CancelSubscriptionChangeCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CancelSubscriptionChangeCommandInput): import("@smithy/core/client").CommandImpl<CancelSubscriptionChangeCommandInput, CancelSubscriptionChangeCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation. The subscription returns to its state before the change was scheduled.</p> <note> <p>You cannot cancel a scheduled change close to its effective date. If the change is within the processing window, this operation returns an error.</p> </note>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { PricingPlanManagerClient, CancelSubscriptionChangeCommand } from "@aws-sdk/client-pricing-plan-manager"; // ES Modules import
|
|
32
|
+
* // const { PricingPlanManagerClient, CancelSubscriptionChangeCommand } = require("@aws-sdk/client-pricing-plan-manager"); // CommonJS import
|
|
33
|
+
* // import type { PricingPlanManagerClientConfig } from "@aws-sdk/client-pricing-plan-manager";
|
|
34
|
+
* const config = {}; // type is PricingPlanManagerClientConfig
|
|
35
|
+
* const client = new PricingPlanManagerClient(config);
|
|
36
|
+
* const input = { // CancelSubscriptionChangeInput
|
|
37
|
+
* arn: "STRING_VALUE", // required
|
|
38
|
+
* ifMatch: "STRING_VALUE", // required
|
|
39
|
+
* clientToken: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new CancelSubscriptionChangeCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // CancelSubscriptionChangeOutput
|
|
44
|
+
* // subscription: { // Subscription
|
|
45
|
+
* // arn: "STRING_VALUE", // required
|
|
46
|
+
* // planFamily: "STRING_VALUE", // required
|
|
47
|
+
* // planTier: "STRING_VALUE", // required
|
|
48
|
+
* // usageLevel: "STRING_VALUE",
|
|
49
|
+
* // scheduledChange: { // ScheduledChange
|
|
50
|
+
* // changeType: "DOWNGRADE" || "CANCELLATION", // required
|
|
51
|
+
* // effectiveDate: new Date("TIMESTAMP"),
|
|
52
|
+
* // planTier: "STRING_VALUE",
|
|
53
|
+
* // usageLevel: "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // status: "PENDING_APPROVAL" || "ACTIVE" || "SYNC_IN_PROGRESS" || "FAILED", // required
|
|
56
|
+
* // statusReason: "STRING_VALUE",
|
|
57
|
+
* // resourceArns: [ // ResourceArns // required
|
|
58
|
+
* // "STRING_VALUE",
|
|
59
|
+
* // ],
|
|
60
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
61
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
62
|
+
* // },
|
|
63
|
+
* // eTag: "STRING_VALUE", // required
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param CancelSubscriptionChangeCommandInput - {@link CancelSubscriptionChangeCommandInput}
|
|
69
|
+
* @returns {@link CancelSubscriptionChangeCommandOutput}
|
|
70
|
+
* @see {@link CancelSubscriptionChangeCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link CancelSubscriptionChangeCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link PricingPlanManagerClientResolvedConfig | config} for PricingPlanManagerClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ConflictException} (client fault)
|
|
78
|
+
* <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>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <p>An unexpected error occurred on the server. Retry the request.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
87
|
+
* <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <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>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link PricingPlanManagerServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from PricingPlanManager service.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
96
|
+
* @example Cancel a pending subscription change
|
|
97
|
+
* ```javascript
|
|
98
|
+
* //
|
|
99
|
+
* const input = {
|
|
100
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
101
|
+
* ifMatch: "3"
|
|
102
|
+
* };
|
|
103
|
+
* const command = new CancelSubscriptionChangeCommand(input);
|
|
104
|
+
* const response = await client.send(command);
|
|
105
|
+
* /* response is
|
|
106
|
+
* {
|
|
107
|
+
* eTag: "4",
|
|
108
|
+
* subscription: {
|
|
109
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
110
|
+
* createdAt: "2025-01-15T10:30:00Z",
|
|
111
|
+
* planFamily: "CloudFront",
|
|
112
|
+
* planTier: "BUSINESS",
|
|
113
|
+
* resourceArns: [
|
|
114
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
115
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
|
|
116
|
+
* ],
|
|
117
|
+
* status: "ACTIVE",
|
|
118
|
+
* updatedAt: "2025-01-17T09:00:00Z"
|
|
119
|
+
* }
|
|
120
|
+
* }
|
|
121
|
+
* *\/
|
|
122
|
+
* ```
|
|
123
|
+
*
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
export declare class CancelSubscriptionChangeCommand extends CancelSubscriptionChangeCommand_base {
|
|
127
|
+
/** @internal type navigation helper, not in runtime. */
|
|
128
|
+
protected static __types: {
|
|
129
|
+
api: {
|
|
130
|
+
input: CancelSubscriptionChangeInput;
|
|
131
|
+
output: CancelSubscriptionChangeOutput;
|
|
132
|
+
};
|
|
133
|
+
sdk: {
|
|
134
|
+
input: CancelSubscriptionChangeCommandInput;
|
|
135
|
+
output: CancelSubscriptionChangeCommandOutput;
|
|
136
|
+
};
|
|
137
|
+
};
|
|
138
|
+
}
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CancelSubscriptionInput, CancelSubscriptionOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CancelSubscriptionCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CancelSubscriptionCommandInput extends CancelSubscriptionInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CancelSubscriptionCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CancelSubscriptionCommandOutput extends CancelSubscriptionOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CancelSubscriptionCommand_base: {
|
|
22
|
+
new (input: CancelSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<CancelSubscriptionCommandInput, CancelSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CancelSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<CancelSubscriptionCommandInput, CancelSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Cancels a flat-rate pricing subscription.</p> <note> <p>For active subscriptions, the cancellation is scheduled to take effect at the end of the current billing period. The subscription remains active until that date. To revert a pending cancellation, use <code>CancelSubscriptionChange</code>.</p> <p>For subscriptions in <code>PENDING_APPROVAL</code> status, the subscription is deleted immediately without scheduling.</p> </note>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { PricingPlanManagerClient, CancelSubscriptionCommand } from "@aws-sdk/client-pricing-plan-manager"; // ES Modules import
|
|
32
|
+
* // const { PricingPlanManagerClient, CancelSubscriptionCommand } = require("@aws-sdk/client-pricing-plan-manager"); // CommonJS import
|
|
33
|
+
* // import type { PricingPlanManagerClientConfig } from "@aws-sdk/client-pricing-plan-manager";
|
|
34
|
+
* const config = {}; // type is PricingPlanManagerClientConfig
|
|
35
|
+
* const client = new PricingPlanManagerClient(config);
|
|
36
|
+
* const input = { // CancelSubscriptionInput
|
|
37
|
+
* arn: "STRING_VALUE", // required
|
|
38
|
+
* ifMatch: "STRING_VALUE", // required
|
|
39
|
+
* clientToken: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new CancelSubscriptionCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // CancelSubscriptionOutput
|
|
44
|
+
* // subscription: { // Subscription
|
|
45
|
+
* // arn: "STRING_VALUE", // required
|
|
46
|
+
* // planFamily: "STRING_VALUE", // required
|
|
47
|
+
* // planTier: "STRING_VALUE", // required
|
|
48
|
+
* // usageLevel: "STRING_VALUE",
|
|
49
|
+
* // scheduledChange: { // ScheduledChange
|
|
50
|
+
* // changeType: "DOWNGRADE" || "CANCELLATION", // required
|
|
51
|
+
* // effectiveDate: new Date("TIMESTAMP"),
|
|
52
|
+
* // planTier: "STRING_VALUE",
|
|
53
|
+
* // usageLevel: "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // status: "PENDING_APPROVAL" || "ACTIVE" || "SYNC_IN_PROGRESS" || "FAILED", // required
|
|
56
|
+
* // statusReason: "STRING_VALUE",
|
|
57
|
+
* // resourceArns: [ // ResourceArns // required
|
|
58
|
+
* // "STRING_VALUE",
|
|
59
|
+
* // ],
|
|
60
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
61
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
62
|
+
* // },
|
|
63
|
+
* // eTag: "STRING_VALUE", // required
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param CancelSubscriptionCommandInput - {@link CancelSubscriptionCommandInput}
|
|
69
|
+
* @returns {@link CancelSubscriptionCommandOutput}
|
|
70
|
+
* @see {@link CancelSubscriptionCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link CancelSubscriptionCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link PricingPlanManagerClientResolvedConfig | config} for PricingPlanManagerClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ConflictException} (client fault)
|
|
78
|
+
* <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>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <p>An unexpected error occurred on the server. Retry the request.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
87
|
+
* <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <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>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link PricingPlanManagerServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from PricingPlanManager service.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
96
|
+
* @example Cancel a subscription
|
|
97
|
+
* ```javascript
|
|
98
|
+
* //
|
|
99
|
+
* const input = {
|
|
100
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
101
|
+
* ifMatch: "2"
|
|
102
|
+
* };
|
|
103
|
+
* const command = new CancelSubscriptionCommand(input);
|
|
104
|
+
* const response = await client.send(command);
|
|
105
|
+
* /* response is
|
|
106
|
+
* {
|
|
107
|
+
* eTag: "3",
|
|
108
|
+
* subscription: {
|
|
109
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
110
|
+
* createdAt: "2025-01-15T10:30:00Z",
|
|
111
|
+
* planFamily: "CloudFront",
|
|
112
|
+
* planTier: "BUSINESS",
|
|
113
|
+
* resourceArns: [
|
|
114
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
115
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
|
|
116
|
+
* ],
|
|
117
|
+
* scheduledChange: {
|
|
118
|
+
* changeType: "CANCELLATION",
|
|
119
|
+
* effectiveDate: "2025-02-01T00:00:00Z"
|
|
120
|
+
* },
|
|
121
|
+
* status: "ACTIVE",
|
|
122
|
+
* updatedAt: "2025-01-16T12:00:00Z"
|
|
123
|
+
* }
|
|
124
|
+
* }
|
|
125
|
+
* *\/
|
|
126
|
+
* ```
|
|
127
|
+
*
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
export declare class CancelSubscriptionCommand extends CancelSubscriptionCommand_base {
|
|
131
|
+
/** @internal type navigation helper, not in runtime. */
|
|
132
|
+
protected static __types: {
|
|
133
|
+
api: {
|
|
134
|
+
input: CancelSubscriptionInput;
|
|
135
|
+
output: CancelSubscriptionOutput;
|
|
136
|
+
};
|
|
137
|
+
sdk: {
|
|
138
|
+
input: CancelSubscriptionCommandInput;
|
|
139
|
+
output: CancelSubscriptionCommandOutput;
|
|
140
|
+
};
|
|
141
|
+
};
|
|
142
|
+
}
|