describe_receipt_rule_set `async` ¶

describe_receipt_rule_set(
    rule_set_name: ReceiptRuleSetName,
    *,
    config_overrides: Optional[AsyncSESClientConfig] = None,
) -> DescribeReceiptRuleSetResponse

Returns the details of the specified receipt rule set.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Parameters:

rule_set_name (ReceiptRuleSetName) –

The name of the receipt rule set to describe.

Raises:

RuleSetDoesNotExistException –

Indicates that the provided receipt rule set does not exist.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

DescribeReceiptRuleSet The following example returns the metadata and receipt rules of a receipt rule set:

>>> await client.describe_receipt_rule_set(rule_set_name='MyRuleSet')

Source code in docs_src/capo_ses/_services/async_ses.py

async def describe_receipt_rule_set(
    self,
    rule_set_name: "capo_ses.types.receipt_rule_set_name.ReceiptRuleSetName",
    *,
    config_overrides: Optional[AsyncSESClientConfig] = None,
) -> "capo_ses.types.describe_receipt_rule_set_response.DescribeReceiptRuleSetResponse":
    """<p>Returns the details of the specified receipt rule set.</p> <p>For information about managing receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>

    Args:
        rule_set_name: <p>The name of the receipt rule set to describe.</p>

    Raises:
        capo_ses.errors.rule_set_does_not_exist_exception.RuleSetDoesNotExistException: <p>Indicates that the provided receipt rule set does not exist.</p>
        capo_ses.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        DescribeReceiptRuleSet
        The following example returns the metadata and receipt rules of a receipt rule set:

        >>> await client.describe_receipt_rule_set(rule_set_name='MyRuleSet')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ses.types.describe_receipt_rule_set_request.DescribeReceiptRuleSetRequest]",
    ) -> AsyncOperationResponse[
        "capo_ses.types.describe_receipt_rule_set_response.DescribeReceiptRuleSetResponse"
    ]:
        import capo_ses._operations.simple_email_service.describe_receipt_rule_set

        (
            output,
            http_response,
        ) = await capo_ses._operations.simple_email_service.describe_receipt_rule_set.async_describe_receipt_rule_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReceiptRuleSet")
    )
    input_: capo_ses.types.describe_receipt_rule_set_request.DescribeReceiptRuleSetRequest = {
        "rule_set_name": rule_set_name
    }

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

describe_receipt_rule_set async ¶

describe_receipt_rule_set `async` ¶