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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDataSharesForConsumer Source #

See: newDescribeDataSharesForConsumer smart constructor.

Constructors

DescribeDataSharesForConsumer'

Fields

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, Amazon Web Services 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.
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.

Instances

Instances details

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 #
AWSPager DescribeDataSharesForConsumer Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer Methods page :: DescribeDataSharesForConsumer -> AWSResponse DescribeDataSharesForConsumer -> Maybe DescribeDataSharesForConsumer #
AWSRequest DescribeDataSharesForConsumer Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer Associated Types type AWSResponse DescribeDataSharesForConsumer # Methods request :: (Service -> Service) -> DescribeDataSharesForConsumer -> Request DescribeDataSharesForConsumer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDataSharesForConsumer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDataSharesForConsumer))) #
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 #
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 #
NFData DescribeDataSharesForConsumer Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer Methods rnf :: DescribeDataSharesForConsumer -> () #
Eq DescribeDataSharesForConsumer Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer Methods (==) :: DescribeDataSharesForConsumer -> DescribeDataSharesForConsumer -> Bool # (/=) :: DescribeDataSharesForConsumer -> DescribeDataSharesForConsumer -> Bool #
Hashable DescribeDataSharesForConsumer Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer Methods hashWithSalt :: Int -> DescribeDataSharesForConsumer -> Int # hash :: DescribeDataSharesForConsumer -> Int #
type AWSResponse DescribeDataSharesForConsumer Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer type AWSResponse DescribeDataSharesForConsumer = DescribeDataSharesForConsumerResponse
type Rep DescribeDataSharesForConsumer Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer type Rep DescribeDataSharesForConsumer = D1 ('MetaData "DescribeDataSharesForConsumer" "Amazonka.Redshift.DescribeDataSharesForConsumer" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeDataSharesForConsumer'" 'PrefixI 'True) ((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)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataShareStatusForConsumer)))))

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:consumerArn:DescribeDataSharesForConsumer', describeDataSharesForConsumer_consumerArn - The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.

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, Amazon Web Services 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.

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.

Request Lenses

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, Amazon Web Services 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.

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.

Destructuring the Response

data DescribeDataSharesForConsumerResponse Source #

See: newDescribeDataSharesForConsumerResponse smart constructor.

Constructors

DescribeDataSharesForConsumerResponse'

Fields

dataShares :: Maybe [DataShare]
Shows the results of datashares available for consumers.
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, Amazon Web Services 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData DescribeDataSharesForConsumerResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer Methods rnf :: DescribeDataSharesForConsumerResponse -> () #
Eq DescribeDataSharesForConsumerResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer Methods (==) :: DescribeDataSharesForConsumerResponse -> DescribeDataSharesForConsumerResponse -> Bool # (/=) :: DescribeDataSharesForConsumerResponse -> DescribeDataSharesForConsumerResponse -> Bool #
type Rep DescribeDataSharesForConsumerResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForConsumer type Rep DescribeDataSharesForConsumerResponse = D1 ('MetaData "DescribeDataSharesForConsumerResponse" "Amazonka.Redshift.DescribeDataSharesForConsumer" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeDataSharesForConsumerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataShares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataShare])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:dataShares:DescribeDataSharesForConsumerResponse', describeDataSharesForConsumerResponse_dataShares - Shows the results of datashares available for consumers.

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, Amazon Web Services 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:httpStatus:DescribeDataSharesForConsumerResponse', describeDataSharesForConsumerResponse_httpStatus - The response's http status code.

Response Lenses

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

Shows the results of datashares available for consumers.

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, Amazon Web Services 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_httpStatus :: Lens' DescribeDataSharesForConsumerResponse Int Source #

The response's http status code.