View a markdown version of this page

List and view distribution configuration detail - EC2 Image Builder
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

List and view distribution configuration detail

This section describes the various ways that you can find information and view details for your EC2 Image Builder distribution configuration.

List distribution configurations

List the distribution configurations that are created under your account from the Amazon Web Services Management Console, the Amazon CLI, or Amazon Tools for PowerShell.

Amazon Web Services Management Console

To see a list of the distribution configurations created under your account in the Image Builder console, follow these steps:

  1. Open the EC2 Image Builder console at https://console.amazonaws.cn/imagebuilder/.

  2. Choose Distribution settings from the navigation pane. This shows a list of the distribution configurations that are created under your account.

Amazon CLI

The following example shows how to use the list-distribution-configurations command in the Amazon CLI to list all of your distribution configurations:

aws imagebuilder list-distribution-configurations

You can filter the list by distribution configuration name, which is the only supported filter. To page through results, use the --page-size, --max-items, and --starting-token options. The --page-size value can't exceed 100. The following example filters the list by name:

aws imagebuilder list-distribution-configurations --filters name=name,values=my-example-distribution
PowerShell

The following example shows how to use the Get-EC2IBDistributionConfigurationList cmdlet to list all of your distribution configurations:

Get-EC2IBDistributionConfigurationList

You can filter the list by distribution configuration name, which is the only supported filter. By default, the cmdlet retrieves all pages of results. To get one page at a time, use the NoAutoIteration, MaxResult, and NextToken parameters. The MaxResult value can't exceed 100. The following example filters the list by name:

Get-EC2IBDistributionConfigurationList -Filter @{Name="name";Values="my-example-distribution"}

Get distribution configuration details

View the details for a specific distribution configuration from the Amazon Web Services Management Console, the Amazon CLI, or Amazon Tools for PowerShell.

Amazon Web Services Management Console

To view details for a specific distribution configuration in the Image Builder console, follow these steps:

  1. Open the EC2 Image Builder console at https://console.amazonaws.cn/imagebuilder/.

  2. Choose Distribution settings from the navigation pane. This shows a list of the distribution configurations that are created under your account.

  3. To open the detail view, choose the Configuration name link.

    Note

    You can also select the check box next to the Configuration name, then choose View details.

On the distribution detail page, you can also Edit the distribution details, or Delete the distribution configuration.

Amazon CLI

The following example shows how to use the get-distribution-configuration command in the Amazon CLI to get the details of a distribution configuration by specifying its Amazon Resource Name (ARN):

aws imagebuilder get-distribution-configuration --distribution-configuration-arn arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration
PowerShell

The following example shows how to use the Get-EC2IBDistributionConfiguration cmdlet to get the details of a distribution configuration by specifying its Amazon Resource Name (ARN):

Get-EC2IBDistributionConfiguration -DistributionConfigurationArn arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration

Delete a distribution configuration

Delete a distribution configuration from the Amazon Web Services Management Console, the Amazon CLI, or Amazon Tools for PowerShell.

Note

You can't delete a distribution configuration that an image pipeline still references. Update or delete the pipeline first. For more information about deleting resources in Image Builder, see Delete outdated or unused Image Builder resources.

Amazon Web Services Management Console

To delete a distribution configuration in the Image Builder console, follow these steps:

  1. Open the EC2 Image Builder console at https://console.amazonaws.cn/imagebuilder/.

  2. Choose Distribution settings from the navigation pane. This shows a list of the distribution configurations that are created under your account.

  3. Choose the Configuration name link to open the detail view for the distribution configuration that you want to delete.

  4. Choose Delete, and then confirm the deletion.

Amazon CLI

The following example shows how to use the delete-distribution-configuration command to delete a distribution configuration by specifying its ARN:

aws imagebuilder delete-distribution-configuration --distribution-configuration-arn arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration
PowerShell

The following example shows how to use the Remove-EC2IBDistributionConfiguration cmdlet to delete a distribution configuration by specifying its ARN:

Remove-EC2IBDistributionConfiguration -DistributionConfigurationArn arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration