文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 使用 的映像建置器範例 AWS CLI
下列程式碼範例示範如何使用 AWS Command Line Interface 搭配映像建置器來執行動作和實作常見案例。
*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。
每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。
**Topics**
+ [動作](#actions)
## 動作
### `create-component`
以下程式碼範例顯示如何使用 `create-component`。
**AWS CLI**
**建立新元件**
下列 `create-component` 範例會建立使用 JSON 文件檔案的元件，並以 YAML 格式參考上傳至 Amazon S3 儲存貯體的元件文件。
```
aws imagebuilder create-component \
--cli-input-json file://create-component.json
```
`create-component.json` 的內容：
```
{
"name": "MyExampleComponent",
"semanticVersion": "2019.12.02",
"description": "An example component that builds, validates and tests an image",
"changeDescription": "Initial version.",
"platform": "Windows",
"uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml"
}
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-component.html)。
### `create-distribution-configuration`
以下程式碼範例顯示如何使用 `create-distribution-configuration`。
**AWS CLI**
**建立分佈組態**
下列 `create-distribution-configuration` 範例會使用 JSON 檔案建立分佈組態。
```
aws imagebuilder create-distribution-configuration \
--cli-input-json file:/create-distribution-configuration.json
```
`create-distribution-configuration.json` 的內容：
```
{
"name": "MyExampleDistribution",
"description": "Copies AMI to eu-west-1",
"distributions": [
{
"region": "us-west-2",
"amiDistributionConfiguration": {
"name": "Name {{imagebuilder:buildDate}}",
"description": "An example image name with parameter references",
"amiTags": {
"KeyName": "{{ssm:parameter_name}}"
},
"launchPermission": {
"userIds": [
"123456789012"
]
}
}
},
{
"region": "eu-west-1",
"amiDistributionConfiguration": {
"name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}",
"amiTags": {
"KeyName": "Value"
},
"launchPermission": {
"userIds": [
"123456789012"
]
}
}
}
]
}
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [CreateDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-distribution-configuration.html)。
### `create-image-pipeline`
以下程式碼範例顯示如何使用 `create-image-pipeline`。
**AWS CLI**
**建立映像管道**
下列 `create-image-pipeline` 範例會使用 JSON 檔案建立映像管道。
```
aws imagebuilder create-image-pipeline \
--cli-input-json file://create-image-pipeline.json
```
`create-image-pipeline.json` 的內容：
```
{
"name": "MyWindows2016Pipeline",
"description": "Builds Windows 2016 Images",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
"distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
"imageTestsConfiguration": {
"imageTestsEnabled": true,
"timeoutMinutes": 60
},
"schedule": {
"scheduleExpression": "cron(0 0 * * SUN)",
"pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
},
"status": "ENABLED"
}
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image-pipeline.html)。
### `create-image-recipe`
以下程式碼範例顯示如何使用 `create-image-recipe`。
**AWS CLI**
**建立配方**
下列 `create-image-recipe` 範例會使用 JSON 檔案建立映像配方。元件會依指定順序進行安裝。
```
aws imagebuilder create-image-recipe \
--cli-input-json file://create-image-recipe.json
```
`create-image-recipe.json` 的內容：
```
{
"name": "MyBasicRecipe",
"description": "This example image recipe creates a Windows 2016 image.",
"semanticVersion": "2019.12.03",
"components":
[
{
"componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1"
},
{
"componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"
}
],
"parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/xxxx.x.x"
}
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateImageRecipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image-recipe.html)。
### `create-image`
以下程式碼範例顯示如何使用 `create-image`。
**AWS CLI**
**建立映像**
以下 `create-image` 範例會建立映像。
```
aws imagebuilder create-image \
--image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03 \
--infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image.html)。
### `create-infrastructure-configuration`
以下程式碼範例顯示如何使用 `create-infrastructure-configuration`。
**AWS CLI**
**建立基礎設施組態**
下列`create-infrastructure-configuration`範例會使用 JSON 檔案建立基礎設施組態。
```
aws imagebuilder create-infrastructure-configuration \
--cli-input-json file://create-infrastructure-configuration.json
```
`create-infrastructure-configuration.json` 的內容：
```
{
"name": "MyExampleInfrastructure",
"description": "An example that will retain instances of failed builds",
"instanceTypes": [
"m5.large", "m5.xlarge"
],
"instanceProfileName": "EC2InstanceProfileForImageBuilder",
"securityGroupIds": [
"sg-a1b2c3d4"
],
"subnetId": "subnet-a1b2c3d4",
"logging": {
"s3Logs": {
"s3BucketName": "bucket-name",
"s3KeyPrefix": "bucket-path"
}
},
"keyPair": "key-pair-name",
"terminateInstanceOnFailure": false,
"snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-topic-name"
}
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [CreateInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-infrastructure-configuration.html)。
### `delete-component`
以下程式碼範例顯示如何使用 `delete-component`。
**AWS CLI**
**刪除元件**
下列 `delete-component` 範例會透過指定元件組建版本 ARN 來刪除元件組建版本。
```
aws imagebuilder delete-component \
--component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-component.html)。
### `delete-image-pipeline`
以下程式碼範例顯示如何使用 `delete-image-pipeline`。
**AWS CLI**
**刪除映像管道**
下列 `delete-image-pipeline` 範例會透過指定映像管道的 ARN 來刪除映像管道。
```
aws imagebuilder delete-image-pipeline \
--image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/my-example-pipeline
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image-pipeline.html)。
### `delete-image-recipe`
以下程式碼範例顯示如何使用 `delete-image-recipe`。
**AWS CLI**
**刪除映像配方**
下列 `delete-image-recipe` 範例會透過指定映像配方的 ARN 來刪除映像配方。
```
aws imagebuilder delete-image-recipe \
--image-recipe-arn arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteImageRecipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image-recipe.html)。
### `delete-image`
以下程式碼範例顯示如何使用 `delete-image`。
**AWS CLI**
**刪除映像**
下列 `delete-image` 範例會透過指定映像組建版本 ARN 來刪除映像組建版本。
```
aws imagebuilder delete-image \
--image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.02/1
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image.html)。
### `delete-infrastructure-configuration`
以下程式碼範例顯示如何使用 `delete-infrastructure-configuration`。
**AWS CLI**
**刪除基礎設施組態**
下列 `delete-infrastructure-configuration` 範例會透過指定映像管道的 ARN 來刪除映像管道。
```
aws imagebuilder delete-infrastructure-configuration \
--infrastructure-configuration-arn arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/myexampleinfrastructure
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-infrastructure-configuration.html)。
### `get-component-policy`
以下程式碼範例顯示如何使用 `get-component-policy`。
**AWS CLI**
**取得元件政策詳細資訊**
下列 `get-component-policy` 範例透過指定元件政策的 ARN 來列出元件政策的詳細資訊。
```
aws imagebuilder get-component-policy \
--component-arn arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/1
```
輸出：
```
{
"Policy": "{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetComponent", "imagebuilder:ListComponents" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/1" ] } ] }"
}
```
如需詳細資訊，請參閱 EC2 Image Builder 使用者指南中的使用 AWS CLI `\$1\$1 設定和管理 EC2 Image Builder Image Pipeline。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetComponentPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-component-policy.html)。
### `get-component`
以下程式碼範例顯示如何使用 `get-component`。
**AWS CLI**
**取得元件詳細資訊**
下列 `get-component` 範例透過指定元件的 ARN 來列出元件的詳細資訊。
```
aws imagebuilder get-component \
--component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"component": {
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1",
"name": "component-name",
"version": "1.0.0",
"type": "TEST",
"platform": "Linux",
"owner": "123456789012",
"data": "name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n - name: test\n steps:\n - name: HelloWorldStep\n action: ExecuteBash\n inputs:\n commands:\n - echo \"Hello World! Test.\"\n",
"encrypted": true,
"dateCreated": "2020-01-27T20:43:30.306Z",
"tags": {}
}
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-component.html)。
### `get-distribution-configuration`
以下程式碼範例顯示如何使用 `get-distribution-configuration`。
**AWS CLI**
**取得分佈組態的詳細資訊**
下列 `get-distribution-configuration` 範例透過指定分佈組態的 ARN 來顯示分佈組態的詳細資訊。
```
aws imagebuilder get-distribution-configuration \
--distribution-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"distributionConfiguration": {
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
"name": "MyExampleDistribution",
"description": "Copies AMI to eu-west-1 and exports to S3",
"distributions": [
{
"region": "us-west-2",
"amiDistributionConfiguration": {
"name": "Name {{imagebuilder:buildDate}}",
"description": "An example image name with parameter references",
"amiTags": {
"KeyName": "{{ssm:parameter_name}}"
},
"launchPermission": {
"userIds": [
"123456789012"
]
}
}
},
{
"region": "eu-west-1",
"amiDistributionConfiguration": {
"name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}",
"amiTags": {
"KeyName": "Value"
},
"launchPermission": {
"userIds": [
"123456789012"
]
}
}
}
],
"dateCreated": "2020-02-19T18:40:10.529Z",
"tags": {}
}
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-distribution-configuration.html)。
### `get-image-pipeline`
以下程式碼範例顯示如何使用 `get-image-pipeline`。
**AWS CLI**
**取得映像管道詳細資訊**
下列 `get-image-pipeline` 範例會指定映像管道的 ARN 來列出映像管道的詳細資訊。
```
aws imagebuilder get-image-pipeline \
--image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imagePipeline": {
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
"name": "MyWindows2016Pipeline",
"description": "Builds Windows 2016 Images",
"platform": "Windows",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
"distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
"imageTestsConfiguration": {
"imageTestsEnabled": true,
"timeoutMinutes": 60
},
"schedule": {
"scheduleExpression": "cron(0 0 * * SUN)",
"pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
},
"status": "ENABLED",
"dateCreated": "2020-02-19T19:04:01.253Z",
"dateUpdated": "2020-02-19T19:04:01.253Z",
"tags": {}
}
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-pipeline.html)。
### `get-image-policy`
以下程式碼範例顯示如何使用 `get-image-policy`。
**AWS CLI**
**取得映像政策詳細資訊**
下列 `get-image-policy` 範例會指定映像政策的 ARN 來列出映像政策的詳細資訊。
```
aws imagebuilder get-image-policy \
--image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/1
```
輸出：
```
{
"Policy": "{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImage", "imagebuilder:ListImages" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/1" ] } ] }"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetImagePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-policy.html)。
### `get-image-recipe-policy`
以下程式碼範例顯示如何使用 `get-image-recipe-policy`。
**AWS CLI**
**取得映像配方政策詳細資訊**
下列 `get-image-recipe-policy` 範例會指定映像政策的 ARN 來列出映像政策的詳細資訊。
```
aws imagebuilder get-image-recipe-policy \
--image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-example-image-recipe/2019.12.03/1
```
輸出：
```
{
"Policy": "{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImageRecipe", "imagebuilder:ListImageRecipes" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-example-image-recipe/2019.12.03/1" ] } ] }"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetImageRecipePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-recipe-policy.html)。
### `get-image`
以下程式碼範例顯示如何使用 `get-image`。
**AWS CLI**
**取得映像詳細資訊**
下列 `get-image` 範例透過指定映像的 ARN 來列出映像的詳細資訊。
```
aws imagebuilder get-image \
--image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"image": {
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1",
"name": "MyBasicRecipe",
"version": "2019.12.03/1",
"platform": "Windows",
"state": {
"status": "BUILDING"
},
"imageRecipe": {
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
"name": "MyBasicRecipe",
"description": "This example image recipe creates a Windows 2016 image.",
"platform": "Windows",
"version": "2019.12.03",
"components": [
{
"componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1"
},
{
"componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"
}
],
"parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.12.17/1",
"dateCreated": "2020-02-14T19:46:16.904Z",
"tags": {}
},
"infrastructureConfiguration": {
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
"name": "MyExampleInfrastructure",
"description": "An example that will retain instances of failed builds",
"instanceTypes": [
"m5.large",
"m5.xlarge"
],
"instanceProfileName": "EC2InstanceProfileForImageFactory",
"securityGroupIds": [
"sg-a1b2c3d4"
],
"subnetId": "subnet-a1b2c3d4",
"logging": {
"s3Logs": {
"s3BucketName": "bucket-name",
"s3KeyPrefix": "bucket-path"
}
},
"keyPair": "Sam",
"terminateInstanceOnFailure": false,
"snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name",
"dateCreated": "2020-02-14T21:21:05.098Z",
"tags": {}
},
"imageTestsConfiguration": {
"imageTestsEnabled": true,
"timeoutMinutes": 720
},
"dateCreated": "2020-02-14T23:14:13.597Z",
"outputResources": {
"amis": []
},
"tags": {}
}
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image.html)。
### `get-infrastructure-configuration`
以下程式碼範例顯示如何使用 `get-infrastructure-configuration`。
**AWS CLI**
**取得基礎設施組態詳細資訊**
下列 `get-infrastructure-configuration` 範例透過指定基礎設施組態的 ARN 來列出基礎設施組態的詳細資訊。
```
aws imagebuilder get-infrastructure-configuration \
--infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"infrastructureConfiguration": {
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
"name": "MyExampleInfrastructure",
"description": "An example that will retain instances of failed builds",
"instanceTypes": [
"m5.large",
"m5.xlarge"
],
"instanceProfileName": "EC2InstanceProfileForImageBuilder",
"securityGroupIds": [
"sg-a48c95ef"
],
"subnetId": "subnet-a48c95ef",
"logging": {
"s3Logs": {
"s3BucketName": "bucket-name",
"s3KeyPrefix": "bucket-path"
}
},
"keyPair": "Name",
"terminateInstanceOnFailure": false,
"snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name",
"dateCreated": "2020-02-19T19:11:51.858Z",
"tags": {}
}
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-infrastructure-configuration.html)。
### `import-component`
以下程式碼範例顯示如何使用 `import-component`。
**AWS CLI**
**匯入元件**
下列 `import-component` 範例會使用 JSON 檔案匯入先前存在的指令碼。
```
aws imagebuilder import-component \
--cli-input-json file://import-component.json
```
`import-component.json` 的內容：
```
{
"name": "MyImportedComponent",
"semanticVersion": "1.0.0",
"description": "An example of how to import a component",
"changeDescription": "First commit message.",
"format": "SHELL",
"platform": "Windows",
"type": "BUILD",
"uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml"
}
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [ImportComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/import-component.html)。
### `list-component-build-versions`
以下程式碼範例顯示如何使用 `list-component-build-versions`。
**AWS CLI**
**列出元件組建版本**
下列 `list-component-build-versions` 範例列出具有特定語意版本的元件組建版本。
```
aws imagebuilder list-component-build-versions --component-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"componentSummaryList": [
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1",
"name": "MyExampleComponent",
"version": "2019.12.02",
"platform": "Windows",
"type": "BUILD",
"owner": "123456789012",
"description": "An example component that builds, validates and tests an image",
"changeDescription": "Initial version.",
"dateCreated": "2020-02-19T18:53:45.940Z",
"tags": {
"KeyName": "KeyValue"
}
}
]
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListComponentBuildVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-component-build-versions.html)。
### `list-components`
以下程式碼範例顯示如何使用 `list-components`。
**AWS CLI**
**列出所有元件語意版本**
下列 `list-components` 範例列出您有權存取的所有元件語意版本。您可以選擇性地篩選是否列出您擁有的元件、Amazon 擁有的元件，或是其他帳戶與您共用的元件。
```
aws imagebuilder list-components
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"componentVersionList": [
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0",
"name": "component-name",
"version": "1.0.0",
"platform": "Linux",
"type": "TEST",
"owner": "123456789012",
"dateCreated": "2020-01-27T20:43:30.306Z"
}
]
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-components.html)。
### `list-distribution-configurations`
以下程式碼範例顯示如何使用 `list-distribution-configurations`。
**AWS CLI**
**列出分佈**
以下 `list-distribution-configurations` 範例請求列出您的所有分佈。
```
aws imagebuilder list-distribution-configurations
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"distributionConfigurationSummaryList": [
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
"name": "MyExampleDistribution",
"description": "Copies AMI to eu-west-1 and exports to S3",
"dateCreated": "2020-02-19T18:40:10.529Z",
"tags": {
"KeyName": "KeyValue"
}
}
]
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListDistributionConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-distribution-configurations.html)。
### `list-image-build-versions`
以下程式碼範例顯示如何使用 `list-image-build-versions`。
**AWS CLI**
**列出映像組建版本**
下列 `list-image-build-versions` 範例列出具有語意版本的所有映像組建版本。
```
aws imagebuilder list-image-build-versions \
--image-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageSummaryList": [
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7",
"name": "MyBasicRecipe",
"version": "2019.12.03/7",
"platform": "Windows",
"state": {
"status": "FAILED",
"reason": "Can't start SSM Automation for arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7 during building. Parameter \"iamInstanceProfileName\" has a null value."
},
"owner": "123456789012",
"dateCreated": "2020-02-19T18:56:11.511Z",
"outputResources": {
"amis": []
},
"tags": {}
},
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/6",
"name": "MyBasicRecipe",
"version": "2019.12.03/6",
"platform": "Windows",
"state": {
"status": "FAILED",
"reason": "An internal error has occurred."
},
"owner": "123456789012",
"dateCreated": "2020-02-18T22:49:08.142Z",
"outputResources": {
"amis": [
{
"region": "us-west-2",
"image": "ami-a1b2c3d4567890ab",
"name": "MyBasicRecipe 2020-02-18T22-49-38.704Z",
"description": "This example image recipe creates a Windows 2016 image."
},
{
"region": "us-west-2",
"image": "ami-a1b2c3d4567890ab",
"name": "Name 2020-02-18T22-49-08.131Z",
"description": "Copies AMI to eu-west-2 and exports to S3"
},
{
"region": "eu-west-2",
"image": "ami-a1b2c3d4567890ab",
"name": "My 6 image 2020-02-18T22-49-08.131Z",
"description": "Copies AMI to eu-west-2 and exports to S3"
}
]
},
"tags": {}
},
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/5",
"name": "MyBasicRecipe",
"version": "2019.12.03/5",
"platform": "Windows",
"state": {
"status": "AVAILABLE"
},
"owner": "123456789012",
"dateCreated": "2020-02-18T16:51:48.403Z",
"outputResources": {
"amis": [
{
"region": "us-west-2",
"image": "ami-a1b2c3d4567890ab",
"name": "MyBasicRecipe 2020-02-18T16-52-18.965Z",
"description": "This example image recipe creates a Windows 2016 image."
}
]
},
"tags": {}
},
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/4",
"name": "MyBasicRecipe",
"version": "2019.12.03/4",
"platform": "Windows",
"state": {
"status": "AVAILABLE"
},
"owner": "123456789012",
"dateCreated": "2020-02-18T16:50:01.827Z",
"outputResources": {
"amis": [
{
"region": "us-west-2",
"image": "ami-a1b2c3d4567890ab",
"name": "MyBasicRecipe 2020-02-18T16-50-32.280Z",
"description": "This example image recipe creates a Windows 2016 image."
}
]
},
"tags": {}
},
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/3",
"name": "MyBasicRecipe",
"version": "2019.12.03/3",
"platform": "Windows",
"state": {
"status": "AVAILABLE"
},
"owner": "123456789012",
"dateCreated": "2020-02-14T23:14:13.597Z",
"outputResources": {
"amis": [
{
"region": "us-west-2",
"image": "ami-a1b2c3d4567890ab",
"name": "MyBasicRecipe 2020-02-14T23-14-44.243Z",
"description": "This example image recipe creates a Windows 2016 image."
}
]
},
"tags": {}
},
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/2",
"name": "MyBasicRecipe",
"version": "2019.12.03/2",
"platform": "Windows",
"state": {
"status": "FAILED",
"reason": "SSM execution 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111' failed with status = 'Failed' and failure message = 'Step fails when it is verifying the command has completed. Command a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 returns unexpected invocation result: \n{Status=[Failed], ResponseCode=[1], Output=[\n----------ERROR-------\nfailed to run commands: exit status 1], OutputPayload=[{\"Status\":\"Failed\",\"ResponseCode\":1,\"Output\":\"\\n----------ERROR-------\\nfailed to run commands: exit status 1\",\"CommandId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111\"}], CommandId=[a1b2c3d4-5678-90ab-cdef-EXAMPLE11111]}. Please refer to Automation Service Troubleshooting Guide for more diagnosis details.'"
},
"owner": "123456789012",
"dateCreated": "2020-02-14T22:57:42.593Z",
"outputResources": {
"amis": []
},
"tags": {}
}
]
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListImageBuildVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-build-versions.html)。
### `list-image-pipeline-images`
以下程式碼範例顯示如何使用 `list-image-pipeline-images`。
**AWS CLI**
**列出映像管道映像**
下列 `list-image-pipeline-images` 範例列出由特定映像管道建立的所有映像。
```
aws imagebuilder list-image-pipeline-images \
--image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imagePipelineList": [
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
"name": "MyWindows2016Pipeline",
"description": "Builds Windows 2016 Images",
"platform": "Windows",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
"distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
"imageTestsConfiguration": {
"imageTestsEnabled": true,
"timeoutMinutes": 60
},
"schedule": {
"scheduleExpression": "cron(0 0 * * SUN)",
"pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
},
"status": "ENABLED",
"dateCreated": "2020-02-19T19:04:01.253Z",
"dateUpdated": "2020-02-19T19:04:01.253Z",
"tags": {
"KeyName": "KeyValue"
}
},
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/sam",
"name": "PipelineName",
"platform": "Linux",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/recipe-name-a1b2c3d45678/1.0.0",
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/infrastructureconfiguration-name-a1b2c3d45678",
"imageTestsConfiguration": {
"imageTestsEnabled": true,
"timeoutMinutes": 720
},
"status": "ENABLED",
"dateCreated": "2019-12-16T18:19:02.068Z",
"dateUpdated": "2019-12-16T18:19:02.068Z",
"tags": {
"KeyName": "KeyValue"
}
}
]
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListImagePipelineImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-pipeline-images.html)。
### `list-image-recipes`
以下程式碼範例顯示如何使用 `list-image-recipes`。
**AWS CLI**
**列出映像配方**
下列 `list-image-recipes` 範例列出所有映像配方。
```
aws imagebuilder list-image-recipes
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageRecipeSummaryList": [
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
"name": "MyBasicRecipe",
"platform": "Windows",
"owner": "123456789012",
"parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x",
"dateCreated": "2020-02-19T18:54:25.975Z",
"tags": {
"KeyName": "KeyValue"
}
},
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/recipe-name-a1b2c3d45678/1.0.0",
"name": "recipe-name-a1b2c3d45678",
"platform": "Linux",
"owner": "123456789012",
"parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/2019.11.21",
"dateCreated": "2019-12-16T18:19:00.120Z",
"tags": {
"KeyName": "KeyValue"
}
}
]
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListImageRecipes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-recipes.html)。
### `list-images`
以下程式碼範例顯示如何使用 `list-images`。
**AWS CLI**
**列出映像**
下列 `list-images` 範例列出您有權存取的所有語意版本。
```
aws imagebuilder list-images
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageVersionList": [
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03",
"name": "MyBasicRecipe",
"version": "2019.12.03",
"platform": "Windows",
"owner": "123456789012",
"dateCreated": "2020-02-14T21:29:18.810Z"
}
]
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-images.html)。
### `list-infrastructure-configurations`
以下程式碼範例顯示如何使用 `list-infrastructure-configurations`。
**AWS CLI**
**列出基礎設施組態**
下列 `list-infrastructure-configurations` 範例列出所有基礎設施組態。
```
aws imagebuilder list-infrastructure-configurations
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"infrastructureConfigurationSummaryList": [
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
"name": "MyExampleInfrastructure",
"description": "An example that will retain instances of failed builds",
"dateCreated": "2020-02-19T19:11:51.858Z",
"tags": {}
},
{
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/infrastructureconfiguration-name-a1b2c3d45678",
"name": "infrastructureConfiguration-name-a1b2c3d45678",
"dateCreated": "2019-12-16T18:19:01.038Z",
"tags": {
"KeyName": "KeyValue"
}
}
]
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListInfrastructureConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-infrastructure-configurations.html)。
### `list-tags-for-resource`
以下程式碼範例顯示如何使用 `list-tags-for-resource`。
**AWS CLI**
**列出特定資源的標籤**
以下 `list-tags-for-resource` 範例會列出特定資源的所有標籤：
```
aws imagebuilder list-tags-for-resource \
--resource-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
```
輸出：
```
{
"tags": {
"KeyName": "KeyValue"
}
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-tags-for-resource.html)。
### `put-component-policy`
以下程式碼範例顯示如何使用 `put-component-policy`。
**AWS CLI**
**將資源政策套用至元件**
下列 `put-component-policy` 命令會將資源政策套用至組建元件，以啟用組建元件的跨帳戶共用。我們建議您使用 RAM CLI 命令 `create-resource-share`。如果您使用 EC2 Image Builder CLI 命令 `put-component-policy`，您還必須使用 RAM CLI 命令 `promote-resource-share-create-from-policy`，如此才能讓與資源共用的所有主體看見資源。
```
aws imagebuilder put-component-policy \
--component-arn arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1 \
--policy '{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetComponent", "imagebuilder:ListComponents" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1" ] } ] }'
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutComponentPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-component-policy.html)。
### `put-image-policy`
以下程式碼範例顯示如何使用 `put-image-policy`。
**AWS CLI**
**將資源政策套用至映像**
下列 `put-image-policy` 命令會將資源政策套用至映像，以啟用映像的跨帳戶共用。我們建議您使用 RAM CLI 命令 create-resource-share。如果您使用 EC2 Image Builder CLI 命令 put-image-policy，您還必須使用 RAM CLI 命令 promote-resource-share-create-from-policy，如此才能讓與資源共用的所有主體看見資源。
```
aws imagebuilder put-image-policy \
--image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1 \
--policy '{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImage", "imagebuilder:ListImages" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1" ] } ] }'
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutImagePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-image-policy.html)。
### `put-image-recipe-policy`
以下程式碼範例顯示如何使用 `put-image-recipe-policy`。
**AWS CLI**
**將資源政策套用至映像配方**
下列 `put-image-recipe-policy` 命令會將資源政策套用至映像配方，以啟用映像配方的跨帳戶共用。我們建議您使用 RAM CLI 命令 `create-resource-share`。如果您使用 EC2 Image Builder CLI 命令 `put-image-recipe-policy`，您還必須使用 RAM CLI 命令 `promote-resource-share-create-from-policy`，如此才能讓與資源共用的所有主體看見資源。
```
aws imagebuilder put-image-recipe-policy \
--image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02 \
--policy '{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImageRecipe", "imagebuilder:ListImageRecipes" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02" ] } ] }'
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02/1"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [PutImageRecipePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-image-recipe-policy.html)。
### `start-image-pipeline-execution`
以下程式碼範例顯示如何使用 `start-image-pipeline-execution`。
**AWS CLI**
**手動啟動映像管道**
下列 `start-image-pipeline-execution` 範例會手動啟動映像管道。
```
aws imagebuilder start-image-pipeline-execution \
--image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartImagePipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/start-image-pipeline-execution.html)。
### `tag-resource`
以下程式碼範例顯示如何使用 `tag-resource`。
**AWS CLI**
**標記資源**
下列 `tag-resource` 範例會使用 JSON 檔案，將資源新增至 EC2 Image Builder，並加上標籤。
```
aws imagebuilder tag-resource \
--cli-input-json file://tag-resource.json
```
`tag-resource.json` 的內容：
```
{
"resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
"tags": {
"KeyName: "KeyValue"
}
}
```
此命令不會產生輸出。
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/tag-resource.html)。
### `untag-resource`
以下程式碼範例顯示如何使用 `untag-resource`。
**AWS CLI**
**將標籤從資源中移除**
下列 `untag-resource` 範例使用 JSON 檔案從資源移除標籤。
```
aws imagebuilder untag-resource \
--cli-input-json file://tag-resource.json
```
`untag-resource.json` 的內容：
```
{
"resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
"tagKeys": [
"KeyName"
]
}
```
此命令不會產生輸出。
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/untag-resource.html)。
### `update-distribution-configuration`
以下程式碼範例顯示如何使用 `update-distribution-configuration`。
**AWS CLI**
**更新分佈組態**
下列 `update-distribution-configuration` 範例會使用 JSON 檔案更新分佈組態。
```
aws imagebuilder update-distribution-configuration \
--cli-input-json file://update-distribution-configuration.json
```
`update-distribution-configuration.json` 的內容：
```
{
"distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
"description": "Copies AMI to eu-west-2 and exports to S3",
"distributions": [
{
"region": "us-west-2",
"amiDistributionConfiguration": {
"name": "Name {{imagebuilder:buildDate}}",
"description": "An example image name with parameter references"
}
},
{
"region": "eu-west-2",
"amiDistributionConfiguration": {
"name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}"
}
}
]
}
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-distribution-configuration.html)。
### `update-image-pipeline`
以下程式碼範例顯示如何使用 `update-image-pipeline`。
**AWS CLI**
**更新映像管道**
下列 `update-image-pipeline` 範例會使用 JSON 檔案更新映像管道。
```
aws imagebuilder update-image-pipeline \
--cli-input-json file://update-image-pipeline.json
```
`update-image-pipeline.json` 的內容：
```
{
"imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
"distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
"imageTestsConfiguration": {
"imageTestsEnabled": true,
"timeoutMinutes": 120
},
"schedule": {
"scheduleExpression": "cron(0 0 * * MON)",
"pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
},
"status": "DISABLED"
}
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-image-pipeline.html)。
### `update-infrastructure-configuration`
以下程式碼範例顯示如何使用 `update-infrastructure-configuration`。
**AWS CLI**
**更新基礎設施組態**
下列 `update-infrastructure-configuration` 範例會使用 JSON 檔案更新基礎設施組態。
```
aws imagebuilder update-infrastructure-configuration \
--cli-input-json file:/update-infrastructure-configuration.json
```
`update-infrastructure-configuration.json` 的內容：
```
{
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
"description": "An example that will terminate instances of failed builds",
"instanceTypes": [
"m5.large", "m5.2xlarge"
],
"instanceProfileName": "EC2InstanceProfileForImageFactory",
"securityGroupIds": [
"sg-a48c95ef"
],
"subnetId": "subnet-a48c95ef",
"logging": {
"s3Logs": {
"s3BucketName": "bucket-name",
"s3KeyPrefix": "bucket-path"
}
},
"terminateInstanceOnFailure": true,
"snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name"
}
```
輸出：
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```
如需詳細資訊，請參閱 [ EC2 Image Builder 使用者指南中的使用 AWS CLI 設定和管理 EC2 Image Builder Image Pipeline](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)。 *EC2 *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-infrastructure-configuration.html)。