Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeGatewayResources

Returns the infrastructure that a gateway has created and manages, so that you can follow the traffic path from top-level shared resources, such as load balancers, to the service-specific resources represented as gateway routes. Responses include only the Amazon Resource Names (ARNs) of gateway-managed infrastructure. For the current state of a resource, describe it with the corresponding Amazon service (Elastic Load Balancing, Amazon EC2, or Amazon Certificate Manager). The results are paginated.

Request Syntax


{
   "gateway": "string",
   "maxResults": number,
   "nextToken": "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.

gateway

The name or Amazon Resource Name (ARN) of the gateway.

Type: String

Required: Yes

maxResults

The maximum number of results that the operation returns in a single page. The maximum value is 20 and the default is 10.

Type: Integer

Required: No

nextToken

The nextToken value returned from a previous paginated request.

Type: String

Required: No

Response Syntax


{
   "gatewayResources": { 
      "gatewayArn": "string",
      "resources": { ... }
   },
   "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.

gatewayResources

The infrastructure resources that the gateway manages, grouped by gateway type.

Type: GatewayResources object

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