Skip to content

list_resources

list_resources(
    service_arn: Arn,
    *,
    config_overrides: Optional[resiliencehubv2ClientConfig] = None,
    service_function_id: Optional[EntityId] = None,
    aws_region: Optional[AwsRegion] = None,
    resource_types: Optional[ResourceTypeFilterList] = None,
    billable: Optional[bool] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListResourcesResponse

List resources.

Parameters:

  • service_function_id (Optional[EntityId], default: None ) –

    Filter resources by service function identifier.

  • aws_region (Optional[AwsRegion], default: None ) –

    Filter resources by AWS Region.

  • resource_types (Optional[ResourceTypeFilterList], default: None ) –

    The CloudFormation resource types to include in the response.

  • billable (Optional[bool], default: None ) –

    Specifies whether to filter non-billable resources. When true (the default), the operation returns only billable resources.

Raises:

Source code in docs_src/capo_resiliencehubv2/_services/resiliencehubv2.py
def list_resources(
    self,
    service_arn: "capo_resiliencehubv2.types.arn.Arn",
    *,
    config_overrides: Optional[resiliencehubv2ClientConfig] = None,
    service_function_id: Optional[
        "capo_resiliencehubv2.types.entity_id.EntityId"
    ] = None,
    aws_region: Optional["capo_resiliencehubv2.types.aws_region.AwsRegion"] = None,
    resource_types: Optional[
        "capo_resiliencehubv2.types.resource_type_filter_list.ResourceTypeFilterList"
    ] = None,
    billable: Optional[bool] = None,
    max_results: Optional[
        "capo_resiliencehubv2.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_resiliencehubv2.types.next_token.NextToken"] = None,
) -> "capo_resiliencehubv2.types.list_resources_response.ListResourcesResponse":
    """<p>List resources.</p>

    Args:
        service_function_id: <p>Filter resources by service function identifier.</p>
        aws_region: <p>Filter resources by AWS Region.</p>
        resource_types: <p>The CloudFormation resource types to include in the response.</p>
        billable: <p>Specifies whether to filter non-billable resources. When true (the default), the operation returns only billable resources.</p>

    Raises:
        capo_resiliencehubv2.errors.access_denied_exception.AccessDeniedException: <p>Access denied — caller lacks required permissions.</p>
        capo_resiliencehubv2.errors.internal_server_exception.InternalServerException: <p>Internal service error.</p>
        capo_resiliencehubv2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found.</p>
        capo_resiliencehubv2.errors.validation_exception.ValidationException: <p>Validation error — invalid input parameters.</p>
        capo_resiliencehubv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_resiliencehubv2.types.list_resources_request.ListResourcesRequest]",
    ) -> OperationResponse[
        "capo_resiliencehubv2.types.list_resources_response.ListResourcesResponse"
    ]:
        import capo_resiliencehubv2._operations.ngrh_service_core.list_resources

        output, http_response = (
            capo_resiliencehubv2._operations.ngrh_service_core.list_resources.list_resources(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListResources")
    )
    input_: capo_resiliencehubv2.types.list_resources_request.ListResourcesRequest = {
        "service_arn": service_arn
    }
    if service_function_id is not None:
        input_["service_function_id"] = service_function_id
    if aws_region is not None:
        input_["aws_region"] = aws_region
    if resource_types is not None:
        input_["resource_types"] = resource_types
    if billable is not None:
        input_["billable"] = billable
    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