Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . imagebuilder ]



Gets an infrastructure configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--infrastructure-configuration-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--infrastructure-configuration-arn (string)

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To get infrastructure configuration details

The following get-infrastructure-configuration example lists the details of an infrastructure configuration by specifying its 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": [
        "instanceProfileName": "EC2InstanceProfileForImageBuilder",
        "securityGroupIds": [
        "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": {}

For more information, see Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI in the EC2 Image Builder Users Guide.


requestId -> (string)

The request ID that uniquely identifies this request.

infrastructureConfiguration -> (structure)

The infrastructure configuration object.

arn -> (string)

The Amazon Resource Name (ARN) of the infrastructure configuration.

name -> (string)

The name of the infrastructure configuration.

description -> (string)

The description of the infrastructure configuration.

instanceTypes -> (list)

The instance types of the infrastructure configuration.


instanceProfileName -> (string)

The instance profile of the infrastructure configuration.

securityGroupIds -> (list)

The security group IDs of the infrastructure configuration.


subnetId -> (string)

The subnet ID of the infrastructure configuration.

logging -> (structure)

The logging configuration of the infrastructure configuration.

s3Logs -> (structure)

The Amazon S3 logging configuration.

s3BucketName -> (string)

The Amazon S3 bucket in which to store the logs.

s3KeyPrefix -> (string)

The Amazon S3 path in which to store the logs.

keyPair -> (string)

The Amazon EC2 key pair of the infrastructure configuration.

terminateInstanceOnFailure -> (boolean)

The terminate instance on failure configuration of the infrastructure configuration.

snsTopicArn -> (string)

The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.

dateCreated -> (string)

The date on which the infrastructure configuration was created.

dateUpdated -> (string)

The date on which the infrastructure configuration was last updated.

resourceTags -> (map)

The tags attached to the resource created by Image Builder.

key -> (string)

value -> (string)

instanceMetadataOptions -> (structure)

The instance metadata option settings for the infrastructure configuration.

httpTokens -> (string)

Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

  • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
  • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional .

httpPutResponseHopLimit -> (integer)

Limit the number of hops that an instance metadata request can traverse to reach its destination.

tags -> (map)

The tags of the infrastructure configuration.

key -> (string)

value -> (string)