Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Redshift.DescribeEndpointAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a Redshift-managed VPC endpoint.

This operation returns paginated results.

Synopsis

data DescribeEndpointAccess = DescribeEndpointAccess' {
- endpointName :: Maybe Text
- vpcId :: Maybe Text
- clusterIdentifier :: Maybe Text
- marker :: Maybe Text
- maxRecords :: Maybe Int
- resourceOwner :: Maybe Text
}
newDescribeEndpointAccess :: DescribeEndpointAccess
describeEndpointAccess_endpointName :: Lens' DescribeEndpointAccess (Maybe Text)
describeEndpointAccess_vpcId :: Lens' DescribeEndpointAccess (Maybe Text)
describeEndpointAccess_clusterIdentifier :: Lens' DescribeEndpointAccess (Maybe Text)
describeEndpointAccess_marker :: Lens' DescribeEndpointAccess (Maybe Text)
describeEndpointAccess_maxRecords :: Lens' DescribeEndpointAccess (Maybe Int)
describeEndpointAccess_resourceOwner :: Lens' DescribeEndpointAccess (Maybe Text)
data DescribeEndpointAccessResponse = DescribeEndpointAccessResponse' {
- marker :: Maybe Text
- endpointAccessList :: Maybe [EndpointAccess]
- httpStatus :: Int
}
newDescribeEndpointAccessResponse :: Int -> DescribeEndpointAccessResponse
describeEndpointAccessResponse_marker :: Lens' DescribeEndpointAccessResponse (Maybe Text)
describeEndpointAccessResponse_endpointAccessList :: Lens' DescribeEndpointAccessResponse (Maybe [EndpointAccess])
describeEndpointAccessResponse_httpStatus :: Lens' DescribeEndpointAccessResponse Int

Creating a Request

data DescribeEndpointAccess Source #

See: newDescribeEndpointAccess smart constructor.

Constructors

DescribeEndpointAccess'

Fields

endpointName :: Maybe Text
The name of the endpoint to be described.
vpcId :: Maybe Text
The virtual private cloud (VPC) identifier with access to the cluster.
clusterIdentifier :: Maybe Text
The cluster identifier associated with the described endpoint.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeEndpointAccess 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.
resourceOwner :: Maybe Text
The Amazon Web Services account ID of the owner of the cluster.

Instances

Instances details

Eq DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods (==) :: DescribeEndpointAccess -> DescribeEndpointAccess -> Bool # (/=) :: DescribeEndpointAccess -> DescribeEndpointAccess -> Bool #
Read DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods readsPrec :: Int -> ReadS DescribeEndpointAccess # readList :: ReadS [DescribeEndpointAccess] # readPrec :: ReadPrec DescribeEndpointAccess # readListPrec :: ReadPrec [DescribeEndpointAccess] #
Show DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods showsPrec :: Int -> DescribeEndpointAccess -> ShowS # show :: DescribeEndpointAccess -> String # showList :: [DescribeEndpointAccess] -> ShowS #
Generic DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Associated Types type Rep DescribeEndpointAccess :: Type -> Type # Methods from :: DescribeEndpointAccess -> Rep DescribeEndpointAccess x # to :: Rep DescribeEndpointAccess x -> DescribeEndpointAccess #
NFData DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods rnf :: DescribeEndpointAccess -> () #
Hashable DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods hashWithSalt :: Int -> DescribeEndpointAccess -> Int # hash :: DescribeEndpointAccess -> Int #
AWSPager DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods page :: DescribeEndpointAccess -> AWSResponse DescribeEndpointAccess -> Maybe DescribeEndpointAccess #
AWSRequest DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Associated Types type AWSResponse DescribeEndpointAccess # Methods request :: DescribeEndpointAccess -> Request DescribeEndpointAccess # response :: MonadResource m => Logger -> Service -> Proxy DescribeEndpointAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEndpointAccess))) #
ToHeaders DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods toHeaders :: DescribeEndpointAccess -> [Header] #
ToPath DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods toPath :: DescribeEndpointAccess -> ByteString #
ToQuery DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods toQuery :: DescribeEndpointAccess -> QueryString #
type Rep DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess type Rep DescribeEndpointAccess = D1 ('MetaData "DescribeEndpointAccess" "Amazonka.Redshift.DescribeEndpointAccess" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeEndpointAccess'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterIdentifier") '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 "resourceOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse DescribeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess type AWSResponse DescribeEndpointAccess = DescribeEndpointAccessResponse

newDescribeEndpointAccess :: DescribeEndpointAccess Source #

Create a value of DescribeEndpointAccess 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:endpointName:DescribeEndpointAccess', describeEndpointAccess_endpointName - The name of the endpoint to be described.

$sel:vpcId:DescribeEndpointAccess', describeEndpointAccess_vpcId - The virtual private cloud (VPC) identifier with access to the cluster.

$sel:clusterIdentifier:DescribeEndpointAccess', describeEndpointAccess_clusterIdentifier - The cluster identifier associated with the described endpoint.

$sel:marker:DescribeEndpointAccess', describeEndpointAccess_marker - An optional pagination token provided by a previous DescribeEndpointAccess 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:DescribeEndpointAccess', describeEndpointAccess_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:resourceOwner:DescribeEndpointAccess', describeEndpointAccess_resourceOwner - The Amazon Web Services account ID of the owner of the cluster.

Request Lenses

describeEndpointAccess_endpointName :: Lens' DescribeEndpointAccess (Maybe Text) Source #

The name of the endpoint to be described.

describeEndpointAccess_vpcId :: Lens' DescribeEndpointAccess (Maybe Text) Source #

The virtual private cloud (VPC) identifier with access to the cluster.

describeEndpointAccess_clusterIdentifier :: Lens' DescribeEndpointAccess (Maybe Text) Source #

The cluster identifier associated with the described endpoint.

describeEndpointAccess_marker :: Lens' DescribeEndpointAccess (Maybe Text) Source #

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

describeEndpointAccess_maxRecords :: Lens' DescribeEndpointAccess (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.

describeEndpointAccess_resourceOwner :: Lens' DescribeEndpointAccess (Maybe Text) Source #

The Amazon Web Services account ID of the owner of the cluster.

Destructuring the Response

data DescribeEndpointAccessResponse Source #

See: newDescribeEndpointAccessResponse smart constructor.

Constructors

DescribeEndpointAccessResponse'

Fields

marker :: Maybe Text
An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
endpointAccessList :: Maybe [EndpointAccess]
The list of endpoints with access to the cluster.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeEndpointAccessResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods (==) :: DescribeEndpointAccessResponse -> DescribeEndpointAccessResponse -> Bool # (/=) :: DescribeEndpointAccessResponse -> DescribeEndpointAccessResponse -> Bool #
Read DescribeEndpointAccessResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods readsPrec :: Int -> ReadS DescribeEndpointAccessResponse # readList :: ReadS [DescribeEndpointAccessResponse] # readPrec :: ReadPrec DescribeEndpointAccessResponse # readListPrec :: ReadPrec [DescribeEndpointAccessResponse] #
Show DescribeEndpointAccessResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods showsPrec :: Int -> DescribeEndpointAccessResponse -> ShowS # show :: DescribeEndpointAccessResponse -> String # showList :: [DescribeEndpointAccessResponse] -> ShowS #
Generic DescribeEndpointAccessResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Associated Types type Rep DescribeEndpointAccessResponse :: Type -> Type # Methods from :: DescribeEndpointAccessResponse -> Rep DescribeEndpointAccessResponse x # to :: Rep DescribeEndpointAccessResponse x -> DescribeEndpointAccessResponse #
NFData DescribeEndpointAccessResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess Methods rnf :: DescribeEndpointAccessResponse -> () #
type Rep DescribeEndpointAccessResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeEndpointAccess type Rep DescribeEndpointAccessResponse = D1 ('MetaData "DescribeEndpointAccessResponse" "Amazonka.Redshift.DescribeEndpointAccess" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeEndpointAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endpointAccessList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointAccess])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEndpointAccessResponse Source #

Arguments

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

Create a value of DescribeEndpointAccessResponse 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:marker:DescribeEndpointAccess', describeEndpointAccessResponse_marker - An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

$sel:endpointAccessList:DescribeEndpointAccessResponse', describeEndpointAccessResponse_endpointAccessList - The list of endpoints with access to the cluster.

$sel:httpStatus:DescribeEndpointAccessResponse', describeEndpointAccessResponse_httpStatus - The response's http status code.

Response Lenses

describeEndpointAccessResponse_marker :: Lens' DescribeEndpointAccessResponse (Maybe Text) Source #

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

describeEndpointAccessResponse_endpointAccessList :: Lens' DescribeEndpointAccessResponse (Maybe [EndpointAccess]) Source #

The list of endpoints with access to the cluster.

describeEndpointAccessResponse_httpStatus :: Lens' DescribeEndpointAccessResponse Int Source #

The response's http status code.