list_lifecycle_policies ¶

list_lifecycle_policies(
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[RestrictedInteger] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListLifecyclePoliciesResponse

Retrieves a list of lifecycle policies in your Amazon Web Services account.

Parameters:

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

Use the following filters to streamline results: name, resourceType, and status. Filter names are matched exactly as shown.
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 enabled lifecycle policies The following example lists the lifecycle policies in your account that have ENABLED status.

>>> client.list_lifecycle_policies(filters=[{'name': 'status', 'values': ['ENABLED']}])

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

def list_lifecycle_policies(
    self,
    *,
    config_overrides: Optional[imagebuilderClientConfig] = 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_lifecycle_policies_response.ListLifecyclePoliciesResponse":
    """<p>Retrieves a list of lifecycle policies in your Amazon Web Services account.</p>

    Args:
        filters: <p>Use the following filters to streamline results: <code>name</code>, <code>resourceType</code>, and <code>status</code>. Filter names are matched exactly as shown.</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 enabled lifecycle policies
        The following example lists the lifecycle policies in your account that have ENABLED status.

        >>> client.list_lifecycle_policies(filters=[{'name': 'status', 'values': ['ENABLED']}])
    """

    def _handler(
        req: "OperationRequest[capo_imagebuilder.types.list_lifecycle_policies_request.ListLifecyclePoliciesRequest]",
    ) -> OperationResponse[
        "capo_imagebuilder.types.list_lifecycle_policies_response.ListLifecyclePoliciesResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.list_lifecycle_policies

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLifecyclePolicies")
    )
    input_: capo_imagebuilder.types.list_lifecycle_policies_request.ListLifecyclePoliciesRequest = {}
    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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output