imagebuilder / Client / distribute_image

distribute_image

imagebuilder.Client.distribute_image(**kwargs)

Distributes an existing AMI to target Regions and accounts without running the full image build process. This operation only runs the distribution phase on an image that has already been built.

See also: AWS API Documentation

Request Syntax

response = client.distribute_image(
    sourceImage='string',
    distributionConfigurationArn='string',
    executionRole='string',
    tags={
        'string': 'string'
    },
    clientToken='string',
    loggingConfiguration={
        'logGroupName': 'string'
    }
)

Parameters:

• sourceImage (string) –

  [REQUIRED]

  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.

• distributionConfigurationArn (string) –

  [REQUIRED]

  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.

• executionRole (string) –

  [REQUIRED]

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

• tags (dict) –

  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.

  • (string) –

    • (string) –

• clientToken (string) –

  [REQUIRED]

  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.

  This field is autopopulated if not provided.

• loggingConfiguration (dict) –

  The logging configuration for the distribution.

  • logGroupName (string) –

    The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name.

Return type:

dict

Returns:

Response Syntax

{
    'clientToken': 'string',
    'imageBuildVersionArn': 'string'
}

Response Structure

• (dict) –

  • clientToken (string) –

    The client token that uniquely identifies the request.

  • imageBuildVersionArn (string) –

    The Amazon Resource Name (ARN) of the new Image Builder image resource that this operation creates to track the distribution. Use this ARN with GetImage to monitor distribution progress.

Exceptions

• imagebuilder.Client.exceptions.ServiceException

• imagebuilder.Client.exceptions.ClientException

• imagebuilder.Client.exceptions.ServiceUnavailableException

• imagebuilder.Client.exceptions.InvalidRequestException

• imagebuilder.Client.exceptions.IdempotentParameterMismatchException

• imagebuilder.Client.exceptions.ForbiddenException

• imagebuilder.Client.exceptions.CallRateLimitExceededException

• imagebuilder.Client.exceptions.ResourceInUseException

• imagebuilder.Client.exceptions.ServiceQuotaExceededException

• imagebuilder.Client.exceptions.AccessDeniedException

• imagebuilder.Client.exceptions.TooManyRequestsException

• imagebuilder.Client.exceptions.ResourceNotFoundException