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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all of the streams in your Amazon Web Services account.

Requires permission to access the ListStreams action.

This operation returns paginated results.

Creating a Request

data ListStreams Source #

See: newListStreams smart constructor.

Constructors

ListStreams'
Fields nextToken :: Maybe Text A token used to get the next set of results. ascendingOrder :: Maybe Bool Set to true to return the list of streams in ascending order. maxResults :: Maybe Natural The maximum number of results to return at a time.

Instances

Instances details

Eq ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods (==) :: ListStreams -> ListStreams -> Bool # (/=) :: ListStreams -> ListStreams -> Bool #
Read ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods readsPrec :: Int -> ReadS ListStreams # readList :: ReadS [ListStreams] # readPrec :: ReadPrec ListStreams # readListPrec :: ReadPrec [ListStreams] #
Show ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods showsPrec :: Int -> ListStreams -> ShowS # show :: ListStreams -> String # showList :: [ListStreams] -> ShowS #
Generic ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Associated Types type Rep ListStreams :: Type -> Type # Methods from :: ListStreams -> Rep ListStreams x # to :: Rep ListStreams x -> ListStreams #
NFData ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods rnf :: ListStreams -> () #
Hashable ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods hashWithSalt :: Int -> ListStreams -> Int # hash :: ListStreams -> Int #
AWSPager ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods page :: ListStreams -> AWSResponse ListStreams -> Maybe ListStreams #
AWSRequest ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Associated Types type AWSResponse ListStreams # Methods request :: ListStreams -> Request ListStreams # response :: MonadResource m => Logger -> Service -> Proxy ListStreams -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStreams))) #
ToHeaders ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods toHeaders :: ListStreams -> [Header] #
ToPath ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods toPath :: ListStreams -> ByteString #
ToQuery ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods toQuery :: ListStreams -> QueryString #
type Rep ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams type Rep ListStreams = D1 ('MetaData "ListStreams" "Amazonka.IoT.ListStreams" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "ListStreams'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ascendingOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListStreams Source #
Instance details Defined in Amazonka.IoT.ListStreams type AWSResponse ListStreams = ListStreamsResponse

newListStreams :: ListStreams Source #

Create a value of ListStreams 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:nextToken:ListStreams', listStreams_nextToken - A token used to get the next set of results.

$sel:ascendingOrder:ListStreams', listStreams_ascendingOrder - Set to true to return the list of streams in ascending order.

$sel:maxResults:ListStreams', listStreams_maxResults - The maximum number of results to return at a time.

Request Lenses

listStreams_nextToken :: Lens' ListStreams (Maybe Text) Source #

A token used to get the next set of results.

listStreams_ascendingOrder :: Lens' ListStreams (Maybe Bool) Source #

Set to true to return the list of streams in ascending order.

listStreams_maxResults :: Lens' ListStreams (Maybe Natural) Source #

The maximum number of results to return at a time.

Destructuring the Response

data ListStreamsResponse Source #

See: newListStreamsResponse smart constructor.

Constructors

ListStreamsResponse'
Fields nextToken :: Maybe Text A token used to get the next set of results. streams :: Maybe [StreamSummary] A list of streams. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListStreamsResponse Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods (==) :: ListStreamsResponse -> ListStreamsResponse -> Bool # (/=) :: ListStreamsResponse -> ListStreamsResponse -> Bool #
Read ListStreamsResponse Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods readsPrec :: Int -> ReadS ListStreamsResponse # readList :: ReadS [ListStreamsResponse] # readPrec :: ReadPrec ListStreamsResponse # readListPrec :: ReadPrec [ListStreamsResponse] #
Show ListStreamsResponse Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods showsPrec :: Int -> ListStreamsResponse -> ShowS # show :: ListStreamsResponse -> String # showList :: [ListStreamsResponse] -> ShowS #
Generic ListStreamsResponse Source #
Instance details Defined in Amazonka.IoT.ListStreams Associated Types type Rep ListStreamsResponse :: Type -> Type # Methods from :: ListStreamsResponse -> Rep ListStreamsResponse x # to :: Rep ListStreamsResponse x -> ListStreamsResponse #
NFData ListStreamsResponse Source #
Instance details Defined in Amazonka.IoT.ListStreams Methods rnf :: ListStreamsResponse -> () #
type Rep ListStreamsResponse Source #
Instance details Defined in Amazonka.IoT.ListStreams type Rep ListStreamsResponse = D1 ('MetaData "ListStreamsResponse" "Amazonka.IoT.ListStreams" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "ListStreamsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "streams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StreamSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStreamsResponse Source #

Arguments

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

Create a value of ListStreamsResponse 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:nextToken:ListStreams', listStreamsResponse_nextToken - A token used to get the next set of results.

$sel:streams:ListStreamsResponse', listStreamsResponse_streams - A list of streams.

$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.

Response Lenses

listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text) Source #

A token used to get the next set of results.

listStreamsResponse_streams :: Lens' ListStreamsResponse (Maybe [StreamSummary]) Source #

A list of streams.

listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int Source #

The response's http status code.