Modifies the attributes of an endpoint.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateVpcEndpointAttribute

Required. The operation that you want to perform. Set the value to UpdateVpcEndpointAttribute.

EndpointDescription String Yes This is my Endpoint.

The description of the endpoint.

The description must be 2 to 256 characters in length, and cannot start with http:// or https://.

EndpointId String Yes ep-hp33b2e43fays7s8****

The ID of the endpoint that you want to modify.

EndpointName String Yes test

The name of the endpoint.

The name must be 2 to 128 characters in length, and can contain digits, underscores (_), and hyphens (-). It must start with a letter.

RegionId String Yes eu-west-1

The ID of the region where the endpoint that you want to modify is created. You can call the DescribeRegions operation to query region IDs.

ClientToken String No 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The client token that is used to ensure the idempotence of the request. You can use the client to generate a value that is unique among different requests. The ClientToken parameter can contain only ASCII characters and cannot exceed 64 characters in length.

DryRun Boolean No true

Specifies whether to only check the API request. Valid values:

true: only checks the API request. If you select this option, the attributes of the endpoint are not modified after the request passes the check. Check items include whether the AccessKey pair is valid, whether the RAM user is authorized, and whether the required parameters are specified. If the request fails to meet the requirements in the check items, an error message is returned. If the request meets the requirements in the check items, the DryRunOperation error code is returned.

false (default): checks the API request. After the request passes the check, the 2XX HTTP status code is returned, and the attributes of the endpoint are modified.

Response parameters

Parameter Type Example Description
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=UpdateVpcEndpointAttribute
&EndpointDescription=This is my Endpoint.
&EndpointId=ep-hp33b2e43fays7s8****
&EndpointName=test
&RegionId=eu-west-1
&<Common request parameters>

Sample success responses

XML format

<UpdateVpcEndpointAttributeResponse>    
      <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>
</UpdateVpcEndpointAttributeResponse>

JSON format

{
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B"
}

Errors codes

HttpCode Error code Error message Description
400 EndpointNotFound The specified Endpoint does not exist. The error message returned because the specified endpoint is not found.
400 EndpointOperationDenied The specified operation of endpoint is not allowed. The error message returned because the operation is not allowed when the endpoint is being processed.
400 EndpointLocked The specified Endpoint is locked. The error message returned because the endpoint is locked.

For a list of error codes, visit the API Error Center.