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

GetRule

Retrieves information about listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Request Syntax


GET /services/serviceIdentifier/listeners/listenerIdentifier/rules/ruleIdentifier HTTP/1.1

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 listener 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 does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "action": { ... },
   "arn": "string",
   "createdAt": "string",
   "id": "string",
   "isDefault": boolean,
   "lastUpdatedAt": "string",
   "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

The action for the default 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}$

createdAt

The date and time that the listener rule was created, specified in ISO-8601 format.

Type: Timestamp

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

lastUpdatedAt

The date and time that the listener rule was last updated, specified in ISO-8601 format.

Type: Timestamp

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 priority level for the specified rule.

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

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