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'
)
Parameters
  • imagePipelineArn (string) --

    [REQUIRED]

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

  • clientToken (string) --

    [REQUIRED]

    The idempotency token used to make this request idempotent.

    This field is autopopulated if not provided.

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 idempotency token used to make this request idempotent.

    • imageBuildVersionArn (string) --

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

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