Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchUpdateRule

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.

Request Syntax


PATCH /services/serviceIdentifier/listeners/listenerIdentifier/rules HTTP/1.1
Content-type: application/json

{
   "rules": [ 
      { 
         "action": { ... },
         "match": { ... },
         "priority": number,
         "ruleIdentifier": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

listenerIdentifier

The ID or Amazon Resource Name (ARN) of the listener.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes

serviceIdentifier

The ID or Amazon Resource Name (ARN) of the service.

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body

The request accepts the following data in JSON format.

rules

The rules for the specified listener.

Type: Array of RuleUpdate objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "successful": [ 
      { 
         "action": { ... },
         "arn": "string",
         "id": "string",
         "isDefault": boolean,
         "match": { ... },
         "name": "string",
         "priority": number
      }
   ],
   "unsuccessful": [ 
      { 
         "failureCode": "string",
         "failureMessage": "string",
         "ruleIdentifier": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

successful

The rules that were successfully updated.

Type: Array of RuleUpdateSuccess objects

unsuccessful

The rules that the operation couldn't update.

Type: Array of RuleUpdateFailure objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400