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

ListResolverEndpointIpAddresses

Gets the IP addresses for a specified Resolver endpoint.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "ResolverEndpointId": "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.

MaxResults

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

Type: Integer

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

Required: No

NextToken

For the first ListResolverEndpointIpAddresses request, omit this value.

If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

Type: String

Required: No

ResolverEndpointId

The ID of the Resolver endpoint that you want to get IP addresses for.

Type: String

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

Required: Yes

Response Syntax


{
   "IpAddresses": [ 
      { 
         "CreationTime": "string",
         "Ip": "string",
         "IpId": "string",
         "Ipv6": "string",
         "ModificationTime": "string",
         "Status": "string",
         "StatusMessage": "string",
         "SubnetId": "string"
      }
   ],
   "MaxResults": number,
   "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.

IpAddresses

Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).

Type: Array of IpAddressResponse objects

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 the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

Type: String

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

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 400

ThrottlingException

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

HTTP Status Code: 400

Examples

ListResolverEndpointIpAddresses Example

This example illustrates one usage of ListResolverEndpointIpAddresses.

Sample Request


POST / HTTP/1.1
Host: route53resolver.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 52
X-Amz-Target: Route53Resolver.ListResolverEndpointIpAddresses
X-Amz-Date: 20181101T193143Z
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]

{
    "ResolverEndpointId": "rslvr-in-60b9fd8fdbexample"
}

Sample Response


HTTP/1.1 200 OK
Date: Thu, 01 Nov 2018 19:31:43 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 780
x-amzn-RequestId: df6722d0-49a0-4300-a491-fe290example
Connection: keep-alive

{
    "IpAddresses": [
        {
            "CreationTime": "2018-11-01T18:44:50.375Z",
            "Ip": "192.0.2.42",
            "IpId": "rni-42ed238be6example",
            "ModificationTime": "2018-11-01T18:45:10.956Z",
            "Status": "ATTACHED",
            "StatusMessage": "This IP address is operational.",
            "SubnetId": "subnet-02f91e0e98example"
        },
        {
            "CreationTime": "2018-11-01T18:44:50.379Z",
            "Ip": "192.0.2.18",
            "IpId": "rni-2cf1fc97bfexample",
            "ModificationTime": "2018-11-01T18:45:10.724Z",
            "Status": "ATTACHED",
            "StatusMessage": "This IP address is operational.",
            "SubnetId": "subnet-02f91e0e98example"
        },
        {
            "CreationTime": "2018-11-01T18:52:22.471Z",
            "Ip": "192.0.2.40",
            "IpId": "rni-e6b5f1b6e6example",
            "ModificationTime": "2018-11-01T18:52:45.886Z",
            "Status": "ATTACHED",
            "StatusMessage": "This IP address is operational.",
            "SubnetId": "subnet-02f91e0e98example"
        }
    ],
    "MaxResults": 10
}