Skip to content

DistributeImageRequest

Source code in docs_src/capo_imagebuilder/types/distribute_image_request.py
class DistributeImageRequest(TypedDict, closed=True):
    source_image: "capo_imagebuilder.types.non_empty_string.NonEmptyString"
    """<p>The source image to distribute. You can specify the source in any of the following formats:</p> <ul> <li> <p>An AMI ID.</p> </li> <li> <p>An Amazon Web Services Systems Manager Parameter Store reference, prefixed by <code>ssm:</code>, followed by the parameter name or ARN.</p> </li> <li> <p>An Image Builder image Amazon Resource Name (ARN). An image version ARN resolves to the latest available build version.</p> </li> </ul> <p>Whichever format you use, the source must resolve to an AMI in the current Amazon Web Services Region.</p>"""
    distribution_configuration_arn: "capo_imagebuilder.types.distribution_configuration_arn.DistributionConfigurationArn"
    """<p>The Amazon Resource Name (ARN) of the distribution configuration. The configuration defines target Regions, accounts, and AMI settings. The distribution configuration must be in the same Region as this operation.</p>"""
    execution_role: "capo_imagebuilder.types.role_name_or_arn.RoleNameOrArn"
    """<p>The name or Amazon Resource Name (ARN) of the IAM role that Image Builder assumes to distribute the image.</p>"""
    tags: NotRequired["capo_imagebuilder.types.tag_map.TagMap"]
    """<p>The tags to apply to the new Image Builder image resource that this operation creates. To tag the output AMIs, use <code>amiTags</code> in the distribution configuration.</p>"""
    client_token: "capo_imagebuilder.types.client_token.ClientToken"
    """<p>A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</p>"""
    logging_configuration: NotRequired[
        "capo_imagebuilder.types.image_logging_configuration.ImageLoggingConfiguration"
    ]
    """<p>The logging configuration for the distribution.</p>"""

client_token instance-attribute

client_token: ClientToken

A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

distribution_configuration_arn instance-attribute

distribution_configuration_arn: DistributionConfigurationArn

The Amazon Resource Name (ARN) of the distribution configuration. The configuration defines target Regions, accounts, and AMI settings. The distribution configuration must be in the same Region as this operation.

execution_role instance-attribute

execution_role: RoleNameOrArn

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder assumes to distribute the image.

logging_configuration instance-attribute

logging_configuration: NotRequired[ImageLoggingConfiguration]

The logging configuration for the distribution.

source_image instance-attribute

source_image: NonEmptyString

The source image to distribute. You can specify the source in any of the following formats:

  • An AMI ID.

  • An Amazon Web Services Systems Manager Parameter Store reference, prefixed by ssm:, followed by the parameter name or ARN.

  • An Image Builder image Amazon Resource Name (ARN). An image version ARN resolves to the latest available build version.

Whichever format you use, the source must resolve to an AMI in the current Amazon Web Services Region.

tags instance-attribute

tags: NotRequired[TagMap]

The tags to apply to the new Image Builder image resource that this operation creates. To tag the output AMIs, use amiTags in the distribution configuration.