libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.DescribeDataSharesForProducer

Description

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

Synopsis

Creating a Request

data DescribeDataSharesForProducer Source #

See: newDescribeDataSharesForProducer smart constructor.

Constructors

DescribeDataSharesForProducer' 

Fields

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

  • producerArn :: Maybe Text

    The Amazon Resource Name (ARN) of the producer 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 DescribeDataSharesForProducer 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 DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

Read DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

Show DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

Generic DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

Associated Types

type Rep DescribeDataSharesForProducer :: Type -> Type #

NFData DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

Hashable DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

AWSRequest DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

ToHeaders DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

ToPath DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

ToQuery DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

type Rep DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

type Rep DescribeDataSharesForProducer = D1 ('MetaData "DescribeDataSharesForProducer" "Amazonka.Redshift.DescribeDataSharesForProducer" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeDataSharesForProducer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataShareStatusForProducer)) :*: S1 ('MetaSel ('Just "producerArn") '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 DescribeDataSharesForProducer Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

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:

$sel:status: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.

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

$sel:marker: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, 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: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.

Request Lenses

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.

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

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

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

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.

Destructuring the Response

data DescribeDataSharesForProducerResponse Source #

Constructors

DescribeDataSharesForProducerResponse' 

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeDataSharesForProducerResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

Read DescribeDataSharesForProducerResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

Show DescribeDataSharesForProducerResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

Generic DescribeDataSharesForProducerResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

NFData DescribeDataSharesForProducerResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

type Rep DescribeDataSharesForProducerResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeDataSharesForProducer

type Rep DescribeDataSharesForProducerResponse = D1 ('MetaData "DescribeDataSharesForProducerResponse" "Amazonka.Redshift.DescribeDataSharesForProducer" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeDataSharesForProducerResponse'" '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))))

newDescribeDataSharesForProducerResponse Source #

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

$sel:httpStatus:DescribeDataSharesForProducerResponse', describeDataSharesForProducerResponse_httpStatus - The response's http status code.

Response Lenses

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