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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Shows the status of any inbound or outbound datashares available in the specified account.

Creating a Request

data DescribeDataShares Source #

See: newDescribeDataShares smart constructor.

Constructors

DescribeDataShares'

Fields

marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares 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.
dataShareArn :: Maybe Text
The identifier of the datashare to describe details of.

Instances

Instances details

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

newDescribeDataShares :: DescribeDataShares Source #

Create a value of DescribeDataShares 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:DescribeDataShares', describeDataShares_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares 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:DescribeDataShares', describeDataShares_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.

$sel:dataShareArn:DescribeDataShares', describeDataShares_dataShareArn - The identifier of the datashare to describe details of.

Request Lenses

describeDataShares_marker :: Lens' DescribeDataShares (Maybe Text) Source #

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

describeDataShares_maxRecords :: Lens' DescribeDataShares (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.

describeDataShares_dataShareArn :: Lens' DescribeDataShares (Maybe Text) Source #

The identifier of the datashare to describe details of.

Destructuring the Response

data DescribeDataSharesResponse Source #

See: newDescribeDataSharesResponse smart constructor.

Constructors

DescribeDataSharesResponse'

Fields

marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares 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]
The results returned from describing datashares.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeDataSharesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataShares Methods (==) :: DescribeDataSharesResponse -> DescribeDataSharesResponse -> Bool # (/=) :: DescribeDataSharesResponse -> DescribeDataSharesResponse -> Bool #
Read DescribeDataSharesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataShares Methods readsPrec :: Int -> ReadS DescribeDataSharesResponse # readList :: ReadS [DescribeDataSharesResponse] # readPrec :: ReadPrec DescribeDataSharesResponse # readListPrec :: ReadPrec [DescribeDataSharesResponse] #
Show DescribeDataSharesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataShares Methods showsPrec :: Int -> DescribeDataSharesResponse -> ShowS # show :: DescribeDataSharesResponse -> String # showList :: [DescribeDataSharesResponse] -> ShowS #
Generic DescribeDataSharesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataShares Associated Types type Rep DescribeDataSharesResponse :: Type -> Type # Methods from :: DescribeDataSharesResponse -> Rep DescribeDataSharesResponse x # to :: Rep DescribeDataSharesResponse x -> DescribeDataSharesResponse #
NFData DescribeDataSharesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataShares Methods rnf :: DescribeDataSharesResponse -> () #
type Rep DescribeDataSharesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeDataShares type Rep DescribeDataSharesResponse = D1 ('MetaData "DescribeDataSharesResponse" "Amazonka.Redshift.DescribeDataShares" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeDataSharesResponse'" '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))))

newDescribeDataSharesResponse Source #

Arguments

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

Create a value of DescribeDataSharesResponse 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:DescribeDataShares', describeDataSharesResponse_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares 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:DescribeDataSharesResponse', describeDataSharesResponse_dataShares - The results returned from describing datashares.

$sel:httpStatus:DescribeDataSharesResponse', describeDataSharesResponse_httpStatus - The response's http status code.

Response Lenses

describeDataSharesResponse_marker :: Lens' DescribeDataSharesResponse (Maybe Text) Source #

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

describeDataSharesResponse_dataShares :: Lens' DescribeDataSharesResponse (Maybe [DataShare]) Source #

The results returned from describing datashares.

describeDataSharesResponse_httpStatus :: Lens' DescribeDataSharesResponse Int Source #

The response's http status code.