Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

update_vpc_endpoint

update_vpc_endpoint(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_vpc_endpoint(
    addSecurityGroupIds=[
        'string',
    ],
    addSubnetIds=[
        'string',
    ],
    clientToken='string',
    id='string',
    removeSecurityGroupIds=[
        'string',
    ],
    removeSubnetIds=[
        'string',
    ]
)
Parameters
  • addSecurityGroupIds (list) --

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

    • (string) --
  • addSubnetIds (list) --

    The ID of one or more subnets to add to the endpoint.

    • (string) --
  • clientToken (string) --

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

    This field is autopopulated if not provided.

  • id (string) --

    [REQUIRED]

    The unique identifier of the interface endpoint to update.

  • removeSecurityGroupIds (list) --

    The unique identifiers of the security groups to remove from the endpoint.

    • (string) --
  • removeSubnetIds (list) --

    The unique identifiers of the subnets to remove from the endpoint.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'UpdateVpcEndpointDetail': {
        'id': 'string',
        'lastModifiedDate': 123,
        'name': 'string',
        'securityGroupIds': [
            'string',
        ],
        'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED',
        'subnetIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • UpdateVpcEndpointDetail (dict) --

      Details about the updated VPC endpoint.

      • id (string) --

        The unique identifier of the endpoint.

      • lastModifiedDate (integer) --

        The timestamp of when the endpoint was last modified.

      • name (string) --

        The name of the 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) --
      • status (string) --

        The current status of the endpoint update process.

      • subnetIds (list) --

        The ID of the subnets from which you access OpenSearch Serverless.

        • (string) --

Exceptions

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