OpenSearchServiceServerless / Client / create_vpc_endpoint

create_vpc_endpoint#

OpenSearchServiceServerless.Client.create_vpc_endpoint(**kwargs)#

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

See also: AWS API Documentation

Request Syntax

response = client.create_vpc_endpoint(
    clientToken='string',
    name='string',
    securityGroupIds=[
        'string',
    ],
    subnetIds=[
        'string',
    ],
    vpcId='string'
)
Parameters:

  • clientToken (string) –

    Unique, case-sensitive identifier to ensure idempotency of the request.

    This field is autopopulated if not provided.

  • name (string) –

    [REQUIRED]

    The name of the interface endpoint.

  • securityGroupIds (list) –

    The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    • (string) –

  • subnetIds (list) –

    [REQUIRED]

    The ID of one or more subnets from which you’ll access OpenSearch Serverless.

    • (string) –

  • vpcId (string) –

    [REQUIRED]

    The ID of the VPC from which you’ll access OpenSearch Serverless.

Return type:

dict

Returns:

Response Syntax

{
    'createVpcEndpointDetail': {
        'id': 'string',
        'name': 'string',
        'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED'
    }
}

Response Structure

  • (dict) –

    • createVpcEndpointDetail (dict) –

      Details about the created interface VPC endpoint.

      • id (string) –

        The unique identifier of the endpoint.

      • name (string) –

        The name of the endpoint.

      • status (string) –

        The current status in the endpoint creation process.

Exceptions

  • OpenSearchServiceServerless.Client.exceptions.InternalServerException

  • OpenSearchServiceServerless.Client.exceptions.ConflictException

  • OpenSearchServiceServerless.Client.exceptions.ValidationException