authorize_endpoint_access

Redshift.Client.authorize_endpoint_access(**kwargs)

Grants access to a cluster.

See also: AWS API Documentation

Request Syntax

response = client.authorize_endpoint_access(
    ClusterIdentifier='string',
    Account='string',
    VpcIds=[
        'string',
    ]
)

Parameters

• ClusterIdentifier (string) -- The cluster identifier of the cluster to grant access to.
• Account (string) --

  [REQUIRED]

  The Amazon Web Services account ID to grant access to.

• VpcIds (list) --

  The virtual private cloud (VPC) identifiers to grant access to.

  • (string) --

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

• Redshift.Client.exceptions.ClusterNotFoundFault
• Redshift.Client.exceptions.EndpointAuthorizationsPerClusterLimitExceededFault
• Redshift.Client.exceptions.UnsupportedOperationFault
• Redshift.Client.exceptions.EndpointAuthorizationAlreadyExistsFault
• Redshift.Client.exceptions.InvalidAuthorizationStateFault
• Redshift.Client.exceptions.InvalidClusterStateFault