@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,184 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CreateSubscriptionInput, CreateSubscriptionOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CreateSubscriptionCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CreateSubscriptionCommandInput extends CreateSubscriptionInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CreateSubscriptionCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateSubscriptionCommandOutput extends CreateSubscriptionOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CreateSubscriptionCommand_base: {
|
|
22
|
+
new (input: CreateSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<CreateSubscriptionCommandInput, CreateSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CreateSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<CreateSubscriptionCommandInput, CreateSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Creates a flat-rate pricing subscription for the specified resources.</p> <note> <p>When <code>approvalMode</code> is set to <code>MANUAL</code>, paid-tier subscriptions are created in <code>PENDING_APPROVAL</code> status and require a separate <code>ApprovePaidSubscription</code> call before billing starts. Free-tier subscriptions are always activated immediately regardless of approval mode.</p> <p>When <code>approvalMode</code> is set to <code>IMMEDIATE</code> or is not specified, the subscription is activated immediately.</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, CreateSubscriptionCommand } from "@aws-sdk/client-pricing-plan-manager"; // ES Modules import
|
|
32
|
+
* // const { PricingPlanManagerClient, CreateSubscriptionCommand } = 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 = { // CreateSubscriptionInput
|
|
37
|
+
* planFamily: "STRING_VALUE", // required
|
|
38
|
+
* planTier: "STRING_VALUE", // required
|
|
39
|
+
* usageLevel: "STRING_VALUE",
|
|
40
|
+
* resourceArns: [ // ResourceArns // required
|
|
41
|
+
* "STRING_VALUE",
|
|
42
|
+
* ],
|
|
43
|
+
* approvalMode: "MANUAL" || "IMMEDIATE",
|
|
44
|
+
* clientToken: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new CreateSubscriptionCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // CreateSubscriptionOutput
|
|
49
|
+
* // subscription: { // Subscription
|
|
50
|
+
* // arn: "STRING_VALUE", // required
|
|
51
|
+
* // planFamily: "STRING_VALUE", // required
|
|
52
|
+
* // planTier: "STRING_VALUE", // required
|
|
53
|
+
* // usageLevel: "STRING_VALUE",
|
|
54
|
+
* // scheduledChange: { // ScheduledChange
|
|
55
|
+
* // changeType: "DOWNGRADE" || "CANCELLATION", // required
|
|
56
|
+
* // effectiveDate: new Date("TIMESTAMP"),
|
|
57
|
+
* // planTier: "STRING_VALUE",
|
|
58
|
+
* // usageLevel: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // status: "PENDING_APPROVAL" || "ACTIVE" || "SYNC_IN_PROGRESS" || "FAILED", // required
|
|
61
|
+
* // statusReason: "STRING_VALUE",
|
|
62
|
+
* // resourceArns: [ // ResourceArns // required
|
|
63
|
+
* // "STRING_VALUE",
|
|
64
|
+
* // ],
|
|
65
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
66
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
67
|
+
* // },
|
|
68
|
+
* // eTag: "STRING_VALUE", // required
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param CreateSubscriptionCommandInput - {@link CreateSubscriptionCommandInput}
|
|
74
|
+
* @returns {@link CreateSubscriptionCommandOutput}
|
|
75
|
+
* @see {@link CreateSubscriptionCommandInput} for command's `input` shape.
|
|
76
|
+
* @see {@link CreateSubscriptionCommandOutput} for command's `response` shape.
|
|
77
|
+
* @see {@link PricingPlanManagerClientResolvedConfig | config} for PricingPlanManagerClient's `config` shape.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
80
|
+
* <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ConflictException} (client fault)
|
|
83
|
+
* <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>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalServerException} (server fault)
|
|
86
|
+
* <p>An unexpected error occurred on the server. Retry the request.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
89
|
+
* <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
92
|
+
* <p>The request would exceed a service limit. You have reached the maximum number of subscriptions allowed for your account.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
95
|
+
* <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ValidationException} (client fault)
|
|
98
|
+
* <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>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link PricingPlanManagerServiceException}
|
|
101
|
+
* <p>Base exception class for all service exceptions from PricingPlanManager service.</p>
|
|
102
|
+
*
|
|
103
|
+
*
|
|
104
|
+
* @example Create a flat-rate pricing subscription (deferred approval)
|
|
105
|
+
* ```javascript
|
|
106
|
+
* //
|
|
107
|
+
* const input = {
|
|
108
|
+
* approvalMode: "MANUAL",
|
|
109
|
+
* planFamily: "CloudFront",
|
|
110
|
+
* planTier: "PRO",
|
|
111
|
+
* resourceArns: [
|
|
112
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
113
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
|
|
114
|
+
* ]
|
|
115
|
+
* };
|
|
116
|
+
* const command = new CreateSubscriptionCommand(input);
|
|
117
|
+
* const response = await client.send(command);
|
|
118
|
+
* /* response is
|
|
119
|
+
* {
|
|
120
|
+
* eTag: "1",
|
|
121
|
+
* subscription: {
|
|
122
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
123
|
+
* createdAt: "2025-01-15T10:30:00Z",
|
|
124
|
+
* planFamily: "CloudFront",
|
|
125
|
+
* planTier: "PRO",
|
|
126
|
+
* resourceArns: [
|
|
127
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
128
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
|
|
129
|
+
* ],
|
|
130
|
+
* status: "PENDING_APPROVAL",
|
|
131
|
+
* updatedAt: "2025-01-15T10:30:00Z"
|
|
132
|
+
* }
|
|
133
|
+
* }
|
|
134
|
+
* *\/
|
|
135
|
+
* ```
|
|
136
|
+
*
|
|
137
|
+
* @example Create a subscription with approval mode
|
|
138
|
+
* ```javascript
|
|
139
|
+
* //
|
|
140
|
+
* const input = {
|
|
141
|
+
* approvalMode: "IMMEDIATE",
|
|
142
|
+
* planFamily: "CloudFront",
|
|
143
|
+
* planTier: "PRO",
|
|
144
|
+
* resourceArns: [
|
|
145
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
146
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
|
|
147
|
+
* ]
|
|
148
|
+
* };
|
|
149
|
+
* const command = new CreateSubscriptionCommand(input);
|
|
150
|
+
* const response = await client.send(command);
|
|
151
|
+
* /* response is
|
|
152
|
+
* {
|
|
153
|
+
* eTag: "1",
|
|
154
|
+
* subscription: {
|
|
155
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
156
|
+
* createdAt: "2025-01-15T10:30:00Z",
|
|
157
|
+
* planFamily: "CloudFront",
|
|
158
|
+
* planTier: "PRO",
|
|
159
|
+
* resourceArns: [
|
|
160
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
161
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
|
|
162
|
+
* ],
|
|
163
|
+
* status: "SYNC_IN_PROGRESS",
|
|
164
|
+
* updatedAt: "2025-01-15T10:30:00Z"
|
|
165
|
+
* }
|
|
166
|
+
* }
|
|
167
|
+
* *\/
|
|
168
|
+
* ```
|
|
169
|
+
*
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
export declare class CreateSubscriptionCommand extends CreateSubscriptionCommand_base {
|
|
173
|
+
/** @internal type navigation helper, not in runtime. */
|
|
174
|
+
protected static __types: {
|
|
175
|
+
api: {
|
|
176
|
+
input: CreateSubscriptionInput;
|
|
177
|
+
output: CreateSubscriptionOutput;
|
|
178
|
+
};
|
|
179
|
+
sdk: {
|
|
180
|
+
input: CreateSubscriptionCommandInput;
|
|
181
|
+
output: CreateSubscriptionCommandOutput;
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DisassociateResourcesFromSubscriptionInput, DisassociateResourcesFromSubscriptionOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DisassociateResourcesFromSubscriptionCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DisassociateResourcesFromSubscriptionCommandInput extends DisassociateResourcesFromSubscriptionInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DisassociateResourcesFromSubscriptionCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DisassociateResourcesFromSubscriptionCommandOutput extends DisassociateResourcesFromSubscriptionOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DisassociateResourcesFromSubscriptionCommand_base: {
|
|
22
|
+
new (input: DisassociateResourcesFromSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<DisassociateResourcesFromSubscriptionCommandInput, DisassociateResourcesFromSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DisassociateResourcesFromSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<DisassociateResourcesFromSubscriptionCommandInput, DisassociateResourcesFromSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Removes one or more resources from an existing subscription.</p> <note> <p>For subscriptions in the CloudFront plan family, the associated resources must always include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You cannot remove these required resources.</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, DisassociateResourcesFromSubscriptionCommand } from "@aws-sdk/client-pricing-plan-manager"; // ES Modules import
|
|
32
|
+
* // const { PricingPlanManagerClient, DisassociateResourcesFromSubscriptionCommand } = 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 = { // DisassociateResourcesFromSubscriptionInput
|
|
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 DisassociateResourcesFromSubscriptionCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // DisassociateResourcesFromSubscriptionOutput
|
|
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 DisassociateResourcesFromSubscriptionCommandInput - {@link DisassociateResourcesFromSubscriptionCommandInput}
|
|
72
|
+
* @returns {@link DisassociateResourcesFromSubscriptionCommandOutput}
|
|
73
|
+
* @see {@link DisassociateResourcesFromSubscriptionCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link DisassociateResourcesFromSubscriptionCommandOutput} 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 Remove a resource from a subscription
|
|
100
|
+
* ```javascript
|
|
101
|
+
* //
|
|
102
|
+
* const input = {
|
|
103
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
104
|
+
* ifMatch: "2",
|
|
105
|
+
* resourceArns: [
|
|
106
|
+
* "arn:aws:route53:::hostedzone/Z0123456789EXAMPLE"
|
|
107
|
+
* ]
|
|
108
|
+
* };
|
|
109
|
+
* const command = new DisassociateResourcesFromSubscriptionCommand(input);
|
|
110
|
+
* const response = await client.send(command);
|
|
111
|
+
* /* response is
|
|
112
|
+
* {
|
|
113
|
+
* eTag: "3",
|
|
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
|
+
* ],
|
|
123
|
+
* status: "SYNC_IN_PROGRESS",
|
|
124
|
+
* updatedAt: "2025-01-18T15:00:00Z"
|
|
125
|
+
* }
|
|
126
|
+
* }
|
|
127
|
+
* *\/
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export declare class DisassociateResourcesFromSubscriptionCommand extends DisassociateResourcesFromSubscriptionCommand_base {
|
|
133
|
+
/** @internal type navigation helper, not in runtime. */
|
|
134
|
+
protected static __types: {
|
|
135
|
+
api: {
|
|
136
|
+
input: DisassociateResourcesFromSubscriptionInput;
|
|
137
|
+
output: DisassociateResourcesFromSubscriptionOutput;
|
|
138
|
+
};
|
|
139
|
+
sdk: {
|
|
140
|
+
input: DisassociateResourcesFromSubscriptionCommandInput;
|
|
141
|
+
output: DisassociateResourcesFromSubscriptionCommandOutput;
|
|
142
|
+
};
|
|
143
|
+
};
|
|
144
|
+
}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetSubscriptionInput, GetSubscriptionOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetSubscriptionCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetSubscriptionCommandInput extends GetSubscriptionInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetSubscriptionCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetSubscriptionCommandOutput extends GetSubscriptionOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetSubscriptionCommand_base: {
|
|
22
|
+
new (input: GetSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<GetSubscriptionCommandInput, GetSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<GetSubscriptionCommandInput, GetSubscriptionCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { PricingPlanManagerClient, GetSubscriptionCommand } from "@aws-sdk/client-pricing-plan-manager"; // ES Modules import
|
|
32
|
+
* // const { PricingPlanManagerClient, GetSubscriptionCommand } = 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 = { // GetSubscriptionInput
|
|
37
|
+
* arn: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new GetSubscriptionCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // GetSubscriptionOutput
|
|
42
|
+
* // subscription: { // Subscription
|
|
43
|
+
* // arn: "STRING_VALUE", // required
|
|
44
|
+
* // planFamily: "STRING_VALUE", // required
|
|
45
|
+
* // planTier: "STRING_VALUE", // required
|
|
46
|
+
* // usageLevel: "STRING_VALUE",
|
|
47
|
+
* // scheduledChange: { // ScheduledChange
|
|
48
|
+
* // changeType: "DOWNGRADE" || "CANCELLATION", // required
|
|
49
|
+
* // effectiveDate: new Date("TIMESTAMP"),
|
|
50
|
+
* // planTier: "STRING_VALUE",
|
|
51
|
+
* // usageLevel: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // status: "PENDING_APPROVAL" || "ACTIVE" || "SYNC_IN_PROGRESS" || "FAILED", // required
|
|
54
|
+
* // statusReason: "STRING_VALUE",
|
|
55
|
+
* // resourceArns: [ // ResourceArns // required
|
|
56
|
+
* // "STRING_VALUE",
|
|
57
|
+
* // ],
|
|
58
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
59
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
60
|
+
* // },
|
|
61
|
+
* // eTag: "STRING_VALUE", // required
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param GetSubscriptionCommandInput - {@link GetSubscriptionCommandInput}
|
|
67
|
+
* @returns {@link GetSubscriptionCommandOutput}
|
|
68
|
+
* @see {@link GetSubscriptionCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link GetSubscriptionCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link PricingPlanManagerClientResolvedConfig | config} for PricingPlanManagerClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
73
|
+
* <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InternalServerException} (server fault)
|
|
76
|
+
* <p>An unexpected error occurred on the server. Retry the request.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
79
|
+
* <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
+
* <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationException} (client fault)
|
|
85
|
+
* <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>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link PricingPlanManagerServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from PricingPlanManager service.</p>
|
|
89
|
+
*
|
|
90
|
+
*
|
|
91
|
+
* @example Get subscription details
|
|
92
|
+
* ```javascript
|
|
93
|
+
* //
|
|
94
|
+
* const input = {
|
|
95
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890"
|
|
96
|
+
* };
|
|
97
|
+
* const command = new GetSubscriptionCommand(input);
|
|
98
|
+
* const response = await client.send(command);
|
|
99
|
+
* /* response is
|
|
100
|
+
* {
|
|
101
|
+
* eTag: "1",
|
|
102
|
+
* subscription: {
|
|
103
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
104
|
+
* createdAt: "2025-01-15T10:30:00Z",
|
|
105
|
+
* planFamily: "CloudFront",
|
|
106
|
+
* planTier: "PRO",
|
|
107
|
+
* resourceArns: [
|
|
108
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
109
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
|
|
110
|
+
* ],
|
|
111
|
+
* status: "ACTIVE",
|
|
112
|
+
* updatedAt: "2025-01-15T10:30:00Z"
|
|
113
|
+
* }
|
|
114
|
+
* }
|
|
115
|
+
* *\/
|
|
116
|
+
* ```
|
|
117
|
+
*
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
export declare class GetSubscriptionCommand extends GetSubscriptionCommand_base {
|
|
121
|
+
/** @internal type navigation helper, not in runtime. */
|
|
122
|
+
protected static __types: {
|
|
123
|
+
api: {
|
|
124
|
+
input: GetSubscriptionInput;
|
|
125
|
+
output: GetSubscriptionOutput;
|
|
126
|
+
};
|
|
127
|
+
sdk: {
|
|
128
|
+
input: GetSubscriptionCommandInput;
|
|
129
|
+
output: GetSubscriptionCommandOutput;
|
|
130
|
+
};
|
|
131
|
+
};
|
|
132
|
+
}
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListSubscriptionsInput, ListSubscriptionsOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListSubscriptionsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListSubscriptionsCommandInput extends ListSubscriptionsInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListSubscriptionsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListSubscriptionsCommandOutput extends ListSubscriptionsOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListSubscriptionsCommand_base: {
|
|
22
|
+
new (input: ListSubscriptionsCommandInput): import("@smithy/core/client").CommandImpl<ListSubscriptionsCommandInput, ListSubscriptionsCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [ListSubscriptionsCommandInput]): import("@smithy/core/client").CommandImpl<ListSubscriptionsCommandInput, ListSubscriptionsCommandOutput, import("..").PricingPlanManagerClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Returns a summary of all flat-rate pricing subscriptions in the calling account.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { PricingPlanManagerClient, ListSubscriptionsCommand } from "@aws-sdk/client-pricing-plan-manager"; // ES Modules import
|
|
32
|
+
* // const { PricingPlanManagerClient, ListSubscriptionsCommand } = 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 = { // ListSubscriptionsInput
|
|
37
|
+
* nextToken: "STRING_VALUE",
|
|
38
|
+
* };
|
|
39
|
+
* const command = new ListSubscriptionsCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // ListSubscriptionsOutput
|
|
42
|
+
* // subscriptionSummaries: [ // SubscriptionSummaryList // required
|
|
43
|
+
* // { // SubscriptionSummary
|
|
44
|
+
* // arn: "STRING_VALUE", // required
|
|
45
|
+
* // planFamily: "STRING_VALUE", // required
|
|
46
|
+
* // planTier: "STRING_VALUE", // required
|
|
47
|
+
* // usageLevel: "STRING_VALUE",
|
|
48
|
+
* // scheduledChange: { // ScheduledChange
|
|
49
|
+
* // changeType: "DOWNGRADE" || "CANCELLATION", // required
|
|
50
|
+
* // effectiveDate: new Date("TIMESTAMP"),
|
|
51
|
+
* // planTier: "STRING_VALUE",
|
|
52
|
+
* // usageLevel: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // status: "PENDING_APPROVAL" || "ACTIVE" || "SYNC_IN_PROGRESS" || "FAILED", // required
|
|
55
|
+
* // statusReason: "STRING_VALUE",
|
|
56
|
+
* // resourceArns: [ // ResourceArns // required
|
|
57
|
+
* // "STRING_VALUE",
|
|
58
|
+
* // ],
|
|
59
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
60
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
61
|
+
* // eTag: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // nextToken: "STRING_VALUE",
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
69
|
+
* @param ListSubscriptionsCommandInput - {@link ListSubscriptionsCommandInput}
|
|
70
|
+
* @returns {@link ListSubscriptionsCommandOutput}
|
|
71
|
+
* @see {@link ListSubscriptionsCommandInput} for command's `input` shape.
|
|
72
|
+
* @see {@link ListSubscriptionsCommandOutput} for command's `response` shape.
|
|
73
|
+
* @see {@link PricingPlanManagerClientResolvedConfig | config} for PricingPlanManagerClient's `config` shape.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
+
* <p>You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InternalServerException} (server fault)
|
|
79
|
+
* <p>An unexpected error occurred on the server. Retry the request.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
82
|
+
* <p>The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
85
|
+
* <p>The request rate exceeds the allowed limit. Wait briefly and retry the request.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ValidationException} (client fault)
|
|
88
|
+
* <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>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link PricingPlanManagerServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from PricingPlanManager service.</p>
|
|
92
|
+
*
|
|
93
|
+
*
|
|
94
|
+
* @example List all subscriptions
|
|
95
|
+
* ```javascript
|
|
96
|
+
* //
|
|
97
|
+
* const input = { /* empty *\/ };
|
|
98
|
+
* const command = new ListSubscriptionsCommand(input);
|
|
99
|
+
* const response = await client.send(command);
|
|
100
|
+
* /* response is
|
|
101
|
+
* {
|
|
102
|
+
* subscriptionSummaries: [
|
|
103
|
+
* {
|
|
104
|
+
* arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890",
|
|
105
|
+
* createdAt: "2025-01-15T10:30:00Z",
|
|
106
|
+
* eTag: "1",
|
|
107
|
+
* planFamily: "CloudFront",
|
|
108
|
+
* planTier: "PRO",
|
|
109
|
+
* resourceArns: [
|
|
110
|
+
* "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE",
|
|
111
|
+
* "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4"
|
|
112
|
+
* ],
|
|
113
|
+
* status: "ACTIVE",
|
|
114
|
+
* updatedAt: "2025-01-15T10:30:00Z"
|
|
115
|
+
* }
|
|
116
|
+
* ]
|
|
117
|
+
* }
|
|
118
|
+
* *\/
|
|
119
|
+
* ```
|
|
120
|
+
*
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
export declare class ListSubscriptionsCommand extends ListSubscriptionsCommand_base {
|
|
124
|
+
/** @internal type navigation helper, not in runtime. */
|
|
125
|
+
protected static __types: {
|
|
126
|
+
api: {
|
|
127
|
+
input: ListSubscriptionsInput;
|
|
128
|
+
output: ListSubscriptionsOutput;
|
|
129
|
+
};
|
|
130
|
+
sdk: {
|
|
131
|
+
input: ListSubscriptionsCommandInput;
|
|
132
|
+
output: ListSubscriptionsCommandOutput;
|
|
133
|
+
};
|
|
134
|
+
};
|
|
135
|
+
}
|