Skip to content

get_rule_set async

get_rule_set(
    rule_set_id: RuleSetId,
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
) -> GetRuleSetResponse

Fetch attributes of a rule set.

Parameters:

  • rule_set_id (RuleSetId) –

    The identifier of an existing rule set to be retrieved.

Raises:

Source code in docs_src/capo_mailmanager/_services/async_mail_manager.py
async def get_rule_set(
    self,
    rule_set_id: "capo_mailmanager.types.rule_set_id.RuleSetId",
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
) -> "capo_mailmanager.types.get_rule_set_response.GetRuleSetResponse":
    """<p>Fetch attributes of a rule set.</p>

    Args:
        rule_set_id: <p>The identifier of an existing rule set to be retrieved.</p>

    Raises:
        capo_mailmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when a requested resource is not found.</p>
        capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mailmanager.types.get_rule_set_request.GetRuleSetRequest]",
    ) -> AsyncOperationResponse[
        "capo_mailmanager.types.get_rule_set_response.GetRuleSetResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.get_rule_set

        (
            output,
            http_response,
        ) = await capo_mailmanager._operations.mail_manager_svc.get_rule_set.async_get_rule_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_mailmanager.types.get_rule_set_response.GetRuleSetResponse",
    ) -> dict[str, Any]:
        import capo_mailmanager.types.get_rule_set_response

        return capo_mailmanager.types.get_rule_set_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetRuleSet", redact_output=_redact_output),
    )
    input_: capo_mailmanager.types.get_rule_set_request.GetRuleSetRequest = {
        "rule_set_id": rule_set_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output