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.Connect.ListContactFlows

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about the flows for the specified Amazon Connect instance.

You can also create and update flows using the Amazon Connect Flow language.

For more information about flows, see Flows in the Amazon Connect Administrator Guide.

This operation returns paginated results.

Synopsis

data ListContactFlows = ListContactFlows' {
- contactFlowTypes :: Maybe [ContactFlowType]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- instanceId :: Text
}
newListContactFlows :: Text -> ListContactFlows
listContactFlows_contactFlowTypes :: Lens' ListContactFlows (Maybe [ContactFlowType])
listContactFlows_maxResults :: Lens' ListContactFlows (Maybe Natural)
listContactFlows_nextToken :: Lens' ListContactFlows (Maybe Text)
listContactFlows_instanceId :: Lens' ListContactFlows Text
data ListContactFlowsResponse = ListContactFlowsResponse' {
- contactFlowSummaryList :: Maybe [ContactFlowSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListContactFlowsResponse :: Int -> ListContactFlowsResponse
listContactFlowsResponse_contactFlowSummaryList :: Lens' ListContactFlowsResponse (Maybe [ContactFlowSummary])
listContactFlowsResponse_nextToken :: Lens' ListContactFlowsResponse (Maybe Text)
listContactFlowsResponse_httpStatus :: Lens' ListContactFlowsResponse Int

Creating a Request

data ListContactFlows Source #

See: newListContactFlows smart constructor.

Constructors

ListContactFlows'

Fields

contactFlowTypes :: Maybe [ContactFlowType]
The type of flow.
maxResults :: Maybe Natural
The maximum number of results to return per page. The default MaxResult size is 100.
nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

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

newListContactFlows Source #

Arguments

:: Text	`ListContactFlows`
-> ListContactFlows

Create a value of ListContactFlows 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:contactFlowTypes:ListContactFlows', listContactFlows_contactFlowTypes - The type of flow.

$sel:maxResults:ListContactFlows', listContactFlows_maxResults - The maximum number of results to return per page. The default MaxResult size is 100.

ListContactFlows, listContactFlows_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ListContactFlows, listContactFlows_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

listContactFlows_contactFlowTypes :: Lens' ListContactFlows (Maybe [ContactFlowType]) Source #

The type of flow.

listContactFlows_maxResults :: Lens' ListContactFlows (Maybe Natural) Source #

The maximum number of results to return per page. The default MaxResult size is 100.

listContactFlows_nextToken :: Lens' ListContactFlows (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listContactFlows_instanceId :: Lens' ListContactFlows Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data ListContactFlowsResponse Source #

See: newListContactFlowsResponse smart constructor.

Constructors

ListContactFlowsResponse'
Fields contactFlowSummaryList :: Maybe [ContactFlowSummary] Information about the flows. nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListContactFlowsResponse Source #
Instance details Defined in Amazonka.Connect.ListContactFlows Associated Types type Rep ListContactFlowsResponse :: Type -> Type # Methods from :: ListContactFlowsResponse -> Rep ListContactFlowsResponse x # to :: Rep ListContactFlowsResponse x -> ListContactFlowsResponse #
Read ListContactFlowsResponse Source #
Instance details Defined in Amazonka.Connect.ListContactFlows Methods readsPrec :: Int -> ReadS ListContactFlowsResponse # readList :: ReadS [ListContactFlowsResponse] # readPrec :: ReadPrec ListContactFlowsResponse # readListPrec :: ReadPrec [ListContactFlowsResponse] #
Show ListContactFlowsResponse Source #
Instance details Defined in Amazonka.Connect.ListContactFlows Methods showsPrec :: Int -> ListContactFlowsResponse -> ShowS # show :: ListContactFlowsResponse -> String # showList :: [ListContactFlowsResponse] -> ShowS #
NFData ListContactFlowsResponse Source #
Instance details Defined in Amazonka.Connect.ListContactFlows Methods rnf :: ListContactFlowsResponse -> () #
Eq ListContactFlowsResponse Source #
Instance details Defined in Amazonka.Connect.ListContactFlows Methods (==) :: ListContactFlowsResponse -> ListContactFlowsResponse -> Bool # (/=) :: ListContactFlowsResponse -> ListContactFlowsResponse -> Bool #
type Rep ListContactFlowsResponse Source #
Instance details Defined in Amazonka.Connect.ListContactFlows type Rep ListContactFlowsResponse = D1 ('MetaData "ListContactFlowsResponse" "Amazonka.Connect.ListContactFlows" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListContactFlowsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contactFlowSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContactFlowSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListContactFlowsResponse Source #

Arguments

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

Create a value of ListContactFlowsResponse 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:contactFlowSummaryList:ListContactFlowsResponse', listContactFlowsResponse_contactFlowSummaryList - Information about the flows.

ListContactFlows, listContactFlowsResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:httpStatus:ListContactFlowsResponse', listContactFlowsResponse_httpStatus - The response's http status code.

Response Lenses

listContactFlowsResponse_contactFlowSummaryList :: Lens' ListContactFlowsResponse (Maybe [ContactFlowSummary]) Source #

Information about the flows.

listContactFlowsResponse_nextToken :: Lens' ListContactFlowsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listContactFlowsResponse_httpStatus :: Lens' ListContactFlowsResponse Int Source #

The response's http status code.