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

UpdateListener

Updates the specified listener for the specified service.

Request Syntax


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

{
   "defaultAction": { ... }
}

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.

defaultAction

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.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "defaultAction": { ... },
   "id": "string",
   "name": "string",
   "port": number,
   "protocol": "string",
   "serviceArn": "string",
   "serviceId": "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.

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}$

defaultAction

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.

id

The ID of the listener.

Type: String

Length Constraints: Fixed length of 26.

Pattern: ^listener-[0-9a-z]{17}$

name

The name of the listener.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

port

The listener port.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

protocol

The protocol of the listener.

Type: String

Valid Values: HTTP | HTTPS

serviceArn

The Amazon Resource Name (ARN) of the service.

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}$

serviceId

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$

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