UpdateRule
Updates a rule for the listener. You can't modify a default listener rule. To modify a
default listener rule, use UpdateListener.
Request Syntax
PATCH /services/serviceIdentifier/listeners/listenerIdentifier/rules/ruleIdentifier HTTP/1.1
Content-type: application/json
{
"action": { ... },
"match": { ... },
"priority": number
}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
- ruleIdentifier
-
The ID or Amazon Resource Name (ARN) of the rule.
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^((rule-[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}/rule/rule-[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.
- action
-
Information about the action for the specified listener rule.
Type: RuleAction object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- match
-
The rule match.
Type: RuleMatch object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- priority
-
The rule priority. A listener can't have multiple rules with the same priority.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"action": { ... },
"arn": "string",
"id": "string",
"isDefault": boolean,
"match": { ... },
"name": "string",
"priority": number
}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.
- action
-
Information about the action for the specified listener rule.
Type: RuleAction object
Note: This object is a Union. Only one member of this object can be specified or returned.
- arn
-
The Amazon Resource Name (ARN) of the listener.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-[0-9a-z]{17}$ - id
-
The ID of the listener.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 22.
Pattern:
^rule-[0-9a-z]{17}$ - isDefault
-
Indicates whether this is the default rule.
Type: Boolean
- match
-
The rule match.
Type: RuleMatch object
Note: This object is a Union. Only one member of this object can be specified or returned.
- name
-
The name of the listener.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ - priority
-
The rule priority.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
