Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . route53resolver ]

get-resolver-endpoint

Description

Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-resolver-endpoint
--resolver-endpoint-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--resolver-endpoint-id (string)

The ID of the resolver endpoint that you want to get information about.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To get information about a Resolver endpoint

The following get-resolver-endpoint example displays details for the outbound specified endpoint. You can use get-resolver-endpoint for both inbound and outbound endpoints by specifying the applicable endpoint ID.

aws route53resolver get-resolver-endpoint \
    --resolver-endpoint-id rslvr-out-d5e5920e37example

Output:

{
    "ResolverEndpoint": {
        "Id": "rslvr-out-d5e5920e37example",
        "CreatorRequestId": "2020-01-01-18:47",
        "Arn": "arn:aws:route53resolver:us-west-2:111122223333:resolver-endpoint/rslvr-out-d5e5920e37example",
        "Name": "my-outbound-endpoint",
        "SecurityGroupIds": [
            "sg-05cd7b25d6example"
        ],
        "Direction": "OUTBOUND",
        "IpAddressCount": 2,
        "HostVPCId": "vpc-304bexam",
        "Status": "OPERATIONAL",
        "StatusMessage": "This Resolver Endpoint is operational.",
        "CreationTime": "2020-01-01T23:50:50.979Z",
        "ModificationTime": "2020-01-02T23:50:50.979Z"
    }
}

For more information, see Values That You Specify When You Create or Edit Inbound Endpoints in the Amazon Route 53 Developer Guide.

Output

ResolverEndpoint -> (structure)

Information about the resolver endpoint that you specified in a GetResolverEndpoint request.

Id -> (string)

The ID of the resolver endpoint.

CreatorRequestId -> (string)

A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

Arn -> (string)

The ARN (Amazon Resource Name) for the resolver endpoint.

Name -> (string)

The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

SecurityGroupIds -> (list)

The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

(string)

Direction -> (string)

Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

  • INBOUND : allows DNS queries to your VPC from your network or another VPC
  • OUTBOUND : allows DNS queries from your VPC to your network or another VPC

IpAddressCount -> (integer)

The number of IP addresses that the resolver endpoint can use for DNS queries.

HostVPCId -> (string)

The ID of the VPC that you want to create the resolver endpoint in.

Status -> (string)

A code that specifies the current status of the resolver endpoint.

StatusMessage -> (string)

A detailed description of the status of the resolver endpoint.

CreationTime -> (string)

The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

ModificationTime -> (string)

The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).