Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Redshift.DescribeEndpointAuthorization

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an endpoint authorization.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEndpointAuthorization Source #

See: newDescribeEndpointAuthorization smart constructor.

Constructors

DescribeEndpointAuthorization'

Fields

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.
clusterIdentifier :: Maybe Text
The cluster identifier of the cluster to access.
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.
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.

Instances

Instances details

ToHeaders DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods toHeaders :: DescribeEndpointAuthorization -> [Header] #
ToPath DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods toPath :: DescribeEndpointAuthorization -> ByteString #
ToQuery DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods toQuery :: DescribeEndpointAuthorization -> QueryString #
AWSPager DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods page :: DescribeEndpointAuthorization -> AWSResponse DescribeEndpointAuthorization -> Maybe DescribeEndpointAuthorization #
AWSRequest DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Associated Types type AWSResponse DescribeEndpointAuthorization # Methods request :: (Service -> Service) -> DescribeEndpointAuthorization -> Request DescribeEndpointAuthorization # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEndpointAuthorization -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEndpointAuthorization))) #
Generic DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Associated Types type Rep DescribeEndpointAuthorization :: Type -> Type # Methods from :: DescribeEndpointAuthorization -> Rep DescribeEndpointAuthorization x # to :: Rep DescribeEndpointAuthorization x -> DescribeEndpointAuthorization #
Read DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods readsPrec :: Int -> ReadS DescribeEndpointAuthorization # readList :: ReadS [DescribeEndpointAuthorization] # readPrec :: ReadPrec DescribeEndpointAuthorization # readListPrec :: ReadPrec [DescribeEndpointAuthorization] #
Show DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods showsPrec :: Int -> DescribeEndpointAuthorization -> ShowS # show :: DescribeEndpointAuthorization -> String # showList :: [DescribeEndpointAuthorization] -> ShowS #
NFData DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods rnf :: DescribeEndpointAuthorization -> () #
Eq DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods (==) :: DescribeEndpointAuthorization -> DescribeEndpointAuthorization -> Bool # (/=) :: DescribeEndpointAuthorization -> DescribeEndpointAuthorization -> Bool #
Hashable DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods hashWithSalt :: Int -> DescribeEndpointAuthorization -> Int # hash :: DescribeEndpointAuthorization -> Int #
type AWSResponse DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization type AWSResponse DescribeEndpointAuthorization = DescribeEndpointAuthorizationResponse
type Rep DescribeEndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization type Rep DescribeEndpointAuthorization = D1 ('MetaData "DescribeEndpointAuthorization" "Amazonka.Redshift.DescribeEndpointAuthorization" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeEndpointAuthorization'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "account") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "grantee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

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: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.

DescribeEndpointAuthorization, describeEndpointAuthorization_clusterIdentifier - The cluster identifier of the cluster to access.

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.

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.

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_clusterIdentifier :: Lens' DescribeEndpointAuthorization (Maybe Text) Source #

The cluster identifier of the cluster to access.

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.

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.

Destructuring the Response

data DescribeEndpointAuthorizationResponse Source #

See: newDescribeEndpointAuthorizationResponse smart constructor.

Constructors

DescribeEndpointAuthorizationResponse'

Fields

endpointAuthorizationList :: Maybe [EndpointAuthorization]
The authorizations to an endpoint.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeEndpointAuthorizationResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Associated Types type Rep DescribeEndpointAuthorizationResponse :: Type -> Type # Methods from :: DescribeEndpointAuthorizationResponse -> Rep DescribeEndpointAuthorizationResponse x # to :: Rep DescribeEndpointAuthorizationResponse x -> DescribeEndpointAuthorizationResponse #
Read DescribeEndpointAuthorizationResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods readsPrec :: Int -> ReadS DescribeEndpointAuthorizationResponse # readList :: ReadS [DescribeEndpointAuthorizationResponse] # readPrec :: ReadPrec DescribeEndpointAuthorizationResponse # readListPrec :: ReadPrec [DescribeEndpointAuthorizationResponse] #
Show DescribeEndpointAuthorizationResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods showsPrec :: Int -> DescribeEndpointAuthorizationResponse -> ShowS # show :: DescribeEndpointAuthorizationResponse -> String # showList :: [DescribeEndpointAuthorizationResponse] -> ShowS #
NFData DescribeEndpointAuthorizationResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods rnf :: DescribeEndpointAuthorizationResponse -> () #
Eq DescribeEndpointAuthorizationResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization Methods (==) :: DescribeEndpointAuthorizationResponse -> DescribeEndpointAuthorizationResponse -> Bool # (/=) :: DescribeEndpointAuthorizationResponse -> DescribeEndpointAuthorizationResponse -> Bool #
type Rep DescribeEndpointAuthorizationResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAuthorization type Rep DescribeEndpointAuthorizationResponse = D1 ('MetaData "DescribeEndpointAuthorizationResponse" "Amazonka.Redshift.DescribeEndpointAuthorization" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" '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 #

Arguments

:: Int	`$sel:httpStatus:DescribeEndpointAuthorizationResponse'`
-> DescribeEndpointAuthorizationResponse

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.

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_endpointAuthorizationList :: Lens' DescribeEndpointAuthorizationResponse (Maybe [EndpointAuthorization]) Source #

The authorizations to an endpoint.

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.

describeEndpointAuthorizationResponse_httpStatus :: Lens' DescribeEndpointAuthorizationResponse Int Source #

The response's http status code.