# Ejemplos de Image Builder que utilizan la AWS CLI
En los siguientes ejemplos de código se muestra cómo realizar acciones e implementar escenarios comunes usando AWS Command Line Interface con Image Builder.
Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
**Topics**
+ [Acciones](#actions)
## Acciones
### `create-component`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-component`.
**AWS CLI**
**Para crear un componente**
En el siguiente ejemplo de `create-component`, se crea un componente que usa un archivo de documento JSON y hace referencia a un documento de componente en formato YAML que se carga en un bucket de Amazon S3.
```
aws imagebuilder create-component \
--cli-input-json file://create-component.json
```
Contenido de `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"
}
```
Salida:
```
{
"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"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [CreateComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-component.html) en la *Referencia de comandos de la AWS CLI*.
### `create-distribution-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-distribution-configuration`.
**AWS CLI**
**Para crear una configuración de distribución**
En el siguiente ejemplo de `create-distribution-configuration`, se crea una configuración de distribución mediante un archivo JSON.
```
aws imagebuilder create-distribution-configuration \
--cli-input-json file:/create-distribution-configuration.json
```
Contenido de `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"
]
}
}
}
]
}
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener más información sobre la API, consulte [CreateDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-distribution-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `create-image-pipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-image-pipeline`.
**AWS CLI**
**Para crear una canalización de imágenes**
En el siguiente ejemplo de `create-image-pipeline`, se crea una canalización de imágenes mediante un archivo JSON.
```
aws imagebuilder create-image-pipeline \
--cli-input-json file://create-image-pipeline.json
```
Contenido de `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"
}
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [CreateImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image-pipeline.html) en la *Referencia de comandos de la AWS CLI*.
### `create-image-recipe`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-image-recipe`.
**AWS CLI**
**Para crear una receta**
En el siguiente ejemplo de `create-image-recipe`, se crea una receta de imágenes mediante un archivo JSON. Los componentes se instalan en el orden en que se han especificado.
```
aws imagebuilder create-image-recipe \
--cli-input-json file://create-image-recipe.json
```
Contenido de `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"
}
```
Salida:
```
{
"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"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [CreateImageRecipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image-recipe.html) en la *Referencia de comandos de la AWS CLI*.
### `create-image`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-image`.
**AWS CLI**
**Para crear una imagen**
En el siguiente ejemplo de `create-image`, se crea una imagen.
```
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
```
Salida:
```
{
"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"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [CreateImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image.html) en la *Referencia de comandos de la AWS CLI*.
### `create-infrastructure-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-infrastructure-configuration`.
**AWS CLI**
**Para crear una configuración de infraestructura**
En el siguiente ejemplo de `create-infrastructure-configuration`, se crea una configuración de infraestructura mediante un archivo JSON.
```
aws imagebuilder create-infrastructure-configuration \
--cli-input-json file://create-infrastructure-configuration.json
```
Contenido de `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"
}
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [CreateInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-infrastructure-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-component`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-component`.
**AWS CLI**
**Para eliminar un componente**
En el siguiente ejemplo de `delete-component`, se muestra cómo eliminar una versión de compilación de componentes al especificar su ARN.
```
aws imagebuilder delete-component \
--component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [DeleteComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-component.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-image-pipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-image-pipeline`.
**AWS CLI**
**Para eliminar una canalización de imágenes**
En el siguiente ejemplo de `delete-image-pipeline`, se muestra cómo eliminar una canalización de imágenes al especificar su ARN.
```
aws imagebuilder delete-image-pipeline \
--image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/my-example-pipeline
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [DeleteImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image-pipeline.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-image-recipe`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-image-recipe`.
**AWS CLI**
**Para eliminar una receta de imágenes**
En el siguiente ejemplo de `delete-image-recipe`, se muestra cómo eliminar una receta de imágenes al especificar su ARN.
```
aws imagebuilder delete-image-recipe \
--image-recipe-arn arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [DeleteImageRecipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image-recipe.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-image`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-image`.
**AWS CLI**
**Para eliminar una imagen**
En el siguiente ejemplo de `delete-image`, se muestra cómo eliminar una versión de compilación de imágenes al especificar su ARN.
```
aws imagebuilder delete-image \
--image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.02/1
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [DeleteImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-infrastructure-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-infrastructure-configuration`.
**AWS CLI**
**Para eliminar una configuración de infraestructura**
En el siguiente ejemplo de `delete-infrastructure-configuration`, se muestra cómo eliminar una canalización de imágenes al especificar su ARN.
```
aws imagebuilder delete-infrastructure-configuration \
--infrastructure-configuration-arn arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/myexampleinfrastructure
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [DeleteInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-infrastructure-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `get-component-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-component-policy`.
**AWS CLI**
**Para obtener los detalles de la política de componentes**
En el siguiente ejemplo de `get-component-policy`, se enumeran los detalles de una política de componentes especificando su ARN.
```
aws imagebuilder get-component-policy \
--component-arn arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/1
```
Salida:
```
{
"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" ] } ] }"
}
```
Para obtener más información, consulte Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `\$1\$1 en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [GetComponentPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-component-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `get-component`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-component`.
**AWS CLI**
**Para obtener los detalles de los componentes**
En el siguiente ejemplo de `get-component`, se enumeran los detalles de un componente especificando su ARN.
```
aws imagebuilder get-component \
--component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1
```
Salida:
```
{
"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": {}
}
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [GetComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-component.html) en la *Referencia de comandos de la AWS CLI*.
### `get-distribution-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-distribution-configuration`.
**AWS CLI**
**Para obtener los detalles de una configuración de distribución**
En el siguiente ejemplo de `get-distribution-configuration`, se muestran los detalles de una configuración de distribución al especificar su ARN.
```
aws imagebuilder get-distribution-configuration \
--distribution-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution
```
Salida:
```
{
"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": {}
}
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [GetDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-distribution-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `get-image-pipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-image-pipeline`.
**AWS CLI**
**Para obtener los detalles de la canalización de imágenes**
En el siguiente ejemplo de `get-image-pipeline`, se enumeran los detalles una canalización de imágenes al especificar su ARN.
```
aws imagebuilder get-image-pipeline \
--image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
```
Salida:
```
{
"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": {}
}
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [GetImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-pipeline.html) en la *Referencia de comandos de la AWS CLI*.
### `get-image-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-image-policy`.
**AWS CLI**
**Para obtener los detalles de la política de imágenes**
En el siguiente ejemplo de `get-image-policy`, se enumeran los detalles de una política de imágenes especificando su ARN.
```
aws imagebuilder get-image-policy \
--image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/1
```
Salida:
```
{
"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" ] } ] }"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [GetImagePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `get-image-recipe-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-image-recipe-policy`.
**AWS CLI**
**Para obtener los detalles de la política de receta de imágenes**
En el siguiente ejemplo de `get-image-recipe-policy`, se enumeran los detalles de una política de receta de imágenes especificando su 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
```
Salida:
```
{
"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" ] } ] }"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [GetImageRecipePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-recipe-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `get-image`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-image`.
**AWS CLI**
**Para obtener los detalles de una imagen**
En el siguiente ejemplo de `get-image`, se enumeran los detalles de una imagen especificando su ARN.
```
aws imagebuilder get-image \
--image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1
```
Salida:
```
{
"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": {}
}
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [GetImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image.html) en la *Referencia de comandos de la AWS CLI*.
### `get-infrastructure-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-infrastructure-configuration`.
**AWS CLI**
**Para obtener los detalles de la configuración de una infraestructura**
En el siguiente ejemplo de `get-infrastructure-configuration`, se enumeran los detalles de la configuración de una infraestructura especificando su ARN.
```
aws imagebuilder get-infrastructure-configuration \
--infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure
```
Salida:
```
{
"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": {}
}
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [GetInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-infrastructure-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `import-component`
En el siguiente ejemplo de código, se muestra cómo utilizar `import-component`.
**AWS CLI**
**Para importar un componente**
En el siguiente ejemplo de `import-component`, se importa un script preexistente mediante un archivo JSON.
```
aws imagebuilder import-component \
--cli-input-json file://import-component.json
```
Contenido de `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"
}
```
Salida:
```
{
"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"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [ImportComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/import-component.html) en la *Referencia de comandos de la AWS CLI*.
### `list-component-build-versions`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-component-build-versions`.
**AWS CLI**
**Para enumerar las versiones de compilación de componentes**
En el siguiente ejemplo de `list-component-build-versions`, se enumeran las versiones de compilación de componentes que tienen una versión semántica específica.
```
aws imagebuilder list-component-build-versions --component-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02
```
Salida:
```
{
"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"
}
}
]
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [ListComponentBuildVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-component-build-versions.html) en la *Referencia de comandos de la AWS CLI*.
### `list-components`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-components`.
**AWS CLI**
**Para enumerar todas las versiones semánticas de los componentes**
En el siguiente ejemplo de `list-components`, se enumeran todas las versiones semánticas de los componentes a las que tiene acceso. Si lo desea, puede filtrar por la lista de componentes de su propiedad, de Amazon o que otras cuentas hayan compartido con usted.
```
aws imagebuilder list-components
```
Salida:
```
{
"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"
}
]
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener detalles de la API, consulte [ListComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-components.html) en la *Referencia de comandos de la AWS CLI*.
### `list-distribution-configurations`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-distribution-configurations`.
**AWS CLI**
**Para enumerar las distribuciones**
En el siguiente ejemplo de `list-distribution-configurations`, se enumeran todas las distribuciones.
```
aws imagebuilder list-distribution-configurations
```
Salida:
```
{
"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"
}
}
]
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [ListDistributionConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-distribution-configurations.html) en la *Referencia de comandos de la AWS CLI*.
### `list-image-build-versions`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-image-build-versions`.
**AWS CLI**
**Para enumerar las versiones de compilación de imágenes**
En el siguiente ejemplo de `list-image-build-versions`, se enumeran todas las versiones de compilación de componentes que tienen una versión semántica.
```
aws imagebuilder list-image-build-versions \
--image-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03
```
Salida:
```
{
"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": {}
}
]
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [ListImageBuildVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-build-versions.html) en la *Referencia de comandos de la AWS CLI*.
### `list-image-pipeline-images`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-image-pipeline-images`.
**AWS CLI**
**Para enumerar las imágenes de la canalización de imágenes**
En el siguiente ejemplo de `list-image-pipeline-images`, se enumeran todas las imágenes que se han creado mediante una canalización de imágenes específica.
```
aws imagebuilder list-image-pipeline-images \
--image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
```
Salida:
```
{
"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"
}
}
]
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [ListImagePipelineImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-pipeline-images.html) en la *Referencia de comandos de la AWS CLI*.
### `list-image-recipes`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-image-recipes`.
**AWS CLI**
**Para enumerar las recetas de imágenes**
En el siguiente ejemplo de `list-image-recipes`, se enumeran todas las recetas de imágenes.
```
aws imagebuilder list-image-recipes
```
Salida:
```
{
"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"
}
}
]
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [ListImageRecipes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-recipes.html) en la *Referencia de comandos de la AWS CLI*.
### `list-images`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-images`.
**AWS CLI**
**Para enumerar las imágenes**
En el siguiente ejemplo de `list-images`, se enumeran todas las versiones semánticas a las que tiene acceso.
```
aws imagebuilder list-images
```
Salida:
```
{
"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"
}
]
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [ListImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-images.html) en la *Referencia de comandos de la AWS CLI*.
### `list-infrastructure-configurations`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-infrastructure-configurations`.
**AWS CLI**
**Para enumerar las configuraciones de infraestructura**
En el siguiente ejemplo de `list-infrastructure-configurations`, se muestran todas las configuraciones de infraestructuras.
```
aws imagebuilder list-infrastructure-configurations
```
Salida:
```
{
"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"
}
}
]
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [ListInfrastructureConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-infrastructure-configurations.html) en la *Referencia de comandos de la AWS CLI*.
### `list-tags-for-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-tags-for-resource`.
**AWS CLI**
**Para enumerar las etiquetas para un recurso específico**
En el siguiente ejemplo de `list-tags-for-resource`, se enumeran todas las etiquetas de un recurso específico.
```
aws imagebuilder list-tags-for-resource \
--resource-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
```
Salida:
```
{
"tags": {
"KeyName": "KeyValue"
}
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para ver los detalles de la API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-tags-for-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `put-component-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `put-component-policy`.
**AWS CLI**
**Para aplicar una política de recursos a un componente**
En el siguiente comando de `put-component-policy`, se aplica una política de recursos a un componente de compilación para permitir el uso compartido entre cuentas de los componentes de compilación. Le recomendamos que utilice el comando de la CLI `create-resource-share` de RAM. Si utiliza el comando de la CLI `put-component-policy` de EC2 Image Builder, también debe utilizar el comando CLI `promote-resource-share-create-from-policy` de RAM para que el recurso esté visible para todas las entidades principales con las que se comparte el recurso.
```
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" ] } ] }'
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [PutComponentPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-component-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `put-image-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `put-image-policy`.
**AWS CLI**
**Para aplicar una política de recursos a una imagen**
En el siguiente comando de `put-image-policy`, se aplica una política de recursos a una imagen para permitir el uso compartido entre cuentas de imágenes. Le recomendamos que utilice el comando de la CLI create-resource-share de RAM. Si utiliza el comando de la CLI put-image-policy de EC2 Image Builder, también debe utilizar el comando CLI promote-resource-share-create-from-policy de RAM para que el recurso esté visible para todas las entidades principales con las que se comparte el recurso.
```
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" ] } ] }'
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información acerca de la API, consulte [PutImagePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-image-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `put-image-recipe-policy`
En el siguiente ejemplo de código, se muestra cómo utilizar `put-image-recipe-policy`.
**AWS CLI**
**Para aplicar una política de recursos a una receta de imágenes**
En el siguiente comando de `put-image-recipe-policy`, se aplica una política de recursos a una receta de imágenes para permitir el uso compartido entre cuentas de recetas de imágenes. Le recomendamos que utilice el comando de la CLI `create-resource-share` de RAM. Si utiliza el comando de la CLI `put-image-recipe-policy` de EC2 Image Builder, también debe utilizar el comando CLI `promote-resource-share-create-from-policy` de RAM para que el recurso esté visible para todas las entidades principales con las que se comparte el recurso.
```
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" ] } ] }'
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02/1"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [PutImageRecipePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-image-recipe-policy.html) en la *Referencia de comandos de la AWS CLI*.
### `start-image-pipeline-execution`
En el siguiente ejemplo de código, se muestra cómo utilizar `start-image-pipeline-execution`.
**AWS CLI**
**Para iniciar una canalización de imágenes manualmente**
En el siguiente ejemplo de `start-image-pipeline-execution`, se inicia manualmente una canalización de imágenes.
```
aws imagebuilder start-image-pipeline-execution \
--image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
```
Salida:
```
{
"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"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [StartImagePipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/start-image-pipeline-execution.html) en la *Referencia de comandos de la AWS CLI*.
### `tag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `tag-resource`.
**AWS CLI**
**Para etiquetar un recurso**
En el siguiente ejemplo de `tag-resource`, se agrega y etiqueta un recurso a EC2 Image Builder mediante un archivo JSON.
```
aws imagebuilder tag-resource \
--cli-input-json file://tag-resource.json
```
Contenido de `tag-resource.json`:
```
{
"resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
"tags": {
"KeyName: "KeyValue"
}
}
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para ver los detalles de la API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/tag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `untag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `untag-resource`.
**AWS CLI**
**Para eliminar una etiqueta de un recurso**
En el siguiente ejemplo de `untag-resource`, se elimina una etiqueta de un recurso mediante un archivo JSON.
```
aws imagebuilder untag-resource \
--cli-input-json file://tag-resource.json
```
Contenido de `untag-resource.json`:
```
{
"resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
"tagKeys": [
"KeyName"
]
}
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para ver los detalles de la API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/untag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `update-distribution-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-distribution-configuration`.
**AWS CLI**
**Para actualizar una configuración de distribución**
En el siguiente ejemplo de `update-distribution-configuration`, se crea una actualización de distribución mediante un archivo JSON.
```
aws imagebuilder update-distribution-configuration \
--cli-input-json file://update-distribution-configuration.json
```
Contenido de `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}}"
}
}
]
}
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener detalles sobre la API, consulte [UpdateDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-distribution-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `update-image-pipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-image-pipeline`.
**AWS CLI**
**Para actualizar una canalización de imágenes**
En el siguiente ejemplo de `update-image-pipeline`, se actualiza una canalización de imágenes mediante un archivo JSON.
```
aws imagebuilder update-image-pipeline \
--cli-input-json file://update-image-pipeline.json
```
Contenido de `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"
}
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener información sobre la API, consulte [UpdateImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-image-pipeline.html) en la *Referencia de comandos de la AWS CLI*.
### `update-infrastructure-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-infrastructure-configuration`.
**AWS CLI**
**Para actualizar una configuración de infraestructura**
En el siguiente ejemplo de `update-infrastructure-configuration`, se actualiza una configuración de infraestructura mediante un archivo JSON.
```
aws imagebuilder update-infrastructure-configuration \
--cli-input-json file:/update-infrastructure-configuration.json
```
Contenido de `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"
}
```
Salida:
```
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```
Para obtener más información, consulte [Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) en la *Guía del usuario de EC2 Image Builder*.
+ Para obtener detalles sobre la API, consulte [UpdateInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-infrastructure-configuration.html) en la *Referencia de comandos de la AWS CLI*.