Skip to content

list_image_pipeline_images async

list_image_pipeline_images(
    image_pipeline_arn: ImagePipelineArn,
    *,
    config_overrides: Optional[AsyncimagebuilderClientConfig] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[RestrictedInteger] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListImagePipelineImagesResponse

Returns a list of images created by the specified pipeline.

Parameters:

  • image_pipeline_arn (ImagePipelineArn) –

    The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.

  • filters (Optional[FilterList], default: None ) –

    Use the following filters to streamline results:

    • name

    • version

  • max_results (Optional[RestrictedInteger], default: None ) –

    The maximum number of items to return in a single request.

  • next_token (Optional[PaginationToken], default: None ) –

    A token to specify where to start paginating. Use the nextToken value from a previously truncated response.

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.

  • InvalidPaginationTokenException –

    You have provided an invalid pagination token in your request.

  • InvalidRequestException –

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

  • ResourceNotFoundException –

    At least one of the resources referenced by your request does not exist.

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

List the images that an image pipeline created The following example lists the images that the specified pipeline created, including a build that is still in progress.

>>> await client.list_image_pipeline_images(image_pipeline_arn='arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline')
Source code in docs_src/capo_imagebuilder/_services/async_imagebuilder.py
async def list_image_pipeline_images(
    self,
    image_pipeline_arn: "capo_imagebuilder.types.image_pipeline_arn.ImagePipelineArn",
    *,
    config_overrides: Optional[AsyncimagebuilderClientConfig] = None,
    filters: Optional["capo_imagebuilder.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_imagebuilder.types.restricted_integer.RestrictedInteger"
    ] = None,
    next_token: Optional[
        "capo_imagebuilder.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_imagebuilder.types.list_image_pipeline_images_response.ListImagePipelineImagesResponse":
    """<p>Returns a list of images created by the specified pipeline.</p>

    Args:
        image_pipeline_arn: <p>The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.</p>
        filters: <p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>name</code> </p> </li> <li> <p> <code>version</code> </p> </li> </ul>
        max_results: <p>The maximum number of items to return in a single request.</p>
        next_token: <p>A token to specify where to start paginating. Use the <code>nextToken</code> value from a previously truncated response.</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_pagination_token_exception.InvalidPaginationTokenException: <p>You have provided an invalid pagination token in your request.</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.resource_not_found_exception.ResourceNotFoundException: <p>At least one of the resources referenced by your request does not exist.</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:
        List the images that an image pipeline created
        The following example lists the images that the specified pipeline created, including a build that is still in progress.

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

    async def _handler(
        req: "AsyncOperationRequest[capo_imagebuilder.types.list_image_pipeline_images_request.ListImagePipelineImagesRequest]",
    ) -> AsyncOperationResponse[
        "capo_imagebuilder.types.list_image_pipeline_images_response.ListImagePipelineImagesResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.list_image_pipeline_images

        (
            output,
            http_response,
        ) = await capo_imagebuilder._operations.imagebuilder.list_image_pipeline_images.async_list_image_pipeline_images(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListImagePipelineImages")
    )
    input_: capo_imagebuilder.types.list_image_pipeline_images_request.ListImagePipelineImagesRequest = {
        "image_pipeline_arn": image_pipeline_arn
    }
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output