Table Of Contents

Feedback

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 ]

get-distribution-configuration

Description

Gets a distribution configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--distribution-configuration-arn (string)

The Amazon Resource Name (ARN) of the distribution 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.

Examples

To get the details of a distribution configuration

The following get-distribution-configuration example displays the details of a distribution configuration by specifying its ARN.

aws imagebuilder get-distribution-configuration \
    --distribution-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution

Output:

{
    "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": {}
    }
}

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.

Output

requestId -> (string)

The request ID that uniquely identifies this request.

distributionConfiguration -> (structure)

The distribution configuration object.

arn -> (string)

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

name -> (string)

The name of the distribution configuration.

description -> (string)

The description of the distribution configuration.

distributions -> (list)

The distributions of the distribution configuration.

(structure)

Defines the settings for a specific Region.

region -> (string)

The target Region.

amiDistributionConfiguration -> (structure)

The specific AMI settings (for example, launch permissions, AMI tags).

name -> (string)

The name of the distribution configuration.

description -> (string)

The description of the distribution configuration.

amiTags -> (map)

The tags to apply to AMIs distributed to this Region.

key -> (string)

value -> (string)

kmsKeyId -> (string)

The KMS key identifier used to encrypt the distributed image.

launchPermission -> (structure)

Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.

userIds -> (list)

The AWS account ID.

(string)

userGroups -> (list)

The name of the group.

(string)

licenseConfigurationArns -> (list)

The License Manager Configuration to associate with the AMI in the specified Region.

(string)

timeoutMinutes -> (integer)

The maximum duration in minutes for this distribution configuration.

dateCreated -> (string)

The date on which this distribution configuration was created.

dateUpdated -> (string)

The date on which this distribution configuration was last updated.

tags -> (map)

The tags of the distribution configuration.

key -> (string)

value -> (string)