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 |
Returns a list of datashares where the account identifier being called is a consumer account identifier.
This operation returns paginated results.
Synopsis
- data DescribeDataSharesForConsumer = DescribeDataSharesForConsumer' {}
- newDescribeDataSharesForConsumer :: DescribeDataSharesForConsumer
- describeDataSharesForConsumer_consumerArn :: Lens' DescribeDataSharesForConsumer (Maybe Text)
- describeDataSharesForConsumer_marker :: Lens' DescribeDataSharesForConsumer (Maybe Text)
- describeDataSharesForConsumer_maxRecords :: Lens' DescribeDataSharesForConsumer (Maybe Int)
- describeDataSharesForConsumer_status :: Lens' DescribeDataSharesForConsumer (Maybe DataShareStatusForConsumer)
- data DescribeDataSharesForConsumerResponse = DescribeDataSharesForConsumerResponse' {
- dataShares :: Maybe [DataShare]
- marker :: Maybe Text
- httpStatus :: Int
- newDescribeDataSharesForConsumerResponse :: Int -> DescribeDataSharesForConsumerResponse
- describeDataSharesForConsumerResponse_dataShares :: Lens' DescribeDataSharesForConsumerResponse (Maybe [DataShare])
- describeDataSharesForConsumerResponse_marker :: Lens' DescribeDataSharesForConsumerResponse (Maybe Text)
- describeDataSharesForConsumerResponse_httpStatus :: Lens' DescribeDataSharesForConsumerResponse Int
Creating a Request
data DescribeDataSharesForConsumer Source #
See: newDescribeDataSharesForConsumer
smart constructor.
DescribeDataSharesForConsumer' | |
|
Instances
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.
DescribeDataSharesForConsumerResponse' | |
|
Instances
newDescribeDataSharesForConsumerResponse Source #
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.