RevokeEndpointAccessCommand

Revokes access to a cluster.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RedshiftClient, RevokeEndpointAccessCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, RevokeEndpointAccessCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const input = { // RevokeEndpointAccessMessage
  ClusterIdentifier: "STRING_VALUE",
  Account: "STRING_VALUE",
  VpcIds: [ // VpcIdentifierList
    "STRING_VALUE",
  ],
  Force: true || false,
};
const command = new RevokeEndpointAccessCommand(input);
const response = await client.send(command);
// { // EndpointAuthorization
//   Grantor: "STRING_VALUE",
//   Grantee: "STRING_VALUE",
//   ClusterIdentifier: "STRING_VALUE",
//   AuthorizeTime: new Date("TIMESTAMP"),
//   ClusterStatus: "STRING_VALUE",
//   Status: "Authorized" || "Revoking",
//   AllowedAllVPCs: true || false,
//   AllowedVPCs: [ // VpcIdentifierList
//     "STRING_VALUE",
//   ],
//   EndpointCount: Number("int"),
// };

RevokeEndpointAccessCommand Input

Parameter
Type
Description
Account
string | undefined

The Amazon Web Services account ID whose access is to be revoked.

ClusterIdentifier
string | undefined

The cluster to revoke access from.

Force
boolean | undefined

Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.

VpcIds
string[] | undefined

The virtual private cloud (VPC) identifiers for which access is to be revoked.

RevokeEndpointAccessCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AllowedAllVPCs
boolean | undefined

Indicates whether all VPCs in the grantee account are allowed access to the cluster.

AllowedVPCs
string[] | undefined

The VPCs allowed access to the cluster.

AuthorizeTime
Date | undefined

The time (UTC) when the authorization was created.

ClusterIdentifier
string | undefined

The cluster identifier.

ClusterStatus
string | undefined

The status of the cluster.

EndpointCount
number | undefined

The number of Redshift-managed VPC endpoints created for the authorization.

Grantee
string | undefined

The Amazon Web Services account ID of the grantee of the cluster.

Grantor
string | undefined

The Amazon Web Services account ID of the cluster owner.

Status
AuthorizationStatus | undefined

The status of the authorization action.

Throws

Name
Fault
Details
ClusterNotFoundFault
client

The ClusterIdentifier parameter does not refer to an existing cluster.

EndpointAuthorizationNotFoundFault
client

The authorization for this endpoint can't be found.

EndpointNotFoundFault
client

The endpoint name doesn't refer to an existing endpoint.

InvalidAuthorizationStateFault
client

The status of the authorization is not valid.

InvalidClusterSecurityGroupStateFault
client

The state of the cluster security group is not available.

InvalidClusterStateFault
client

The specified cluster is not in the available state.

InvalidEndpointStateFault
client

The status of the endpoint is not valid.

RedshiftServiceException
Base exception class for all service exceptions from Redshift service.