Describe Vpc Endpoints

opensearchservice_describe_vpc_endpoints

R Documentation

Describes one or more Amazon OpenSearch Service-managed VPC endpoints

Description

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

Usage

opensearchservice_describe_vpc_endpoints(VpcEndpointIds)

Arguments

VpcEndpointIds

[required] The unique identifiers of the endpoints to get information about.

Value

A list with the following syntax:

list(
  VpcEndpoints = list(
    list(
      VpcEndpointId = "string",
      VpcEndpointOwner = "string",
      DomainArn = "string",
      VpcOptions = list(
        VPCId = "string",
        SubnetIds = list(
          "string"
        ),
        AvailabilityZones = list(
          "string"
        ),
        SecurityGroupIds = list(
          "string"
        )
      ),
      Status = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"UPDATING"|"UPDATE_FAILED"|"DELETING"|"DELETE_FAILED",
      Endpoint = "string"
    )
  ),
  VpcEndpointErrors = list(
    list(
      VpcEndpointId = "string",
      ErrorCode = "ENDPOINT_NOT_FOUND"|"SERVER_ERROR",
      ErrorMessage = "string"
    )
  )
)

Request syntax

svc$describe_vpc_endpoints(
  VpcEndpointIds = list(
    "string"
  )
)