libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.DescribeEndpointAuthorization

Description

Describes an endpoint authorization.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEndpointAuthorization Source #

See: newDescribeEndpointAuthorization smart constructor.

Constructors

DescribeEndpointAuthorization' 

Fields

  • clusterIdentifier :: Maybe Text

    The cluster identifier of the cluster to access.

  • account :: Maybe Text

    The AAmazon 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.

  • marker :: Maybe Text

    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.

  • maxRecords :: Maybe Int

    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.

  • grantee :: Maybe Bool

    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.

Instances

Instances details
Eq DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

Read DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

Show DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

Generic DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

Associated Types

type Rep DescribeEndpointAuthorization :: Type -> Type #

NFData DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

Hashable DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

AWSPager DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

AWSRequest DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

ToHeaders DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

ToPath DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

ToQuery DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

type Rep DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

type Rep DescribeEndpointAuthorization = D1 ('MetaData "DescribeEndpointAuthorization" "Amazonka.Redshift.DescribeEndpointAuthorization" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeEndpointAuthorization'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "account") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "grantee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))
type AWSResponse DescribeEndpointAuthorization Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

newDescribeEndpointAuthorization :: DescribeEndpointAuthorization Source #

Create a value of DescribeEndpointAuthorization with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clusterIdentifier:DescribeEndpointAuthorization', describeEndpointAuthorization_clusterIdentifier - The cluster identifier of the cluster to access.

$sel:account:DescribeEndpointAuthorization', describeEndpointAuthorization_account - The AAmazon 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.

$sel:marker:DescribeEndpointAuthorization', describeEndpointAuthorization_marker - 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.

$sel:maxRecords:DescribeEndpointAuthorization', describeEndpointAuthorization_maxRecords - 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.

$sel:grantee:DescribeEndpointAuthorization', describeEndpointAuthorization_grantee - 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.

Request Lenses

describeEndpointAuthorization_account :: Lens' DescribeEndpointAuthorization (Maybe Text) Source #

The AAmazon 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.

describeEndpointAuthorization_marker :: Lens' DescribeEndpointAuthorization (Maybe Text) Source #

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.

describeEndpointAuthorization_maxRecords :: Lens' DescribeEndpointAuthorization (Maybe Int) Source #

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.

describeEndpointAuthorization_grantee :: Lens' DescribeEndpointAuthorization (Maybe Bool) Source #

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.

Destructuring the Response

data DescribeEndpointAuthorizationResponse Source #

Constructors

DescribeEndpointAuthorizationResponse' 

Fields

Instances

Instances details
Eq DescribeEndpointAuthorizationResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

Read DescribeEndpointAuthorizationResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

Show DescribeEndpointAuthorizationResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

Generic DescribeEndpointAuthorizationResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

NFData DescribeEndpointAuthorizationResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

type Rep DescribeEndpointAuthorizationResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeEndpointAuthorization

type Rep DescribeEndpointAuthorizationResponse = D1 ('MetaData "DescribeEndpointAuthorizationResponse" "Amazonka.Redshift.DescribeEndpointAuthorization" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeEndpointAuthorizationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointAuthorizationList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointAuthorization])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEndpointAuthorizationResponse Source #

Create a value of DescribeEndpointAuthorizationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointAuthorizationList:DescribeEndpointAuthorizationResponse', describeEndpointAuthorizationResponse_endpointAuthorizationList - The authorizations to an endpoint.

$sel:marker:DescribeEndpointAuthorization', describeEndpointAuthorizationResponse_marker - 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.

$sel:httpStatus:DescribeEndpointAuthorizationResponse', describeEndpointAuthorizationResponse_httpStatus - The response's http status code.

Response Lenses

describeEndpointAuthorizationResponse_marker :: Lens' DescribeEndpointAuthorizationResponse (Maybe Text) Source #

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.