describe_endpoint_authorization

describe_endpoint_authorization(**kwargs)

Describes an endpoint authorization.

See also: AWS API Documentation

Request Syntax

response = client.describe_endpoint_authorization(
    ClusterIdentifier='string',
    Account='string',
    Grantee=True|False,
    MaxRecords=123,
    Marker='string'
)

Parameters

• ClusterIdentifier (string) -- The cluster identifier of the cluster to access.
• Account (string) -- The Amazon Web Services account ID of either the cluster owner (grantor) or grantee. If Grantee parameter is true, then the Account value is of the grantor.
• Grantee (boolean) -- Indicates whether to check authorization from a grantor or grantee point of view. If true, Amazon Redshift returns endpoint authorizations that you've been granted. If false (default), checks authorization from a grantor point of view.
• MaxRecords (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.
• Marker (string) -- An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Return type

dict

Returns

Response Syntax

{
    'EndpointAuthorizationList': [
        {
            'Grantor': 'string',
            'Grantee': 'string',
            'ClusterIdentifier': 'string',
            'AuthorizeTime': datetime(2015, 1, 1),
            'ClusterStatus': 'string',
            'Status': 'Authorized'|'Revoking',
            'AllowedAllVPCs': True|False,
            'AllowedVPCs': [
                'string',
            ],
            'EndpointCount': 123
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) --

  • EndpointAuthorizationList (list) --

    The authorizations to an endpoint.

    • (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.

  • Marker (string) --

    An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Exceptions

• Redshift.Client.exceptions.ClusterNotFoundFault
• Redshift.Client.exceptions.UnsupportedOperationFault