Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

RevokeClientVpnIngress

Removes an ingress authorization rule from a Client VPN endpoint.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AccessGroupId

The ID of the Active Directory group for which to revoke access.

Type: String

Required: No

ClientVpnEndpointId

The ID of the Client VPN endpoint with which the authorization rule is associated.

Type: String

Required: Yes

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

RevokeAllGroups

Indicates whether access should be revoked for all clients.

Type: Boolean

Required: No

TargetNetworkCidr

The IPv4 address range, in CIDR notation, of the network for which access is being removed.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

status

The current state of the authorization rule.

Type: ClientVpnAuthorizationRuleStatus object

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example removes an authorization rule from a Client VPN endpoint.

Sample Request

https://ec2.amazonaws.com/?Action=RevokeClientVpnIngress &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &TargetNetworkCidr=10.0.0.0/16 &RevokeAllGroups=true &AUTHPARAMS

Sample Response

<RevokeClientVpnIngressResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>691de4ea-32ef-447b-b4f8-d8463XAMPLE</requestId> <status> <code>revoking</code> </status> </RevokeClientVpnIngressResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: