Skip to content

list_component_build_versions

list_component_build_versions(
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
    component_version_arn: Optional[ComponentVersionArn] = None,
    max_results: Optional[RestrictedInteger] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListComponentBuildVersionsResponse

Returns a list of component build versions for the specified component version ARN. You can only list build versions for components that your account owns. Deprecated build versions aren't included in the results.

Parameters:

  • component_version_arn (Optional[ComponentVersionArn], default: None ) –

    The component version ARN whose build versions you want to list. The ARN must specify an exact version, without a build number suffix. If you don't specify an ARN, Image Builder returns build versions for the components that your account owns.

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

  • 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 build versions of a component The following example lists the build versions that exist for version 1.0.0 of the specified component. The list returns the most recent build version first.

>>> client.list_component_build_versions(component_version_arn='arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0')
Source code in docs_src/capo_imagebuilder/_services/imagebuilder.py
def list_component_build_versions(
    self,
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
    component_version_arn: Optional[
        "capo_imagebuilder.types.component_version_arn.ComponentVersionArn"
    ] = 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_component_build_versions_response.ListComponentBuildVersionsResponse":
    """<p>Returns a list of component build versions for the specified component version ARN. You can only list build versions for components that your account owns. Deprecated build versions aren't included in the results.</p>

    Args:
        component_version_arn: <p>The component version ARN whose build versions you want to list. The ARN must specify an exact version, without a build number suffix. If you don't specify an ARN, Image Builder returns build versions for the components that your account owns.</p>
        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.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 build versions of a component
        The following example lists the build versions that exist for version 1.0.0 of the specified component. The list returns the most recent build version first.

        >>> client.list_component_build_versions(component_version_arn='arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0')
    """

    def _handler(
        req: "OperationRequest[capo_imagebuilder.types.list_component_build_versions_request.ListComponentBuildVersionsRequest]",
    ) -> OperationResponse[
        "capo_imagebuilder.types.list_component_build_versions_response.ListComponentBuildVersionsResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.list_component_build_versions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListComponentBuildVersions")
    )
    input_: capo_imagebuilder.types.list_component_build_versions_request.ListComponentBuildVersionsRequest = {}
    if component_version_arn is not None:
        input_["component_version_arn"] = component_version_arn
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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