Skip to content

Commit f48ef14

Browse files
author
awstools
committed
docs(client-marketplace-deployment): Doc only update for the AWS Marketplace Deployment Service that fixes several customer-reported issues.
1 parent ef85f2e commit f48ef14

File tree

6 files changed

+30
-9
lines changed

6 files changed

+30
-9
lines changed

clients/client-marketplace-deployment/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66

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

9-
<p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters (for example, API keys and external IDs) to buyers during the Quick Launch experience.</p>
9+
<p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products.
10+
Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products.
11+
The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters, such as
12+
API keys and external IDs, to buyers during the Quick Launch experience.</p>
1013

1114
## Installing
1215

clients/client-marketplace-deployment/src/MarketplaceDeployment.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,10 @@ export interface MarketplaceDeployment {
8686
}
8787

8888
/**
89-
* <p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters (for example, API keys and external IDs) to buyers during the Quick Launch experience.</p>
89+
* <p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products.
90+
* Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products.
91+
* The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters, such as
92+
* API keys and external IDs, to buyers during the Quick Launch experience.</p>
9093
* @public
9194
*/
9295
export class MarketplaceDeployment extends MarketplaceDeploymentClient implements MarketplaceDeployment {}

clients/client-marketplace-deployment/src/MarketplaceDeploymentClient.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,10 @@ export type MarketplaceDeploymentClientResolvedConfigType = __SmithyResolvedConf
283283
export interface MarketplaceDeploymentClientResolvedConfig extends MarketplaceDeploymentClientResolvedConfigType {}
284284

285285
/**
286-
* <p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters (for example, API keys and external IDs) to buyers during the Quick Launch experience.</p>
286+
* <p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products.
287+
* Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products.
288+
* The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters, such as
289+
* API keys and external IDs, to buyers during the Quick Launch experience.</p>
287290
* @public
288291
*/
289292
export class MarketplaceDeploymentClient extends __Client<

clients/client-marketplace-deployment/src/index.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters (for example, API keys and external IDs) to buyers during the Quick Launch experience.</p>
4+
* <p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products.
5+
* Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products.
6+
* The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters, such as
7+
* API keys and external IDs, to buyers during the Quick Launch experience.</p>
58
*
69
* @packageDocumentation
710
*/

clients/client-marketplace-deployment/src/models/models_0.ts

+10-1
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@ export class InternalServerException extends __BaseException {
7373

7474
/**
7575
* <p>The shape containing the requested deployment parameter name and secretString.</p>
76+
* <note>
77+
* <p>To support AWS CloudFormation dynamic references to this resource using Quick Launch,
78+
* this value must match a parameter defined in the CloudFormation templated provided to
79+
* buyers.</p>
80+
* </note>
7681
* @public
7782
*/
7883
export interface DeploymentParameterInput {
@@ -94,7 +99,7 @@ export interface DeploymentParameterInput {
9499
*/
95100
export interface PutDeploymentParameterRequest {
96101
/**
97-
* <p>The catalog related to the request. Fixed value: <code>AWS Marketplace</code>
102+
* <p>The catalog related to the request. Fixed value: <code>AWSMarketplace</code>
98103
* </p>
99104
* @public
100105
*/
@@ -132,6 +137,10 @@ export interface PutDeploymentParameterRequest {
132137

133138
/**
134139
* <p>The idempotency token for deployment parameters. A unique identifier for the new version.</p>
140+
* <note>
141+
* <p>This field is not required if you're calling using an AWS SDK. Otherwise, a
142+
* <code>clientToken</code> must be provided with the request.</p>
143+
* </note>
135144
* @public
136145
*/
137146
clientToken?: string | undefined;

codegen/sdk-codegen/aws-models/marketplace-deployment.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
},
3232
"aws.protocols#restJson1": {},
3333
"smithy.api#cors": {},
34-
"smithy.api#documentation": "<p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters (for example, API keys and external IDs) to buyers during the Quick Launch experience.</p>",
34+
"smithy.api#documentation": "<p>The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. \n Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. \n The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters, such as \n API keys and external IDs, to buyers during the Quick Launch experience.</p>",
3535
"smithy.api#title": "AWS Marketplace Deployment Service",
3636
"smithy.rules#endpointRuleSet": {
3737
"version": "1.0",
@@ -799,7 +799,7 @@
799799
}
800800
},
801801
"traits": {
802-
"smithy.api#documentation": "<p>The shape containing the requested deployment parameter name and secretString.</p>"
802+
"smithy.api#documentation": "<p>The shape containing the requested deployment parameter name and secretString.</p>\n <note>\n <p>To support AWS CloudFormation dynamic references to this resource using Quick Launch,\n this value must match a parameter defined in the CloudFormation templated provided to\n buyers.</p>\n </note>"
803803
}
804804
},
805805
"com.amazonaws.marketplacedeployment#DeploymentParameterName": {
@@ -1017,7 +1017,7 @@
10171017
"catalog": {
10181018
"target": "com.amazonaws.marketplacedeployment#Catalog",
10191019
"traits": {
1020-
"smithy.api#documentation": "<p>The catalog related to the request. Fixed value: <code>AWS Marketplace</code>\n </p>",
1020+
"smithy.api#documentation": "<p>The catalog related to the request. Fixed value: <code>AWSMarketplace</code>\n </p>",
10211021
"smithy.api#httpLabel": {},
10221022
"smithy.api#required": {}
10231023
}
@@ -1060,7 +1060,7 @@
10601060
"clientToken": {
10611061
"target": "com.amazonaws.marketplacedeployment#ClientToken",
10621062
"traits": {
1063-
"smithy.api#documentation": "<p>The idempotency token for deployment parameters. A unique identifier for the new version.</p>",
1063+
"smithy.api#documentation": "<p>The idempotency token for deployment parameters. A unique identifier for the new version.</p>\n <note>\n <p>This field is not required if you're calling using an AWS SDK. Otherwise, a\n <code>clientToken</code> must be provided with the request.</p>\n </note>",
10641064
"smithy.api#idempotencyToken": {}
10651065
}
10661066
}

0 commit comments

Comments
 (0)