Skip to content

Commit 3f98e8c

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
Doc only update for the AWS Marketplace Deployment Service that fixes several customer-reported issues.
1 parent 6b83f71 commit 3f98e8c

11 files changed

+41
-23
lines changed

‎generator/ServiceModels/marketplace-deployment/marketplace-deployment-2023-01-25.api.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55
"endpointPrefix":"deployment-marketplace",
66
"jsonVersion":"1.1",
77
"protocol":"rest-json",
8+
"protocols":["rest-json"],
89
"serviceFullName":"AWS Marketplace Deployment Service",
910
"serviceId":"Marketplace Deployment",
1011
"signatureVersion":"v4",
1112
"signingName":"aws-marketplace",
12-
"uid":"marketplace-deployment-2023-01-25"
13+
"uid":"marketplace-deployment-2023-01-25",
14+
"auth":["aws.auth#sigv4"]
1315
},
1416
"operations":{
1517
"ListTagsForResource":{

‎generator/ServiceModels/marketplace-deployment/marketplace-deployment-2023-01-25.docs.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"version": "2.0",
3-
"service": "<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>",
3+
"service": "<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, such as API keys and external IDs, to buyers during the Quick Launch experience.</p>",
44
"operations": {
55
"ListTagsForResource": "<p>Lists all tags that have been added to a deployment parameter resource.</p>",
66
"PutDeploymentParameter": "<p>Creates or updates a deployment parameter and is targeted by <code>catalog</code> and <code>agreementId</code>.</p>",
@@ -16,13 +16,13 @@
1616
"Catalog": {
1717
"base": null,
1818
"refs": {
19-
"PutDeploymentParameterRequest$catalog": "<p>The catalog related to the request. Fixed value: <code>AWS Marketplace</code> </p>"
19+
"PutDeploymentParameterRequest$catalog": "<p>The catalog related to the request. Fixed value: <code>AWSMarketplace</code> </p>"
2020
}
2121
},
2222
"ClientToken": {
2323
"base": null,
2424
"refs": {
25-
"PutDeploymentParameterRequest$clientToken": "<p>The idempotency token for deployment parameters. A unique identifier for the new version.</p>"
25+
"PutDeploymentParameterRequest$clientToken": "<p>The idempotency token for deployment parameters. A unique identifier for the new version.</p> <note> <p>This field is not required if you're calling using an AWS SDK. Otherwise, a <code>clientToken</code> must be provided with the request.</p> </note>"
2626
}
2727
},
2828
"ConflictException": {
@@ -31,7 +31,7 @@
3131
}
3232
},
3333
"DeploymentParameterInput": {
34-
"base": "<p>The shape containing the requested deployment parameter name and secretString.</p>",
34+
"base": "<p>The shape containing the requested deployment parameter name and secretString.</p> <note> <p>To support AWS CloudFormation dynamic references to this resource using Quick Launch, this value must match a parameter defined in the CloudFormation templated provided to buyers.</p> </note>",
3535
"refs": {
3636
"PutDeploymentParameterRequest$deploymentParameter": "<p>The deployment parameter targeted to the acceptor of an agreement for which to create the AWS Secret Manager resource.</p>"
3737
}

‎generator/ServiceModels/marketplace-deployment/marketplace-deployment-2023-01-25.normal.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55
"endpointPrefix":"deployment-marketplace",
66
"jsonVersion":"1.1",
77
"protocol":"rest-json",
8+
"protocols":["rest-json"],
89
"serviceFullName":"AWS Marketplace Deployment Service",
910
"serviceId":"Marketplace Deployment",
1011
"signatureVersion":"v4",
1112
"signingName":"aws-marketplace",
12-
"uid":"marketplace-deployment-2023-01-25"
13+
"uid":"marketplace-deployment-2023-01-25",
14+
"auth":["aws.auth#sigv4"]
1315
},
1416
"operations":{
1517
"ListTagsForResource":{
@@ -153,7 +155,7 @@
153155
"documentation":"<p>The text to encrypt and store in the secret.</p>"
154156
}
155157
},
156-
"documentation":"<p>The shape containing the requested deployment parameter name and secretString.</p>"
158+
"documentation":"<p>The shape containing the requested deployment parameter name and secretString.</p> <note> <p>To support AWS CloudFormation dynamic references to this resource using Quick Launch, this value must match a parameter defined in the CloudFormation templated provided to buyers.</p> </note>"
157159
},
158160
"DeploymentParameterName":{
159161
"type":"string",
@@ -215,13 +217,13 @@
215217
},
216218
"catalog":{
217219
"shape":"Catalog",
218-
"documentation":"<p>The catalog related to the request. Fixed value: <code>AWS Marketplace</code> </p>",
220+
"documentation":"<p>The catalog related to the request. Fixed value: <code>AWSMarketplace</code> </p>",
219221
"location":"uri",
220222
"locationName":"catalog"
221223
},
222224
"clientToken":{
223225
"shape":"ClientToken",
224-
"documentation":"<p>The idempotency token for deployment parameters. A unique identifier for the new version.</p>",
226+
"documentation":"<p>The idempotency token for deployment parameters. A unique identifier for the new version.</p> <note> <p>This field is not required if you're calling using an AWS SDK. Otherwise, a <code>clientToken</code> must be provided with the request.</p> </note>",
225227
"idempotencyToken":true
226228
},
227229
"deploymentParameter":{
@@ -429,5 +431,5 @@
429431
"exception":true
430432
}
431433
},
432-
"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>"
434+
"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, such as API keys and external IDs, to buyers during the Quick Launch experience.</p>"
433435
}

‎sdk/src/Services/MarketplaceDeployment/Generated/Model/DeploymentParameterInput.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ namespace Amazon.MarketplaceDeployment.Model
3131
{
3232
/// <summary>
3333
/// The shape containing the requested deployment parameter name and secretString.
34+
///
35+
/// <note>
36+
/// <para>
37+
/// To support AWS CloudFormation dynamic references to this resource using Quick Launch,
38+
/// this value must match a parameter defined in the CloudFormation templated provided
39+
/// to buyers.
40+
/// </para>
41+
/// </note>
3442
/// </summary>
3543
public partial class DeploymentParameterInput
3644
{

‎sdk/src/Services/MarketplaceDeployment/Generated/Model/PutDeploymentParameterRequest.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ internal bool IsSetAgreementId()
6565
/// <summary>
6666
/// Gets and sets the property Catalog.
6767
/// <para>
68-
/// The catalog related to the request. Fixed value: <c>AWS Marketplace</c>
68+
/// The catalog related to the request. Fixed value: <c>AWSMarketplace</c>
6969
/// </para>
7070
/// </summary>
7171
[AWSProperty(Required=true, Min=1, Max=64)]
@@ -86,6 +86,12 @@ internal bool IsSetCatalog()
8686
/// <para>
8787
/// The idempotency token for deployment parameters. A unique identifier for the new version.
8888
/// </para>
89+
/// <note>
90+
/// <para>
91+
/// This field is not required if you're calling using an AWS SDK. Otherwise, a <c>clientToken</c>
92+
/// must be provided with the request.
93+
/// </para>
94+
/// </note>
8995
/// </summary>
9096
[AWSProperty(Min=32, Max=64)]
9197
public string ClientToken

‎sdk/src/Services/MarketplaceDeployment/Generated/_bcl35/AmazonMarketplaceDeploymentClient.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ namespace Amazon.MarketplaceDeployment
4040
/// is a deployment option for software as a service (SaaS) products. Quick Launch simplifies
4141
/// and reduces the time, resources, and steps required to configure, deploy, and launch
4242
/// a products. The AWS Marketplace Deployment Service provides sellers with a secure
43-
/// method for passing deployment parameters (for example, API keys and external IDs)
44-
/// to buyers during the Quick Launch experience.
43+
/// method for passing deployment parameters, such as API keys and external IDs, to buyers
44+
/// during the Quick Launch experience.
4545
/// </summary>
4646
public partial class AmazonMarketplaceDeploymentClient : AmazonServiceClient, IAmazonMarketplaceDeployment
4747
{

‎sdk/src/Services/MarketplaceDeployment/Generated/_bcl35/IAmazonMarketplaceDeployment.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ namespace Amazon.MarketplaceDeployment
3434
/// is a deployment option for software as a service (SaaS) products. Quick Launch simplifies
3535
/// and reduces the time, resources, and steps required to configure, deploy, and launch
3636
/// a products. The AWS Marketplace Deployment Service provides sellers with a secure
37-
/// method for passing deployment parameters (for example, API keys and external IDs)
38-
/// to buyers during the Quick Launch experience.
37+
/// method for passing deployment parameters, such as API keys and external IDs, to buyers
38+
/// during the Quick Launch experience.
3939
/// </summary>
4040
public partial interface IAmazonMarketplaceDeployment : IAmazonService, IDisposable
4141
{

‎sdk/src/Services/MarketplaceDeployment/Generated/_bcl45/AmazonMarketplaceDeploymentClient.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ namespace Amazon.MarketplaceDeployment
4343
/// is a deployment option for software as a service (SaaS) products. Quick Launch simplifies
4444
/// and reduces the time, resources, and steps required to configure, deploy, and launch
4545
/// a products. The AWS Marketplace Deployment Service provides sellers with a secure
46-
/// method for passing deployment parameters (for example, API keys and external IDs)
47-
/// to buyers during the Quick Launch experience.
46+
/// method for passing deployment parameters, such as API keys and external IDs, to buyers
47+
/// during the Quick Launch experience.
4848
/// </summary>
4949
public partial class AmazonMarketplaceDeploymentClient : AmazonServiceClient, IAmazonMarketplaceDeployment
5050
{

‎sdk/src/Services/MarketplaceDeployment/Generated/_bcl45/IAmazonMarketplaceDeployment.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ namespace Amazon.MarketplaceDeployment
3636
/// is a deployment option for software as a service (SaaS) products. Quick Launch simplifies
3737
/// and reduces the time, resources, and steps required to configure, deploy, and launch
3838
/// a products. The AWS Marketplace Deployment Service provides sellers with a secure
39-
/// method for passing deployment parameters (for example, API keys and external IDs)
40-
/// to buyers during the Quick Launch experience.
39+
/// method for passing deployment parameters, such as API keys and external IDs, to buyers
40+
/// during the Quick Launch experience.
4141
/// </summary>
4242
public partial interface IAmazonMarketplaceDeployment : IAmazonService, IDisposable
4343
{

‎sdk/src/Services/MarketplaceDeployment/Generated/_netstandard/AmazonMarketplaceDeploymentClient.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ namespace Amazon.MarketplaceDeployment
4343
/// is a deployment option for software as a service (SaaS) products. Quick Launch simplifies
4444
/// and reduces the time, resources, and steps required to configure, deploy, and launch
4545
/// a products. The AWS Marketplace Deployment Service provides sellers with a secure
46-
/// method for passing deployment parameters (for example, API keys and external IDs)
47-
/// to buyers during the Quick Launch experience.
46+
/// method for passing deployment parameters, such as API keys and external IDs, to buyers
47+
/// during the Quick Launch experience.
4848
/// </summary>
4949
public partial class AmazonMarketplaceDeploymentClient : AmazonServiceClient, IAmazonMarketplaceDeployment
5050
{

0 commit comments

Comments
 (0)