Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListGatewayRoutes

Returns a list of gateway routes. A gateway route represents the association between a service and a gateway and the service-specific infrastructure the gateway manages for it. You can filter the results by gateway, cluster, service, container port name, and status. The results are paginated. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

Request Syntax


{
   "cluster": "string",
   "gateway": "string",
   "maxResults": number,
   "nextToken": "string",
   "service": "string",
   "serviceContainerPortName": "string",
   "status": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

cluster

The name or Amazon Resource Name (ARN) of a cluster to filter the results by.

Type: String

Required: No

gateway

The name or Amazon Resource Name (ARN) of a gateway to filter the results by.

Type: String

Required: No

maxResults

The maximum number of results that the operation returns in a single page. The default is 100.

Type: Integer

Required: No

nextToken

The nextToken value returned from a previous paginated request.

Type: String

Required: No

service

The name or Amazon Resource Name (ARN) of a service to filter the results by. Because services can span clusters, a service name isn't necessarily unique and can match multiple services.

Type: String

Required: No

serviceContainerPortName

The name of a task definition container port to filter the results by.

Type: String

Required: No

status

The gateway route status to filter the results by.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 7 items.

Required: No

Response Syntax


{
   "gatewayRoutes": [ 
      { 
         "clusterArn": "string",
         "gatewayArn": "string",
         "gatewayRouteArn": "string",
         "serviceArn": "string",
         "serviceContainerPortName": "string",
         "status": "string"
      }
   ],
   "nextToken": "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.

gatewayRoutes

The gateway routes that match the request.

Type: Array of GatewayRouteSummary objects

nextToken

The nextToken value to include in a future request to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Errors

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

AccessDeniedException

You don't have authorization to perform the requested action.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

ClientException

These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

GatewayNotFoundException

The specified gateway wasn't found. Check that the gateway name or ARN is correct and that the gateway exists in your account and Region.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

InvalidParameterException

The specified parameter isn't valid. Review the available parameters for the API request.

For more information about service event errors, see Amazon ECS service event messages.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

message: Message that describes the cause of the exception.

HTTP Status Code: 500

UnsupportedFeatureException

The specified task isn't supported in this Region.

message: Message that describes the cause of the exception.

HTTP Status Code: 400