OpenSearchService / Client / describe_vpc_endpoints

describe_vpc_endpoints#

OpenSearchService.Client.describe_vpc_endpoints(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_vpc_endpoints(
    VpcEndpointIds=[
        'string',
    ]
)
Parameters:

VpcEndpointIds (list) –

[REQUIRED]

The unique identifiers of the endpoints to get information about.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'VpcEndpoints': [
        {
            'VpcEndpointId': 'string',
            'VpcEndpointOwner': 'string',
            'DomainArn': 'string',
            'VpcOptions': {
                'VPCId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'AvailabilityZones': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
            'Endpoint': 'string'
        },
    ],
    'VpcEndpointErrors': [
        {
            'VpcEndpointId': 'string',
            'ErrorCode': 'ENDPOINT_NOT_FOUND'|'SERVER_ERROR',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • VpcEndpoints (list) –

      Information about each requested VPC endpoint.

      • (dict) –

        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 (dict) –

          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.

            • (string) –

          • AvailabilityZones (list) –

            The list of Availability Zones associated with the VPC subnets.

            • (string) –

          • SecurityGroupIds (list) –

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

            • (string) –

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

      • (dict) –

        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.

Exceptions