Skip to content

describe_receipt_rule 

describe_receipt_rule(
    rule_set_name: ReceiptRuleSetName,
    rule_name: ReceiptRuleName,
    *,
    config_overrides: Optional[SESClientConfig] = None,
) -> DescribeReceiptRuleResponse

Returns the details of the specified receipt rule.

For information about setting up receipt rules, 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 that the receipt rule belongs to.

  • rule_name (ReceiptRuleName) –

    The name of the receipt rule.

Raises:

Examples:

DescribeReceiptRule The following example returns the details of a receipt rule:

>>> client.describe_receipt_rule(rule_set_name='MyRuleSet', rule_name='MyRule')
Source code in docs_src/capo_ses/_services/ses.py 
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
def describe_receipt_rule(
    self,
    rule_set_name: "capo_ses.types.receipt_rule_set_name.ReceiptRuleSetName",
    rule_name: "capo_ses.types.receipt_rule_name.ReceiptRuleName",
    *,
    config_overrides: Optional[SESClientConfig] = None,
) -> "capo_ses.types.describe_receipt_rule_response.DescribeReceiptRuleResponse":
    """<p>Returns the details of the specified receipt rule.</p> <p>For information about setting up receipt rules, 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 that the receipt rule belongs to.</p>
        rule_name: <p>The name of the receipt rule.</p>

    Raises:
        capo_ses.errors.rule_does_not_exist_exception.RuleDoesNotExistException: <p>Indicates that the provided receipt rule does not exist.</p>
        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:
        DescribeReceiptRule
        The following example returns the details of a receipt rule:

        >>> client.describe_receipt_rule(rule_set_name='MyRuleSet', rule_name='MyRule')
    """

    def _handler(
        req: "OperationRequest[capo_ses.types.describe_receipt_rule_request.DescribeReceiptRuleRequest]",
    ) -> OperationResponse[
        "capo_ses.types.describe_receipt_rule_response.DescribeReceiptRuleResponse"
    ]:
        import capo_ses._operations.simple_email_service.describe_receipt_rule

        output, http_response = (
            capo_ses._operations.simple_email_service.describe_receipt_rule.describe_receipt_rule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReceiptRule")
    )
    input_: capo_ses.types.describe_receipt_rule_request.DescribeReceiptRuleRequest = {
        "rule_set_name": rule_set_name,
        "rule_name": rule_name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output