imagebuilder / Client / start_image_pipeline_execution

start_image_pipeline_execution

imagebuilder.Client.start_image_pipeline_execution(**kwargs)

Manually triggers a pipeline to create an image. You can start a build this way whether the pipeline is enabled or disabled. The response returns as soon as Image Builder creates the new image resource and queues the build. Use the returned imageBuildVersionArn with GetImage to track build progress.

See also: AWS API Documentation

Request Syntax

response = client.start_image_pipeline_execution(
    imagePipelineArn='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)

Parameters:

• imagePipelineArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

• 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.

• tags (dict) –

  The tags for Image Builder to apply to the image resource that’s created when pipeline execution starts.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • requestId (string) –

    The request ID that uniquely identifies this request.

  • clientToken (string) –

    The client token that uniquely identifies the request.

  • imageBuildVersionArn (string) –

    The Amazon Resource Name (ARN) of the image that the request created.

Exceptions

• imagebuilder.Client.exceptions.ServiceException

• imagebuilder.Client.exceptions.ClientException

• imagebuilder.Client.exceptions.ServiceUnavailableException

• imagebuilder.Client.exceptions.InvalidRequestException

• imagebuilder.Client.exceptions.ResourceNotFoundException

• imagebuilder.Client.exceptions.IdempotentParameterMismatchException

• imagebuilder.Client.exceptions.ForbiddenException

• imagebuilder.Client.exceptions.CallRateLimitExceededException

• imagebuilder.Client.exceptions.ResourceInUseException