Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . opensearchserverless ]

update-vpc-endpoint

Description

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

See also: AWS API Documentation

Synopsis

  update-vpc-endpoint
[--add-security-group-ids <value>]
[--add-subnet-ids <value>]
[--client-token <value>]
--id <value>
[--remove-security-group-ids <value>]
[--remove-subnet-ids <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--add-security-group-ids (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)

Syntax:

"string" "string" ...

--add-subnet-ids (list)

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

(string)

Syntax:

"string" "string" ...

--client-token (string)

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

--id (string)

The unique identifier of the interface endpoint to update.

--remove-security-group-ids (list)

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

(string)

Syntax:

"string" "string" ...

--remove-subnet-ids (list)

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

(string)

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

UpdateVpcEndpointDetail -> (structure)

Details about the updated VPC endpoint.

id -> (string)

The unique identifier of the endpoint.

lastModifiedDate -> (long)

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)