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

ListResolverEndpoints

Lists all the Resolver endpoints that were created using the current AWS account.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "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.

Filters

An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.

Note

If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

Type: Array of Filter objects

Required: No

MaxResults

The maximum number of Resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver returns up to 100 Resolver endpoints.

Type: Integer

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

Required: No

NextToken

For the first ListResolverEndpoints request, omit this value.

If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.

Type: String

Required: No

Response Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "ResolverEndpoints": [ 
      { 
         "Arn": "string",
         "CreationTime": "string",
         "CreatorRequestId": "string",
         "Direction": "string",
         "HostVPCId": "string",
         "Id": "string",
         "IpAddressCount": number,
         "ModificationTime": "string",
         "Name": "string",
         "OutpostArn": "string",
         "PreferredInstanceType": "string",
         "Protocols": [ "string" ],
         "ResolverEndpointType": "string",
         "SecurityGroupIds": [ "string" ],
         "Status": "string",
         "StatusMessage": "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.

MaxResults

The value that you specified for MaxResults in the request.

Type: Integer

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

NextToken

If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

Type: String

ResolverEndpoints

The Resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.

Type: Array of ResolverEndpoint objects

Errors

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

InternalServiceErrorException

We encountered an unknown error. Try again in a few minutes.

HTTP Status Code: 400

InvalidNextTokenException

The value that you specified for NextToken in a List request isn't valid.

HTTP Status Code: 400

InvalidParameterException

One or more parameters in this request are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is invalid.

HTTP Status Code: 400

ThrottlingException

The request was throttled. Try again in a few minutes.

HTTP Status Code: 400

Examples

ListResolverEndpoints Example

This example illustrates one usage of ListResolverEndpoints.

Sample Request


POST / HTTP/1.1
Host: route53resolver.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: Route53Resolver.ListResolverEndpoints
X-Amz-Date: 20181101T191920Z
User-Agent: aws-cli/1.16.45 Python/2.7.10 Darwin/16.7.0 botocore/1.12.35
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 
               Credential=AKIAJJ2SONIPEXAMPLE/20181101/us-east-2/route53resolver/aws4_request, 
               SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
               Signature=[calculated-signature]

{}

Sample Response


HTTP/1.1 200 OK
Date: Thu, 01 Nov 2018 19:19:20 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 983
x-amzn-RequestId: 35a62daa-889c-47e4-994e-5a4dbd9818fb
Connection: keep-alive

{
    "MaxResults": 10,
    "ResolverEndpoints": [
        {
            "Arn": "arn:aws:route53resolver:us-east-2:123456789012:resolver-endpoint/rslvr-in-60b9fd8fdbexample",
            "CreationTime": "2018-11-01T18:44:50.372Z",
            "CreatorRequestId": "1234",
            "Direction": "INBOUND",
            "HostVPCId": "vpc-03cf94c75cexample",
            "Id": "rslvr-in-60b9fd8fdbexample",
            "IpAddressCount": 3,
            "ModificationTime": "2018-11-01T18:44:50.372Z",
            "Name": "MyInbound",
            "SecurityGroupIds": [
                "sg-020a3554aexample"
            ],
            "Status": "OPERATIONAL",
            "StatusMessage": "This Resolver Endpoint is operational."
        },
        {
            "Arn": "arn:aws:route53resolver:us-east-2:123456789012:resolver-endpoint/rslvr-out-fdc049932d9645ffa",
            "CreationTime": "2018-11-01T19:13:44.830Z",
            "CreatorRequestId": "5678",
            "Direction": "OUTBOUND",
            "HostVPCId": "vpc-0dd415a0edexample",
            "Id": "rslvr-out-fdc049932dexample",
            "IpAddressCount": 2,
            "ModificationTime": "2018-11-01T19:13:44.830Z",
            "Name": "MyOutbound",
            "SecurityGroupIds": [
                "sg-071b99f42example"
            ],
            "Status": "OPERATIONAL",
            "StatusMessage": "This Resolver Endpoint is operational."
        }
    ]
}