list_rules async ¶

async def list_rules(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    publish_status: Optional[
        "capo_connect.types.rule_publish_status.RulePublishStatus"
    ] = None,
    event_source_name: Optional[
        "capo_connect.types.event_source_name.EventSourceName"
    ] = None,
    max_results: Optional["capo_connect.types.max_result200.MaxResult200"] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
) -> "capo_connect.types.list_rules_response.ListRulesResponse":
    """<p>List all rules for the specified Connect Customer instance.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        publish_status: <p>The publish status of the rule.</p>
        event_source_name: <p>The name of the event source.</p>
        max_results: <p>The maximum number of results to return per page.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.list_rules_request.ListRulesRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.list_rules_response.ListRulesResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_rules

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.list_rules.async_list_rules(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRules")
    )
    input_: capo_connect.types.list_rules_request.ListRulesRequest = {
        "instance_id": instance_id
    }
    if publish_status is not None:
        input_["publish_status"] = publish_status
    if event_source_name is not None:
        input_["event_source_name"] = event_source_name
    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