Skip to content

set_receipt_rule_position

set_receipt_rule_position(
    rule_set_name: ReceiptRuleSetName,
    rule_name: ReceiptRuleName,
    *,
    config_overrides: Optional[SESClientConfig] = None,
    after: Optional[ReceiptRuleName] = None,
) -> SetReceiptRulePositionResponse

Sets the position of the specified receipt rule in the receipt rule set.

For information about managing 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 contains the receipt rule to reposition.

  • rule_name (ReceiptRuleName) –

    The name of the receipt rule to reposition.

  • after (Optional[ReceiptRuleName], default: None ) –

    The name of the receipt rule after which to place the specified receipt rule.

Raises:

Examples:

SetReceiptRulePosition The following example sets the position of a receipt rule in a receipt rule set:

>>> client.set_receipt_rule_position(rule_set_name='MyRuleSet', rule_name='RuleToReposition', after='PutRuleAfterThisRule')
Source code in docs_src/capo_ses/_services/ses.py
def set_receipt_rule_position(
    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,
    after: Optional["capo_ses.types.receipt_rule_name.ReceiptRuleName"] = None,
) -> "capo_ses.types.set_receipt_rule_position_response.SetReceiptRulePositionResponse":
    """<p>Sets the position of the specified receipt rule in the receipt rule set.</p> <p>For information about managing 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 contains the receipt rule to reposition.</p>
        rule_name: <p>The name of the receipt rule to reposition.</p>
        after: <p>The name of the receipt rule after which to place the specified 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:
        SetReceiptRulePosition
        The following example sets the position of a receipt rule in a receipt rule set:

        >>> client.set_receipt_rule_position(rule_set_name='MyRuleSet', rule_name='RuleToReposition', after='PutRuleAfterThisRule')
    """

    def _handler(
        req: "OperationRequest[capo_ses.types.set_receipt_rule_position_request.SetReceiptRulePositionRequest]",
    ) -> OperationResponse[
        "capo_ses.types.set_receipt_rule_position_response.SetReceiptRulePositionResponse"
    ]:
        import capo_ses._operations.simple_email_service.set_receipt_rule_position

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SetReceiptRulePosition")
    )
    input_: capo_ses.types.set_receipt_rule_position_request.SetReceiptRulePositionRequest = {
        "rule_set_name": rule_set_name,
        "rule_name": rule_name,
    }
    if after is not None:
        input_["after"] = after

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