Skip to content

StartImagePipelineExecutionRequest

Source code in docs_src/capo_imagebuilder/types/start_image_pipeline_execution_request.py 
15
16
17
18
19
20
21
class StartImagePipelineExecutionRequest(TypedDict, closed=True):
    image_pipeline_arn: "capo_imagebuilder.types.image_pipeline_arn.ImagePipelineArn"
    """<p>The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.</p>"""
    client_token: "capo_imagebuilder.types.client_token.ClientToken"
    """<p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</p>"""
    tags: NotRequired["capo_imagebuilder.types.tag_map.TagMap"]
    """<p>The tags for Image Builder to apply to the image resource that's created when pipeline execution starts.</p>"""

client_token instance-attribute 

client_token: ClientToken

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.

image_pipeline_arn instance-attribute 

image_pipeline_arn: ImagePipelineArn

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

tags instance-attribute 

tags: NotRequired[TagMap]

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