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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of datashares when the account identifier being called is a producer account identifier.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDataSharesForProducer Source #

See: newDescribeDataSharesForProducer smart constructor.

Constructors

DescribeDataSharesForProducer'

Fields

marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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.
producerArn :: Maybe Text
The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.
status :: Maybe DataShareStatusForProducer
An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

Instances

Instances details

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

newDescribeDataSharesForProducer :: DescribeDataSharesForProducer Source #

Create a value of DescribeDataSharesForProducer 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:

DescribeDataSharesForProducer, describeDataSharesForProducer_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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:DescribeDataSharesForProducer', describeDataSharesForProducer_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.

DescribeDataSharesForProducer, describeDataSharesForProducer_producerArn - The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.

DescribeDataSharesForProducer, describeDataSharesForProducer_status - An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

Request Lenses

describeDataSharesForProducer_marker :: Lens' DescribeDataSharesForProducer (Maybe Text) Source #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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.

describeDataSharesForProducer_maxRecords :: Lens' DescribeDataSharesForProducer (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.

describeDataSharesForProducer_producerArn :: Lens' DescribeDataSharesForProducer (Maybe Text) Source #

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

describeDataSharesForProducer_status :: Lens' DescribeDataSharesForProducer (Maybe DataShareStatusForProducer) Source #

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

Destructuring the Response

data DescribeDataSharesForProducerResponse Source #

See: newDescribeDataSharesForProducerResponse smart constructor.

Constructors

DescribeDataSharesForProducerResponse'

Fields

dataShares :: Maybe [DataShare]
Shows the results of datashares available for producers.
marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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 DescribeDataSharesForProducerResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForProducer Associated Types type Rep DescribeDataSharesForProducerResponse :: Type -> Type # Methods from :: DescribeDataSharesForProducerResponse -> Rep DescribeDataSharesForProducerResponse x # to :: Rep DescribeDataSharesForProducerResponse x -> DescribeDataSharesForProducerResponse #
Read DescribeDataSharesForProducerResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForProducer Methods readsPrec :: Int -> ReadS DescribeDataSharesForProducerResponse # readList :: ReadS [DescribeDataSharesForProducerResponse] # readPrec :: ReadPrec DescribeDataSharesForProducerResponse # readListPrec :: ReadPrec [DescribeDataSharesForProducerResponse] #
Show DescribeDataSharesForProducerResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForProducer Methods showsPrec :: Int -> DescribeDataSharesForProducerResponse -> ShowS # show :: DescribeDataSharesForProducerResponse -> String # showList :: [DescribeDataSharesForProducerResponse] -> ShowS #
NFData DescribeDataSharesForProducerResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForProducer Methods rnf :: DescribeDataSharesForProducerResponse -> () #
Eq DescribeDataSharesForProducerResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForProducer Methods (==) :: DescribeDataSharesForProducerResponse -> DescribeDataSharesForProducerResponse -> Bool # (/=) :: DescribeDataSharesForProducerResponse -> DescribeDataSharesForProducerResponse -> Bool #
type Rep DescribeDataSharesForProducerResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataSharesForProducer type Rep DescribeDataSharesForProducerResponse = D1 ('MetaData "DescribeDataSharesForProducerResponse" "Amazonka.Redshift.DescribeDataSharesForProducer" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeDataSharesForProducerResponse'" '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))))

newDescribeDataSharesForProducerResponse Source #

Arguments

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

Create a value of DescribeDataSharesForProducerResponse 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:DescribeDataSharesForProducerResponse', describeDataSharesForProducerResponse_dataShares - Shows the results of datashares available for producers.

DescribeDataSharesForProducer, describeDataSharesForProducerResponse_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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:DescribeDataSharesForProducerResponse', describeDataSharesForProducerResponse_httpStatus - The response's http status code.

Response Lenses

describeDataSharesForProducerResponse_dataShares :: Lens' DescribeDataSharesForProducerResponse (Maybe [DataShare]) Source #

Shows the results of datashares available for producers.

describeDataSharesForProducerResponse_marker :: Lens' DescribeDataSharesForProducerResponse (Maybe Text) Source #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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.

describeDataSharesForProducerResponse_httpStatus :: Lens' DescribeDataSharesForProducerResponse Int Source #

The response's http status code.