Skip to content

Commit d570657

Browse files
author
awstools
committed
docs(client-imagebuilder): Updated the CreateImageRecipeRequest ParentImage description to include all valid values as updated with the SSM Parameters project.
1 parent 9b00708 commit d570657

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

clients/client-imagebuilder/src/models/models_0.ts

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2635,12 +2635,25 @@ export interface CreateImageRecipeRequest {
26352635
components: ComponentConfiguration[] | undefined;
26362636

26372637
/**
2638-
* <p>The base image of the image recipe. The value of the string can be the ARN of the base
2639-
* image or an AMI ID. The format for the ARN follows this example:
2640-
* <code>arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x</code>.
2641-
* You can provide the specific version that you want to use, or you can use a wildcard in
2642-
* all of the fields. If you enter an AMI ID for the string value, you must have access to
2643-
* the AMI, and the AMI must be in the same Region in which you are using Image Builder.</p>
2638+
* <p>The base image for customizations specified in the image recipe. You can specify the
2639+
* parent image using one of the following options:</p>
2640+
* <ul>
2641+
* <li>
2642+
* <p>AMI ID</p>
2643+
* </li>
2644+
* <li>
2645+
* <p>Image Builder image Amazon Resource Name (ARN)</p>
2646+
* </li>
2647+
* <li>
2648+
* <p>Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by <code>ssm:</code>,
2649+
* followed by the parameter name or ARN.</p>
2650+
* </li>
2651+
* <li>
2652+
* <p>Amazon Web Services Marketplace product ID</p>
2653+
* </li>
2654+
* </ul>
2655+
* <p>If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access
2656+
* to the AMI, and the AMI must be in the source Region.</p>
26442657
* @public
26452658
*/
26462659
parentImage: string | undefined;

codegen/sdk-codegen/aws-models/imagebuilder.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2005,7 +2005,7 @@
20052005
"parentImage": {
20062006
"target": "com.amazonaws.imagebuilder#NonEmptyString",
20072007
"traits": {
2008-
"smithy.api#documentation": "<p>The base image of the image recipe. The value of the string can be the ARN of the base\n\t\t\timage or an AMI ID. The format for the ARN follows this example:\n\t\t\t\t<code>arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x</code>.\n\t\t\tYou can provide the specific version that you want to use, or you can use a wildcard in\n\t\t\tall of the fields. If you enter an AMI ID for the string value, you must have access to\n\t\t\tthe AMI, and the AMI must be in the same Region in which you are using Image Builder.</p>",
2008+
"smithy.api#documentation": "<p>The base image for customizations specified in the image recipe. You can specify the \n\t\t\tparent image using one of the following options:</p>\n <ul>\n <li>\n <p>AMI ID</p>\n </li>\n <li>\n <p>Image Builder image Amazon Resource Name (ARN)</p>\n </li>\n <li>\n <p>Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by <code>ssm:</code>, \n\t\t\t\t\tfollowed by the parameter name or ARN.</p>\n </li>\n <li>\n <p>Amazon Web Services Marketplace product ID</p>\n </li>\n </ul>\n <p>If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access \n\t\t\tto the AMI, and the AMI must be in the source Region.</p>",
20092009
"smithy.api#required": {}
20102010
}
20112011
},

0 commit comments

Comments
 (0)