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

DescribeGatewayRoute

Describes an existing gateway route.

Request Syntax


GET /v20190125/meshes/meshName/virtualGateway/virtualGatewayName/gatewayRoutes/gatewayRouteName?meshOwner=meshOwner HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

gatewayRouteName

The name of the gateway route to describe.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

meshName

The name of the service mesh that the gateway route resides in.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

meshOwner

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

Length Constraints: Fixed length of 12.

virtualGatewayName

The name of the virtual gateway that the gateway route is associated with.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "gatewayRouteName": "string",
   "meshName": "string",
   "metadata": { 
      "arn": "string",
      "createdAt": number,
      "lastUpdatedAt": number,
      "meshOwner": "string",
      "resourceOwner": "string",
      "uid": "string",
      "version": number
   },
   "spec": { 
      "grpcRoute": { 
         "action": { 
            "rewrite": { 
               "hostname": { 
                  "defaultTargetHostname": "string"
               }
            },
            "target": { 
               "port": number,
               "virtualService": { 
                  "virtualServiceName": "string"
               }
            }
         },
         "match": { 
            "hostname": { 
               "exact": "string",
               "suffix": "string"
            },
            "metadata": [ 
               { 
                  "invert": boolean,
                  "match": { ... },
                  "name": "string"
               }
            ],
            "port": number,
            "serviceName": "string"
         }
      },
      "http2Route": { 
         "action": { 
            "rewrite": { 
               "hostname": { 
                  "defaultTargetHostname": "string"
               },
               "path": { 
                  "exact": "string"
               },
               "prefix": { 
                  "defaultPrefix": "string",
                  "value": "string"
               }
            },
            "target": { 
               "port": number,
               "virtualService": { 
                  "virtualServiceName": "string"
               }
            }
         },
         "match": { 
            "headers": [ 
               { 
                  "invert": boolean,
                  "match": { ... },
                  "name": "string"
               }
            ],
            "hostname": { 
               "exact": "string",
               "suffix": "string"
            },
            "method": "string",
            "path": { 
               "exact": "string",
               "regex": "string"
            },
            "port": number,
            "prefix": "string",
            "queryParameters": [ 
               { 
                  "match": { 
                     "exact": "string"
                  },
                  "name": "string"
               }
            ]
         }
      },
      "httpRoute": { 
         "action": { 
            "rewrite": { 
               "hostname": { 
                  "defaultTargetHostname": "string"
               },
               "path": { 
                  "exact": "string"
               },
               "prefix": { 
                  "defaultPrefix": "string",
                  "value": "string"
               }
            },
            "target": { 
               "port": number,
               "virtualService": { 
                  "virtualServiceName": "string"
               }
            }
         },
         "match": { 
            "headers": [ 
               { 
                  "invert": boolean,
                  "match": { ... },
                  "name": "string"
               }
            ],
            "hostname": { 
               "exact": "string",
               "suffix": "string"
            },
            "method": "string",
            "path": { 
               "exact": "string",
               "regex": "string"
            },
            "port": number,
            "prefix": "string",
            "queryParameters": [ 
               { 
                  "match": { 
                     "exact": "string"
                  },
                  "name": "string"
               }
            ]
         }
      },
      "priority": number
   },
   "status": { 
      "status": "string"
   },
   "virtualGatewayName": "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.

gatewayRouteName

The name of the gateway route.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

meshName

The name of the service mesh that the resource resides in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

metadata

An object that represents metadata for a resource.

Type: ResourceMetadata object

spec

The specifications of the gateway route.

Type: GatewayRouteSpec object

status

The status of the gateway route.

Type: GatewayRouteStatus object

virtualGatewayName

The virtual gateway that the gateway route is associated with.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Errors

BadRequestException

The request syntax was malformed. Check your request syntax and try again.

HTTP Status Code: 400

ForbiddenException

You don't have permissions to perform this action.

HTTP Status Code: 403

InternalServerErrorException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

NotFoundException

The specified resource doesn't exist. Check your request syntax and try again.

HTTP Status Code: 404

ServiceUnavailableException

The request has failed due to a temporary failure of the service.

HTTP Status Code: 503

TooManyRequestsException

The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.

HTTP Status Code: 429

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

The following example describes a gateway route named myGatewayRoute that is associated with a virtual gateway named myVirtualGateway in the apps service mesh.

Sample Request


GET /v20190125/meshes/apps/virtualGateway/myVirtualGateway/gatewayRoutes/myGatewayRoute HTTP/1.1
Host: appmesh.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34
X-Amz-Date: 20200608T194902Z
Authorization: AUTHPARAMS

Sample Response


HTTP/1.1 200 OK
x-amzn-requestid: 6d60d9e4-294d-40ca-a829-37f9ebc058e8
content-type: application/json
content-length: 617
date: Mon, 08 Jun 2020 20:26:03 GMT
x-envoy-upstream-service-time: 31
server: envoy
Connection: keep-alive

{
	"gatewayRouteName": "myGatewayRoute",
	"meshName": "myApps",
	"metadata": {
		"arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualGateway/myVirtualGateway/gatewayRoute/myGatewayRoute",
		"createdAt": 1.591645848403E9,
		"lastUpdatedAt": 1.591645848403E9,
		"meshOwner": "123456789012",
		"resourceOwner": "123456789012",
		"uid": "ff111ff2-33ff-4ff4-ffff-111f111f111f",
		"version": 1
	},
	"spec": {
		"grpcRoute": null,
		"http2Route": {
			"action": {
				"target": {
					"virtualService": {
						"virtualServiceName": "myservicea.svc.cluster.local"
					}
				}
			},
			"match": {
				"prefix": "/"
			}
		},
		"httpRoute": null
	},
	"status": {
		"status": "ACTIVE"
	},
	"virtualGatewayName": "myVirtualGateway"
}