Skip to content

list_services async

list_services(
    *,
    config_overrides: Optional[Asyncresiliencehubv2ClientConfig] = None,
    system_arn: Optional[Arn] = None,
    user_journey_id: Optional[UserJourneyId] = None,
    ou_id: Optional[OuId] = None,
    account_id: Optional[AccountId] = None,
    assessment_status: Optional[AssessmentStatus] = None,
    policy_arn: Optional[Arn] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListServicesResponse

Lists services.

Parameters:

  • user_journey_id (Optional[UserJourneyId], default: None ) –

    Filter services by user journey identifier.

  • ou_id (Optional[OuId], default: None ) –

    Filter services by organizational unit (OU) identifier.

  • account_id (Optional[AccountId], default: None ) –

    Filter services by AWS account ID.

  • assessment_status (Optional[AssessmentStatus], default: None ) –

    Filter services by assessment status.

Raises:

Source code in docs_src/capo_resiliencehubv2/_services/async_resiliencehubv2.py
async def list_services(
    self,
    *,
    config_overrides: Optional[Asyncresiliencehubv2ClientConfig] = None,
    system_arn: Optional["capo_resiliencehubv2.types.arn.Arn"] = None,
    user_journey_id: Optional[
        "capo_resiliencehubv2.types.user_journey_id.UserJourneyId"
    ] = None,
    ou_id: Optional["capo_resiliencehubv2.types.ou_id.OuId"] = None,
    account_id: Optional["capo_resiliencehubv2.types.account_id.AccountId"] = None,
    assessment_status: Optional[
        "capo_resiliencehubv2.types.assessment_status.AssessmentStatus"
    ] = None,
    policy_arn: Optional["capo_resiliencehubv2.types.arn.Arn"] = 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_services_response.ListServicesResponse":
    """<p>Lists services.</p>

    Args:
        user_journey_id: <p>Filter services by user journey identifier.</p>
        ou_id: <p>Filter services by organizational unit (OU) identifier.</p>
        account_id: <p>Filter services by AWS account ID.</p>
        assessment_status: <p>Filter services by assessment status.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_resiliencehubv2.types.list_services_request.ListServicesRequest]",
    ) -> AsyncOperationResponse[
        "capo_resiliencehubv2.types.list_services_response.ListServicesResponse"
    ]:
        import capo_resiliencehubv2._operations.ngrh_service_core.list_services

        (
            output,
            http_response,
        ) = await capo_resiliencehubv2._operations.ngrh_service_core.list_services.async_list_services(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListServices")
    )
    input_: capo_resiliencehubv2.types.list_services_request.ListServicesRequest = {}
    if system_arn is not None:
        input_["system_arn"] = system_arn
    if user_journey_id is not None:
        input_["user_journey_id"] = user_journey_id
    if ou_id is not None:
        input_["ou_id"] = ou_id
    if account_id is not None:
        input_["account_id"] = account_id
    if assessment_status is not None:
        input_["assessment_status"] = assessment_status
    if policy_arn is not None:
        input_["policy_arn"] = policy_arn
    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