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.ChimeSDKMessaging.ListChannelFlows

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

Synopsis

data ListChannelFlows = ListChannelFlows' {
- maxResults :: Maybe Natural
- nextToken :: Maybe (Sensitive Text)
- appInstanceArn :: Text
}
newListChannelFlows :: Text -> ListChannelFlows
listChannelFlows_maxResults :: Lens' ListChannelFlows (Maybe Natural)
listChannelFlows_nextToken :: Lens' ListChannelFlows (Maybe Text)
listChannelFlows_appInstanceArn :: Lens' ListChannelFlows Text
data ListChannelFlowsResponse = ListChannelFlowsResponse' {
- channelFlows :: Maybe [ChannelFlowSummary]
- nextToken :: Maybe (Sensitive Text)
- httpStatus :: Int
}
newListChannelFlowsResponse :: Int -> ListChannelFlowsResponse
listChannelFlowsResponse_channelFlows :: Lens' ListChannelFlowsResponse (Maybe [ChannelFlowSummary])
listChannelFlowsResponse_nextToken :: Lens' ListChannelFlowsResponse (Maybe Text)
listChannelFlowsResponse_httpStatus :: Lens' ListChannelFlowsResponse Int

Creating a Request

data ListChannelFlows Source #

See: newListChannelFlows smart constructor.

Constructors

ListChannelFlows'
Fields maxResults :: Maybe Natural The maximum number of channel flows that you want to return. nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested channel flows are returned. appInstanceArn :: Text The ARN of the app instance.

Instances

Instances details

ToHeaders ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods toHeaders :: ListChannelFlows -> [Header] #
ToPath ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods toPath :: ListChannelFlows -> ByteString #
ToQuery ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods toQuery :: ListChannelFlows -> QueryString #
AWSRequest ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Associated Types type AWSResponse ListChannelFlows # Methods request :: (Service -> Service) -> ListChannelFlows -> Request ListChannelFlows # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListChannelFlows -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListChannelFlows))) #
Generic ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Associated Types type Rep ListChannelFlows :: Type -> Type # Methods from :: ListChannelFlows -> Rep ListChannelFlows x # to :: Rep ListChannelFlows x -> ListChannelFlows #
Show ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods showsPrec :: Int -> ListChannelFlows -> ShowS # show :: ListChannelFlows -> String # showList :: [ListChannelFlows] -> ShowS #
NFData ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods rnf :: ListChannelFlows -> () #
Eq ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods (==) :: ListChannelFlows -> ListChannelFlows -> Bool # (/=) :: ListChannelFlows -> ListChannelFlows -> Bool #
Hashable ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods hashWithSalt :: Int -> ListChannelFlows -> Int # hash :: ListChannelFlows -> Int #
type AWSResponse ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows type AWSResponse ListChannelFlows = ListChannelFlowsResponse
type Rep ListChannelFlows Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows type Rep ListChannelFlows = D1 ('MetaData "ListChannelFlows" "Amazonka.ChimeSDKMessaging.ListChannelFlows" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "ListChannelFlows'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "appInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListChannelFlows Source #

Arguments

:: Text	`$sel:appInstanceArn:ListChannelFlows'`
-> ListChannelFlows

Create a value of ListChannelFlows 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:maxResults:ListChannelFlows', listChannelFlows_maxResults - The maximum number of channel flows that you want to return.

ListChannelFlows, listChannelFlows_nextToken - The token passed by previous API calls until all requested channel flows are returned.

$sel:appInstanceArn:ListChannelFlows', listChannelFlows_appInstanceArn - The ARN of the app instance.

Request Lenses

listChannelFlows_maxResults :: Lens' ListChannelFlows (Maybe Natural) Source #

The maximum number of channel flows that you want to return.

listChannelFlows_nextToken :: Lens' ListChannelFlows (Maybe Text) Source #

The token passed by previous API calls until all requested channel flows are returned.

listChannelFlows_appInstanceArn :: Lens' ListChannelFlows Text Source #

The ARN of the app instance.

Destructuring the Response

data ListChannelFlowsResponse Source #

See: newListChannelFlowsResponse smart constructor.

Constructors

ListChannelFlowsResponse'
Fields channelFlows :: Maybe [ChannelFlowSummary] The information about each channel flow. nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested channels are returned. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListChannelFlowsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Associated Types type Rep ListChannelFlowsResponse :: Type -> Type # Methods from :: ListChannelFlowsResponse -> Rep ListChannelFlowsResponse x # to :: Rep ListChannelFlowsResponse x -> ListChannelFlowsResponse #
Show ListChannelFlowsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods showsPrec :: Int -> ListChannelFlowsResponse -> ShowS # show :: ListChannelFlowsResponse -> String # showList :: [ListChannelFlowsResponse] -> ShowS #
NFData ListChannelFlowsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods rnf :: ListChannelFlowsResponse -> () #
Eq ListChannelFlowsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows Methods (==) :: ListChannelFlowsResponse -> ListChannelFlowsResponse -> Bool # (/=) :: ListChannelFlowsResponse -> ListChannelFlowsResponse -> Bool #
type Rep ListChannelFlowsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelFlows type Rep ListChannelFlowsResponse = D1 ('MetaData "ListChannelFlowsResponse" "Amazonka.ChimeSDKMessaging.ListChannelFlows" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "ListChannelFlowsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelFlows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChannelFlowSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListChannelFlowsResponse Source #

Arguments

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

Create a value of ListChannelFlowsResponse 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:channelFlows:ListChannelFlowsResponse', listChannelFlowsResponse_channelFlows - The information about each channel flow.

ListChannelFlows, listChannelFlowsResponse_nextToken - The token passed by previous API calls until all requested channels are returned.

$sel:httpStatus:ListChannelFlowsResponse', listChannelFlowsResponse_httpStatus - The response's http status code.

Response Lenses

listChannelFlowsResponse_channelFlows :: Lens' ListChannelFlowsResponse (Maybe [ChannelFlowSummary]) Source #

The information about each channel flow.

listChannelFlowsResponse_nextToken :: Lens' ListChannelFlowsResponse (Maybe Text) Source #

The token passed by previous API calls until all requested channels are returned.

listChannelFlowsResponse_httpStatus :: Lens' ListChannelFlowsResponse Int Source #

The response's http status code.