Redshift / Client / revoke_endpoint_access
revoke_endpoint_access#
- Redshift.Client.revoke_endpoint_access(**kwargs)#
Revokes access to a cluster.
See also: AWS API Documentation
Request Syntax
response = client.revoke_endpoint_access( ClusterIdentifier='string', Account='string', VpcIds=[ 'string', ], Force=True|False )
- Parameters:
ClusterIdentifier (string) – The cluster to revoke access from.
Account (string) – The Amazon Web Services account ID whose access is to be revoked.
VpcIds (list) –
The virtual private cloud (VPC) identifiers for which access is to be revoked.
(string) –
Force (boolean) – Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
- Return type:
dict
- Returns:
Response Syntax
{ 'Grantor': 'string', 'Grantee': 'string', 'ClusterIdentifier': 'string', 'AuthorizeTime': datetime(2015, 1, 1), 'ClusterStatus': 'string', 'Status': 'Authorized'|'Revoking', 'AllowedAllVPCs': True|False, 'AllowedVPCs': [ 'string', ], 'EndpointCount': 123 }
Response Structure
(dict) –
Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across Amazon Web Services accounts.
Grantor (string) –
The Amazon Web Services account ID of the cluster owner.
Grantee (string) –
The Amazon Web Services account ID of the grantee of the cluster.
ClusterIdentifier (string) –
The cluster identifier.
AuthorizeTime (datetime) –
The time (UTC) when the authorization was created.
ClusterStatus (string) –
The status of the cluster.
Status (string) –
The status of the authorization action.
AllowedAllVPCs (boolean) –
Indicates whether all VPCs in the grantee account are allowed access to the cluster.
AllowedVPCs (list) –
The VPCs allowed access to the cluster.
(string) –
EndpointCount (integer) –
The number of Redshift-managed VPC endpoints created for the authorization.
Exceptions