imagebuilder / Client / update_image_pipeline

update_image_pipeline#

imagebuilder.Client.update_image_pipeline(**kwargs)#

Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.

Note

UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.

See also: AWS API Documentation

Request Syntax

response = client.update_image_pipeline(
    imagePipelineArn='string',
    description='string',
    imageRecipeArn='string',
    containerRecipeArn='string',
    infrastructureConfigurationArn='string',
    distributionConfigurationArn='string',
    imageTestsConfiguration={
        'imageTestsEnabled': True|False,
        'timeoutMinutes': 123
    },
    enhancedImageMetadataEnabled=True|False,
    schedule={
        'scheduleExpression': 'string',
        'timezone': 'string',
        'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE'
    },
    status='DISABLED'|'ENABLED',
    clientToken='string'
)
Parameters:

  • imagePipelineArn (string) –

    [REQUIRED]

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

  • description (string) – The description of the image pipeline.

  • imageRecipeArn (string) – The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

  • containerRecipeArn (string) – The Amazon Resource Name (ARN) of the container pipeline to update.

  • infrastructureConfigurationArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.

  • distributionConfigurationArn (string) – The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.

  • imageTestsConfiguration (dict) –

    The image test configuration of the image pipeline.

    • imageTestsEnabled (boolean) –

      Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

    • timeoutMinutes (integer) –

      The maximum time in minutes that tests are permitted to run.

      Note

      The timeoutMinutes attribute is not currently active. This value is ignored.

  • enhancedImageMetadataEnabled (boolean) – Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

  • schedule (dict) –

    The schedule of the image pipeline.

    • scheduleExpression (string) –

      The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

      For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

    • timezone (string) –

      The timezone that applies to the scheduling expression. For example, “Etc/UTC”, “America/Los_Angeles” in the IANA timezone format. If not specified this defaults to UTC.

    • pipelineExecutionStartCondition (string) –

      The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

  • status (string) – The status of the image pipeline.

  • 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',
    'imagePipelineArn': '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.

    • imagePipelineArn (string) –

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

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