RevokeEndpointAccess
Revokes access to a cluster.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Account
-
The AWS account ID whose access is to be revoked.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- ClusterIdentifier
-
The cluster to revoke access from.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- Force
-
Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
Type: Boolean
Required: No
- VpcIds.VpcIdentifier.N
-
The virtual private cloud (VPC) identifiers for which access is to be revoked.
Type: Array of strings
Length Constraints: Maximum length of 2147483647.
Required: No
Response Elements
The following elements are returned by the service.
- AllowedAllVPCs
-
Indicates whether all VPCs in the grantee account are allowed access to the cluster.
Type: Boolean
- AllowedVPCs.VpcIdentifier.N
-
The VPCs allowed access to the cluster.
Type: Array of strings
Length Constraints: Maximum length of 2147483647.
- AuthorizeTime
-
The time (UTC) when the authorization was created.
Type: Timestamp
- ClusterIdentifier
-
The cluster identifier.
Type: String
Length Constraints: Maximum length of 2147483647.
- ClusterStatus
-
The status of the cluster.
Type: String
Length Constraints: Maximum length of 2147483647.
- EndpointCount
-
The number of Redshift-managed VPC endpoints created for the authorization.
Type: Integer
- Grantee
-
The AWS account ID of the grantee of the cluster.
Type: String
Length Constraints: Maximum length of 2147483647.
- Grantor
-
The AWS account ID of the cluster owner.
Type: String
Length Constraints: Maximum length of 2147483647.
- Status
-
The status of the authorization action.
Type: String
Valid Values:
Authorized | Revoking
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterNotFound
-
The
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- EndpointAuthorizationNotFound
-
The authorization for this endpoint can't be found.
HTTP Status Code: 404
- EndpointNotFound
-
The endpoint name doesn't refer to an existing endpoint.
HTTP Status Code: 404
- InvalidAuthorizationState
-
The status of the authorization is not valid.
HTTP Status Code: 400
- InvalidClusterSecurityGroupState
-
The state of the cluster security group is not
available.HTTP Status Code: 400
- InvalidClusterState
-
The specified cluster is not in the
availablestate.HTTP Status Code: 400
- InvalidEndpointState
-
The status of the endpoint is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
