Skip to content

Commit 50d16ae

Browse files
author
awstools
committed
docs(client-pricing-plan-manager): Documentation update for the CreateSubscription API to correct the default value of the approval mode parameter. The default value for paid subscriptions is MANUAL, not IMMEDIATE as previously documented. The default value remains IMMEDIATE for FREE tier subscriptions.
1 parent da56caa commit 50d16ae

8 files changed

Lines changed: 18 additions & 18 deletions

File tree

clients/client-pricing-plan-manager/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
AWS SDK for JavaScript PricingPlanManager Client for Node.js, Browser and React Native.
88

9-
<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>
9+
<p>Manages flat-rate pricing subscriptions for supported 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>
1010

1111
## Installing
1212

clients/client-pricing-plan-manager/src/PricingPlanManager.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ export interface PricingPlanManager {
233233
}
234234

235235
/**
236-
* <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>
236+
* <p>Manages flat-rate pricing subscriptions for supported 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>
237237
* @public
238238
*/
239239
export class PricingPlanManager extends PricingPlanManagerClient implements PricingPlanManager {}

clients/client-pricing-plan-manager/src/PricingPlanManagerClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ export type PricingPlanManagerClientResolvedConfigType = __SmithyResolvedConfigu
317317
export interface PricingPlanManagerClientResolvedConfig extends PricingPlanManagerClientResolvedConfigType {}
318318

319319
/**
320-
* <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>
320+
* <p>Manages flat-rate pricing subscriptions for supported 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>
321321
* @public
322322
*/
323323
export class PricingPlanManagerClient extends __Client<

clients/client-pricing-plan-manager/src/commands/AssociateResourcesToSubscriptionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface AssociateResourcesToSubscriptionCommandInput extends AssociateR
2323
export interface AssociateResourcesToSubscriptionCommandOutput extends AssociateResourcesToSubscriptionOutput, __MetadataBearer {}
2424

2525
/**
26-
* <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>
26+
* <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 WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones, and CloudFront KeyValueStores.</p> </note>
2727
* @example
2828
* Use a bare-bones client and the command you need to make an API call.
2929
* ```javascript

clients/client-pricing-plan-manager/src/commands/DisassociateResourcesFromSubscriptionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface DisassociateResourcesFromSubscriptionCommandInput extends Disas
2626
export interface DisassociateResourcesFromSubscriptionCommandOutput extends DisassociateResourcesFromSubscriptionOutput, __MetadataBearer {}
2727

2828
/**
29-
* <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>
29+
* <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 WAF web ACL. You cannot remove these required resources.</p> </note>
3030
* @example
3131
* Use a bare-bones client and the command you need to make an API call.
3232
* ```javascript

clients/client-pricing-plan-manager/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <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>
4+
* <p>Manages flat-rate pricing subscriptions for supported 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>
55
*
66
* @packageDocumentation
77
*/

clients/client-pricing-plan-manager/src/models/models_0.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ export interface Subscription {
102102
statusReason?: string | undefined;
103103

104104
/**
105-
* <p>The ARNs of the AWS resources covered by this subscription.</p>
105+
* <p>The ARNs of the resources covered by this subscription.</p>
106106
* @public
107107
*/
108108
resourceArns: string[] | undefined;
@@ -286,13 +286,13 @@ export interface CreateSubscriptionInput {
286286
usageLevel?: string | undefined;
287287

288288
/**
289-
* <p>The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.</p> <note> <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p> </note>
289+
* <p>The ARNs of the resources to include in the subscription. Specify one or more supported resources.</p> <note> <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p> </note>
290290
* @public
291291
*/
292292
resourceArns: string[] | undefined;
293293

294294
/**
295-
* <p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. Defaults to <code>IMMEDIATE</code> if not specified.</p>
295+
* <p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. For paid tier plans, this defaults to <code>MANUAL</code> if not specified. For the <code>FREE</code> plan tier, only <code>IMMEDIATE</code> is supported, and it is the default.</p>
296296
* @public
297297
*/
298298
approvalMode?: ApprovalMode | undefined;
@@ -454,7 +454,7 @@ export interface SubscriptionSummary {
454454
statusReason?: string | undefined;
455455

456456
/**
457-
* <p>The ARNs of the AWS resources covered by this subscription.</p>
457+
* <p>The ARNs of the resources covered by this subscription.</p>
458458
* @public
459459
*/
460460
resourceArns: string[] | undefined;

codegen/sdk-codegen/aws-models/pricing-plan-manager.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
],
6969
"maxAge": 86400
7070
},
71-
"smithy.api#documentation": "<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>",
71+
"smithy.api#documentation": "<p>Manages flat-rate pricing subscriptions for supported 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>",
7272
"smithy.api#title": "PricingPlanManager",
7373
"smithy.rules#endpointBdd": {
7474
"version": "1.1",
@@ -446,7 +446,7 @@
446446
}
447447
],
448448
"traits": {
449-
"smithy.api#documentation": "<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>",
449+
"smithy.api#documentation": "<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 WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones, and CloudFront KeyValueStores.</p> </note>",
450450
"smithy.api#examples": [
451451
{
452452
"title": "Associate additional resources to a subscription",
@@ -918,14 +918,14 @@
918918
"resourceArns": {
919919
"target": "com.amazonaws.pricingplanmanager#ResourceArns",
920920
"traits": {
921-
"smithy.api#documentation": "<p>The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.</p> <note> <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p> </note>",
921+
"smithy.api#documentation": "<p>The ARNs of the resources to include in the subscription. Specify one or more supported resources.</p> <note> <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p> </note>",
922922
"smithy.api#required": {}
923923
}
924924
},
925925
"approvalMode": {
926926
"target": "com.amazonaws.pricingplanmanager#ApprovalMode",
927927
"traits": {
928-
"smithy.api#documentation": "<p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. Defaults to <code>IMMEDIATE</code> if not specified.</p>"
928+
"smithy.api#documentation": "<p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. For paid tier plans, this defaults to <code>MANUAL</code> if not specified. For the <code>FREE</code> plan tier, only <code>IMMEDIATE</code> is supported, and it is the default.</p>"
929929
}
930930
},
931931
"clientToken": {
@@ -993,7 +993,7 @@
993993
}
994994
],
995995
"traits": {
996-
"smithy.api#documentation": "<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>",
996+
"smithy.api#documentation": "<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 WAF web ACL. You cannot remove these required resources.</p> </note>",
997997
"smithy.api#examples": [
998998
{
999999
"title": "Remove a resource from a subscription",
@@ -1343,7 +1343,7 @@
13431343
"target": "smithy.api#String"
13441344
},
13451345
"traits": {
1346-
"smithy.api#documentation": "<p>A list of 1 to 10 AWS resource ARNs to include in the subscription.</p>",
1346+
"smithy.api#documentation": "<p>A list of 1 to 10 resource ARNs to include in the subscription.</p>",
13471347
"smithy.api#length": {
13481348
"min": 1,
13491349
"max": 10
@@ -1527,7 +1527,7 @@
15271527
"resourceArns": {
15281528
"target": "com.amazonaws.pricingplanmanager#ResourceArns",
15291529
"traits": {
1530-
"smithy.api#documentation": "<p>The ARNs of the AWS resources covered by this subscription.</p>",
1530+
"smithy.api#documentation": "<p>The ARNs of the resources covered by this subscription.</p>",
15311531
"smithy.api#required": {}
15321532
}
15331533
},
@@ -1617,7 +1617,7 @@
16171617
"resourceArns": {
16181618
"target": "com.amazonaws.pricingplanmanager#ResourceArns",
16191619
"traits": {
1620-
"smithy.api#documentation": "<p>The ARNs of the AWS resources covered by this subscription.</p>",
1620+
"smithy.api#documentation": "<p>The ARNs of the resources covered by this subscription.</p>",
16211621
"smithy.api#required": {}
16221622
}
16231623
},

0 commit comments

Comments
 (0)