Redshift / Paginator / DescribeEndpointAuthorization

DescribeEndpointAuthorization

class Redshift.Paginator.DescribeEndpointAuthorization

paginator = client.get_paginator('describe_endpoint_authorization')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_endpoint_authorization().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterIdentifier='string',
    Account='string',
    Grantee=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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
        },
    ],
    'NextToken': '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.

  • NextToken (string) –

    A token to resume pagination.