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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of datashares where the account identifier being called is a consumer account identifier.

Synopsis

Creating a Request

data DescribeDataSharesForConsumer Source #

See: newDescribeDataSharesForConsumer smart constructor.

Constructors

DescribeDataSharesForConsumer'

Fields

status :: Maybe DataShareStatusForConsumer
An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.
consumerArn :: Maybe Text
The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.
marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
maxRecords :: Maybe Int
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Instances

Instances details

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

newDescribeDataSharesForConsumer :: DescribeDataSharesForConsumer Source #

Create a value of DescribeDataSharesForConsumer 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:status:DescribeDataSharesForConsumer', describeDataSharesForConsumer_status - An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

$sel:consumerArn:DescribeDataSharesForConsumer', describeDataSharesForConsumer_consumerArn - The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.

$sel:marker:DescribeDataSharesForConsumer', describeDataSharesForConsumer_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

$sel:maxRecords:DescribeDataSharesForConsumer', describeDataSharesForConsumer_maxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Request Lenses

describeDataSharesForConsumer_status :: Lens' DescribeDataSharesForConsumer (Maybe DataShareStatusForConsumer) Source #

An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

describeDataSharesForConsumer_consumerArn :: Lens' DescribeDataSharesForConsumer (Maybe Text) Source #

The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.

describeDataSharesForConsumer_marker :: Lens' DescribeDataSharesForConsumer (Maybe Text) Source #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeDataSharesForConsumer_maxRecords :: Lens' DescribeDataSharesForConsumer (Maybe Int) Source #

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Destructuring the Response

data DescribeDataSharesForConsumerResponse Source #

See: newDescribeDataSharesForConsumerResponse smart constructor.

Constructors

DescribeDataSharesForConsumerResponse'

Fields

marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dataShares :: Maybe [DataShare]
Shows the results of datashares available for consumers.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeDataSharesForConsumerResponse Source #

Arguments

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

Create a value of DescribeDataSharesForConsumerResponse 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:DescribeDataSharesForConsumer', describeDataSharesForConsumerResponse_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

$sel:dataShares:DescribeDataSharesForConsumerResponse', describeDataSharesForConsumerResponse_dataShares - Shows the results of datashares available for consumers.

$sel:httpStatus:DescribeDataSharesForConsumerResponse', describeDataSharesForConsumerResponse_httpStatus - The response's http status code.

Response Lenses

describeDataSharesForConsumerResponse_marker :: Lens' DescribeDataSharesForConsumerResponse (Maybe Text) Source #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeDataSharesForConsumerResponse_dataShares :: Lens' DescribeDataSharesForConsumerResponse (Maybe [DataShare]) Source #

Shows the results of datashares available for consumers.

describeDataSharesForConsumerResponse_httpStatus :: Lens' DescribeDataSharesForConsumerResponse Int Source #

The response's http status code.