get_image_pipeline ¶

get_image_pipeline(
    image_pipeline_arn: ImagePipelineArn,
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
) -> GetImagePipelineResponse

Retrieves an image pipeline.

Parameters:

image_pipeline_arn (ImagePipelineArn) –

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

Raises:

CallRateLimitExceededException –

You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.
ClientException –

A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.
ForbiddenException –

You are not authorized to perform the requested operation.
InvalidRequestException –

The request is malformed or otherwise invalid. Verify the request and try again.
ServiceException –

An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
ServiceUnavailableException –

The service is unable to process your request at this time.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

Get the details of an image pipeline The following example retrieves an image pipeline that builds a new image every Sunday, including the image tests configuration and schedule start condition defaults that Image Builder applied at creation.

>>> client.get_image_pipeline(image_pipeline_arn='arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline')

Source code in docs_src/capo_imagebuilder/_services/imagebuilder.py

def get_image_pipeline(
    self,
    image_pipeline_arn: "capo_imagebuilder.types.image_pipeline_arn.ImagePipelineArn",
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
) -> "capo_imagebuilder.types.get_image_pipeline_response.GetImagePipelineResponse":
    """<p>Retrieves an image pipeline.</p>

    Args:
        image_pipeline_arn: <p>The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.</p>

    Raises:
        capo_imagebuilder.errors.call_rate_limit_exceeded_exception.CallRateLimitExceededException: <p>You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.</p>
        capo_imagebuilder.errors.client_exception.ClientException: <p>A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.</p>
        capo_imagebuilder.errors.forbidden_exception.ForbiddenException: <p>You are not authorized to perform the requested operation.</p>
        capo_imagebuilder.errors.invalid_request_exception.InvalidRequestException: <p>The request is malformed or otherwise invalid. Verify the request and try again.</p>
        capo_imagebuilder.errors.service_exception.ServiceException: <p>An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.</p>
        capo_imagebuilder.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is unable to process your request at this time.</p>
        capo_imagebuilder.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get the details of an image pipeline
        The following example retrieves an image pipeline that builds a new image every Sunday, including the image tests configuration and schedule start condition defaults that Image Builder applied at creation.

        >>> client.get_image_pipeline(image_pipeline_arn='arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline')
    """

    def _handler(
        req: "OperationRequest[capo_imagebuilder.types.get_image_pipeline_request.GetImagePipelineRequest]",
    ) -> OperationResponse[
        "capo_imagebuilder.types.get_image_pipeline_response.GetImagePipelineResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.get_image_pipeline

        output, http_response = (
            capo_imagebuilder._operations.imagebuilder.get_image_pipeline.get_image_pipeline(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetImagePipeline")
    )
    input_: capo_imagebuilder.types.get_image_pipeline_request.GetImagePipelineRequest = {
        "image_pipeline_arn": image_pipeline_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output