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 . opensearch ]



Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

See also: AWS API Documentation


--vpc-endpoint-ids <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--endpoint-url <value>]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]


--vpc-endpoint-ids (list)

The unique identifiers of the endpoints to get information about.



"string" "string" ...

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.


VpcEndpoints -> (list)

Information about each requested VPC endpoint.


The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

VpcEndpointId -> (string)

The unique identifier of the endpoint.

VpcEndpointOwner -> (string)

The creator of the endpoint.

DomainArn -> (string)

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

VpcOptions -> (structure)

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

VPCId -> (string)

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

SubnetIds -> (list)

A list of subnet IDs associated with the VPC endpoints for the domain.


AvailabilityZones -> (list)

The list of Availability Zones associated with the VPC subnets.


SecurityGroupIds -> (list)

The list of security group IDs associated with the VPC endpoints for the domain.


Status -> (string)

The current status of the endpoint.

Endpoint -> (string)

The connection endpoint ID for connecting to the domain.

VpcEndpointErrors -> (list)

Any errors associated with the request.


Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

VpcEndpointId -> (string)

The unique identifier of the endpoint.

ErrorCode -> (string)

The code associated with the error.

ErrorMessage -> (string)

A message describing the error.