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.

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]

  Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

  This field is autopopulated if not provided.

• tags (dict) –

  Specify tags for Image Builder to apply to the image resource that’s created When it starts pipeline execution.

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