Skip to content

batch_update_rule

batch_update_rule(
    service_identifier: ServiceIdentifier,
    listener_identifier: ListenerIdentifier,
    rules: RuleUpdateList,
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
) -> BatchUpdateRuleResponse

Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority.

Required permissions: vpc-lattice:UpdateRule

For more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.

Parameters:

Raises:

Source code in docs_src/capo_vpc_lattice/_services/vpc_lattice.py
def batch_update_rule(
    self,
    service_identifier: "capo_vpc_lattice.types.service_identifier.ServiceIdentifier",
    listener_identifier: "capo_vpc_lattice.types.listener_identifier.ListenerIdentifier",
    rules: "capo_vpc_lattice.types.rule_update_list.RuleUpdateList",
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
) -> "capo_vpc_lattice.types.batch_update_rule_response.BatchUpdateRuleResponse":
    """<p>Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority.</p> <p> <b>Required permissions:</b> <code>vpc-lattice:UpdateRule</code> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc-lattice/latest/ug/security_iam_service-with-iam.html">How Amazon VPC Lattice works with IAM</a> in the <i>Amazon VPC Lattice User Guide</i>.</p>

    Args:
        service_identifier: <p>The ID or ARN of the service.</p>
        listener_identifier: <p>The ID or ARN of the listener.</p>
        rules: <p>The rules for the specified listener.</p>

    Raises:
        capo_vpc_lattice.errors.access_denied_exception.AccessDeniedException: <p>The user does not have sufficient access to perform this action.</p>
        capo_vpc_lattice.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.</p>
        capo_vpc_lattice.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing the request.</p>
        capo_vpc_lattice.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</p>
        capo_vpc_lattice.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_vpc_lattice.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_vpc_lattice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_vpc_lattice.types.batch_update_rule_request.BatchUpdateRuleRequest]",
    ) -> OperationResponse[
        "capo_vpc_lattice.types.batch_update_rule_response.BatchUpdateRuleResponse"
    ]:
        import capo_vpc_lattice._operations.mercury_control_plane.batch_update_rule

        output, http_response = (
            capo_vpc_lattice._operations.mercury_control_plane.batch_update_rule.batch_update_rule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchUpdateRule")
    )
    input_: capo_vpc_lattice.types.batch_update_rule_request.BatchUpdateRuleRequest = {
        "service_identifier": service_identifier,
        "listener_identifier": listener_identifier,
        "rules": rules,
    }

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