feat(client-imagebuilder): Add macOS platform and instance placement …

…options
aws · Oct 22, 2024 · df4c455 · df4c455
1 parent d930c21
commit df4c455
Show file tree

Hide file tree

Showing 25 changed files with 260 additions and 57 deletions.
diff --git a/clients/client-imagebuilder/README.md b/clients/client-imagebuilder/README.md
@@ -13,7 +13,7 @@ and settings to meet specific IT standards.</p>
 
 ## Installing
 
-To install the this package, simply type add or install @aws-sdk/client-imagebuilder
+To install this package, simply type add or install @aws-sdk/client-imagebuilder
 using your favorite package manager:
 
 - `npm install @aws-sdk/client-imagebuilder`

diff --git a/clients/client-imagebuilder/src/commands/CreateComponentCommand.ts b/clients/client-imagebuilder/src/commands/CreateComponentCommand.ts
@@ -51,7 +51,7 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _
  *   semanticVersion: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
  *   changeDescription: "STRING_VALUE",
- *   platform: "Windows" || "Linux", // required
+ *   platform: "Windows" || "Linux" || "macOS", // required
  *   supportedOsVersions: [ // OsVersionList
  *     "STRING_VALUE",
  *   ],

diff --git a/clients/client-imagebuilder/src/commands/CreateContainerRecipeCommand.ts b/clients/client-imagebuilder/src/commands/CreateContainerRecipeCommand.ts
@@ -76,7 +76,7 @@ export interface CreateContainerRecipeCommandOutput extends CreateContainerRecip
  *   },
  *   dockerfileTemplateData: "STRING_VALUE",
  *   dockerfileTemplateUri: "STRING_VALUE",
- *   platformOverride: "Windows" || "Linux",
+ *   platformOverride: "Windows" || "Linux" || "macOS",
  *   imageOsVersionOverride: "STRING_VALUE",
  *   parentImage: "STRING_VALUE", // required
  *   tags: { // TagMap

diff --git a/clients/client-imagebuilder/src/commands/CreateInfrastructureConfigurationCommand.ts b/clients/client-imagebuilder/src/commands/CreateInfrastructureConfigurationCommand.ts
@@ -74,6 +74,12 @@ export interface CreateInfrastructureConfigurationCommandOutput
  *   tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },
+ *   placement: { // Placement
+ *     availabilityZone: "STRING_VALUE",
+ *     tenancy: "default" || "dedicated" || "host",
+ *     hostId: "STRING_VALUE",
+ *     hostResourceGroupArn: "STRING_VALUE",
+ *   },
  *   clientToken: "STRING_VALUE", // required
  * };
  * const command = new CreateInfrastructureConfigurationCommand(input);

diff --git a/clients/client-imagebuilder/src/commands/GetComponentCommand.ts b/clients/client-imagebuilder/src/commands/GetComponentCommand.ts
@@ -49,7 +49,7 @@ export interface GetComponentCommandOutput extends GetComponentResponse, __Metad
  * //     description: "STRING_VALUE",
  * //     changeDescription: "STRING_VALUE",
  * //     type: "BUILD" || "TEST",
- * //     platform: "Windows" || "Linux",
+ * //     platform: "Windows" || "Linux" || "macOS",
  * //     supportedOsVersions: [ // OsVersionList
  * //       "STRING_VALUE",
  * //     ],

diff --git a/clients/client-imagebuilder/src/commands/GetContainerRecipeCommand.ts b/clients/client-imagebuilder/src/commands/GetContainerRecipeCommand.ts
@@ -47,7 +47,7 @@ export interface GetContainerRecipeCommandOutput extends GetContainerRecipeRespo
  * //     containerType: "DOCKER",
  * //     name: "STRING_VALUE",
  * //     description: "STRING_VALUE",
- * //     platform: "Windows" || "Linux",
+ * //     platform: "Windows" || "Linux" || "macOS",
  * //     owner: "STRING_VALUE",
  * //     version: "STRING_VALUE",
  * //     components: [ // ComponentConfigurationList

diff --git a/clients/client-imagebuilder/src/commands/GetImageCommand.ts b/clients/client-imagebuilder/src/commands/GetImageCommand.ts
@@ -47,7 +47,7 @@ export interface GetImageCommandOutput extends GetImageResponse, __MetadataBeare
  * //     type: "AMI" || "DOCKER",
  * //     name: "STRING_VALUE",
  * //     version: "STRING_VALUE",
- * //     platform: "Windows" || "Linux",
+ * //     platform: "Windows" || "Linux" || "macOS",
  * //     enhancedImageMetadataEnabled: true || false,
  * //     osVersion: "STRING_VALUE",
  * //     state: { // ImageState
@@ -59,7 +59,7 @@ export interface GetImageCommandOutput extends GetImageResponse, __MetadataBeare
  * //       type: "AMI" || "DOCKER",
  * //       name: "STRING_VALUE",
  * //       description: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       owner: "STRING_VALUE",
  * //       version: "STRING_VALUE",
  * //       components: [ // ComponentConfigurationList
@@ -110,7 +110,7 @@ export interface GetImageCommandOutput extends GetImageResponse, __MetadataBeare
  * //       containerType: "DOCKER",
  * //       name: "STRING_VALUE",
  * //       description: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       owner: "STRING_VALUE",
  * //       version: "STRING_VALUE",
  * //       components: [
@@ -195,6 +195,12 @@ export interface GetImageCommandOutput extends GetImageResponse, __MetadataBeare
  * //       tags: {
  * //         "<keys>": "STRING_VALUE",
  * //       },
+ * //       placement: { // Placement
+ * //         availabilityZone: "STRING_VALUE",
+ * //         tenancy: "default" || "dedicated" || "host",
+ * //         hostId: "STRING_VALUE",
+ * //         hostResourceGroupArn: "STRING_VALUE",
+ * //       },
  * //     },
  * //     distributionConfiguration: { // DistributionConfiguration
  * //       arn: "STRING_VALUE",

diff --git a/clients/client-imagebuilder/src/commands/GetImagePipelineCommand.ts b/clients/client-imagebuilder/src/commands/GetImagePipelineCommand.ts
@@ -46,7 +46,7 @@ export interface GetImagePipelineCommandOutput extends GetImagePipelineResponse,
  * //     arn: "STRING_VALUE",
  * //     name: "STRING_VALUE",
  * //     description: "STRING_VALUE",
- * //     platform: "Windows" || "Linux",
+ * //     platform: "Windows" || "Linux" || "macOS",
  * //     enhancedImageMetadataEnabled: true || false,
  * //     imageRecipeArn: "STRING_VALUE",
  * //     containerRecipeArn: "STRING_VALUE",

diff --git a/clients/client-imagebuilder/src/commands/GetImageRecipeCommand.ts b/clients/client-imagebuilder/src/commands/GetImageRecipeCommand.ts
@@ -47,7 +47,7 @@ export interface GetImageRecipeCommandOutput extends GetImageRecipeResponse, __M
  * //     type: "AMI" || "DOCKER",
  * //     name: "STRING_VALUE",
  * //     description: "STRING_VALUE",
- * //     platform: "Windows" || "Linux",
+ * //     platform: "Windows" || "Linux" || "macOS",
  * //     owner: "STRING_VALUE",
  * //     version: "STRING_VALUE",
  * //     components: [ // ComponentConfigurationList

diff --git a/clients/client-imagebuilder/src/commands/GetInfrastructureConfigurationCommand.ts b/clients/client-imagebuilder/src/commands/GetInfrastructureConfigurationCommand.ts
@@ -80,6 +80,12 @@ export interface GetInfrastructureConfigurationCommandOutput
  * //     tags: { // TagMap
  * //       "<keys>": "STRING_VALUE",
  * //     },
+ * //     placement: { // Placement
+ * //       availabilityZone: "STRING_VALUE",
+ * //       tenancy: "default" || "dedicated" || "host",
+ * //       hostId: "STRING_VALUE",
+ * //       hostResourceGroupArn: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-imagebuilder/src/commands/ImportComponentCommand.ts b/clients/client-imagebuilder/src/commands/ImportComponentCommand.ts
@@ -42,7 +42,7 @@ export interface ImportComponentCommandOutput extends ImportComponentResponse, _
  *   changeDescription: "STRING_VALUE",
  *   type: "BUILD" || "TEST", // required
  *   format: "SHELL", // required
- *   platform: "Windows" || "Linux", // required
+ *   platform: "Windows" || "Linux" || "macOS", // required
  *   data: "STRING_VALUE",
  *   uri: "STRING_VALUE",
  *   kmsKeyId: "STRING_VALUE",

diff --git a/clients/client-imagebuilder/src/commands/ImportVmImageCommand.ts b/clients/client-imagebuilder/src/commands/ImportVmImageCommand.ts
@@ -46,7 +46,7 @@ export interface ImportVmImageCommandOutput extends ImportVmImageResponse, __Met
  *   name: "STRING_VALUE", // required
  *   semanticVersion: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
- *   platform: "Windows" || "Linux", // required
+ *   platform: "Windows" || "Linux" || "macOS", // required
  *   osVersion: "STRING_VALUE",
  *   vmImportTaskId: "STRING_VALUE", // required
  *   tags: { // TagMap

diff --git a/clients/client-imagebuilder/src/commands/ListComponentBuildVersionsCommand.ts b/clients/client-imagebuilder/src/commands/ListComponentBuildVersionsCommand.ts
@@ -28,17 +28,8 @@ export interface ListComponentBuildVersionsCommandInput extends ListComponentBui
 export interface ListComponentBuildVersionsCommandOutput extends ListComponentBuildVersionsResponse, __MetadataBearer {}
 
 /**
- * <p>Returns the list of component build versions for the specified semantic
- * 			version.</p>
- *          <note>
- *             <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
- * 	You can assign values for the first three, and can filter on all of them.</p>
- *             <p>
- *                <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
- * 	to specify the most recent versions or nodes when selecting the base image or components for your
- * 	recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
- * 	wildcards.</p>
- *          </note>
+ * <p>Returns the list of component build versions for the specified component
+ * 			version Amazon Resource Name (ARN).</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,7 +50,7 @@ export interface ListComponentBuildVersionsCommandOutput extends ListComponentBu
  * //       arn: "STRING_VALUE",
  * //       name: "STRING_VALUE",
  * //       version: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       supportedOsVersions: [ // OsVersionList
  * //         "STRING_VALUE",
  * //       ],

diff --git a/clients/client-imagebuilder/src/commands/ListComponentsCommand.ts b/clients/client-imagebuilder/src/commands/ListComponentsCommand.ts
@@ -70,7 +70,7 @@ export interface ListComponentsCommandOutput extends ListComponentsResponse, __M
  * //       name: "STRING_VALUE",
  * //       version: "STRING_VALUE",
  * //       description: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       supportedOsVersions: [ // OsVersionList
  * //         "STRING_VALUE",
  * //       ],

diff --git a/clients/client-imagebuilder/src/commands/ListContainerRecipesCommand.ts b/clients/client-imagebuilder/src/commands/ListContainerRecipesCommand.ts
@@ -57,7 +57,7 @@ export interface ListContainerRecipesCommandOutput extends ListContainerRecipesR
  * //       arn: "STRING_VALUE",
  * //       containerType: "DOCKER",
  * //       name: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       owner: "STRING_VALUE",
  * //       parentImage: "STRING_VALUE",
  * //       dateCreated: "STRING_VALUE",

diff --git a/clients/client-imagebuilder/src/commands/ListImageBuildVersionsCommand.ts b/clients/client-imagebuilder/src/commands/ListImageBuildVersionsCommand.ts
@@ -58,7 +58,7 @@ export interface ListImageBuildVersionsCommandOutput extends ListImageBuildVersi
  * //       name: "STRING_VALUE",
  * //       type: "AMI" || "DOCKER",
  * //       version: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       osVersion: "STRING_VALUE",
  * //       state: { // ImageState
  * //         status: "PENDING" || "CREATING" || "BUILDING" || "TESTING" || "DISTRIBUTING" || "INTEGRATING" || "AVAILABLE" || "CANCELLED" || "FAILED" || "DEPRECATED" || "DELETED" || "DISABLED",

diff --git a/clients/client-imagebuilder/src/commands/ListImagePipelineImagesCommand.ts b/clients/client-imagebuilder/src/commands/ListImagePipelineImagesCommand.ts
@@ -58,7 +58,7 @@ export interface ListImagePipelineImagesCommandOutput extends ListImagePipelineI
  * //       name: "STRING_VALUE",
  * //       type: "AMI" || "DOCKER",
  * //       version: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       osVersion: "STRING_VALUE",
  * //       state: { // ImageState
  * //         status: "PENDING" || "CREATING" || "BUILDING" || "TESTING" || "DISTRIBUTING" || "INTEGRATING" || "AVAILABLE" || "CANCELLED" || "FAILED" || "DEPRECATED" || "DELETED" || "DISABLED",

diff --git a/clients/client-imagebuilder/src/commands/ListImagePipelinesCommand.ts b/clients/client-imagebuilder/src/commands/ListImagePipelinesCommand.ts
@@ -56,7 +56,7 @@ export interface ListImagePipelinesCommandOutput extends ListImagePipelinesRespo
  * //       arn: "STRING_VALUE",
  * //       name: "STRING_VALUE",
  * //       description: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       enhancedImageMetadataEnabled: true || false,
  * //       imageRecipeArn: "STRING_VALUE",
  * //       containerRecipeArn: "STRING_VALUE",

diff --git a/clients/client-imagebuilder/src/commands/ListImageRecipesCommand.ts b/clients/client-imagebuilder/src/commands/ListImageRecipesCommand.ts
@@ -56,7 +56,7 @@ export interface ListImageRecipesCommandOutput extends ListImageRecipesResponse,
  * //     { // ImageRecipeSummary
  * //       arn: "STRING_VALUE",
  * //       name: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       owner: "STRING_VALUE",
  * //       parentImage: "STRING_VALUE",
  * //       dateCreated: "STRING_VALUE",

diff --git a/clients/client-imagebuilder/src/commands/ListImagesCommand.ts b/clients/client-imagebuilder/src/commands/ListImagesCommand.ts
@@ -61,7 +61,7 @@ export interface ListImagesCommandOutput extends ListImagesResponse, __MetadataB
  * //       name: "STRING_VALUE",
  * //       type: "AMI" || "DOCKER",
  * //       version: "STRING_VALUE",
- * //       platform: "Windows" || "Linux",
+ * //       platform: "Windows" || "Linux" || "macOS",
  * //       osVersion: "STRING_VALUE",
  * //       owner: "STRING_VALUE",
  * //       dateCreated: "STRING_VALUE",

diff --git a/clients/client-imagebuilder/src/commands/ListInfrastructureConfigurationsCommand.ts b/clients/client-imagebuilder/src/commands/ListInfrastructureConfigurationsCommand.ts
@@ -73,6 +73,12 @@ export interface ListInfrastructureConfigurationsCommandOutput
  * //         "STRING_VALUE",
  * //       ],
  * //       instanceProfileName: "STRING_VALUE",
+ * //       placement: { // Placement
+ * //         availabilityZone: "STRING_VALUE",
+ * //         tenancy: "default" || "dedicated" || "host",
+ * //         hostId: "STRING_VALUE",
+ * //         hostResourceGroupArn: "STRING_VALUE",
+ * //       },
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

diff --git a/clients/client-imagebuilder/src/commands/UpdateInfrastructureConfigurationCommand.ts b/clients/client-imagebuilder/src/commands/UpdateInfrastructureConfigurationCommand.ts
@@ -64,14 +64,20 @@ export interface UpdateInfrastructureConfigurationCommandOutput
  *   keyPair: "STRING_VALUE",
  *   terminateInstanceOnFailure: true || false,
  *   snsTopicArn: "STRING_VALUE",
- *   clientToken: "STRING_VALUE", // required
  *   resourceTags: { // ResourceTagMap
  *     "<keys>": "STRING_VALUE",
  *   },
  *   instanceMetadataOptions: { // InstanceMetadataOptions
  *     httpTokens: "STRING_VALUE",
  *     httpPutResponseHopLimit: Number("int"),
  *   },
+ *   placement: { // Placement
+ *     availabilityZone: "STRING_VALUE",
+ *     tenancy: "default" || "dedicated" || "host",
+ *     hostId: "STRING_VALUE",
+ *     hostResourceGroupArn: "STRING_VALUE",
+ *   },
+ *   clientToken: "STRING_VALUE", // required
  * };
  * const command = new UpdateInfrastructureConfigurationCommand(input);
  * const response = await client.send(command);