list_vpc_endpoints

OpenSearchServiceServerless.Client.list_vpc_endpoints(**kwargs)

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

See also: AWS API Documentation

Request Syntax

response = client.list_vpc_endpoints(
    maxResults=123,
    nextToken='string',
    vpcEndpointFilters={
        'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED'
    }
)

Parameters

• maxResults (integer) -- An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
• nextToken (string) -- If your initial ListVpcEndpoints operation returns a nextToken , you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.
• vpcEndpointFilters (dict) --

  Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING , DELETING , UPDATING , ACTIVE , and FAILED .

  • status (string) --

    The current status of the endpoint.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'vpcEndpointSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED'
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • vpcEndpointSummaries (list) --

    Details about each VPC endpoint, including the name and current status.

    • (dict) --

      The VPC endpoint object.

      • id (string) --

        The unique identifier of the endpoint.

      • name (string) --

        The name of the endpoint.

      • status (string) --

        The current status of the endpoint.

Exceptions

• OpenSearchServiceServerless.Client.exceptions.InternalServerException
• OpenSearchServiceServerless.Client.exceptions.ValidationException