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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about the quick connects for the specified Amazon Connect instance.

This operation returns paginated results.

Synopsis

data ListQuickConnects = ListQuickConnects' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- quickConnectTypes :: Maybe [QuickConnectType]
- instanceId :: Text
}
newListQuickConnects :: Text -> ListQuickConnects
listQuickConnects_maxResults :: Lens' ListQuickConnects (Maybe Natural)
listQuickConnects_nextToken :: Lens' ListQuickConnects (Maybe Text)
listQuickConnects_quickConnectTypes :: Lens' ListQuickConnects (Maybe [QuickConnectType])
listQuickConnects_instanceId :: Lens' ListQuickConnects Text
data ListQuickConnectsResponse = ListQuickConnectsResponse' {
- nextToken :: Maybe Text
- quickConnectSummaryList :: Maybe [QuickConnectSummary]
- httpStatus :: Int
}
newListQuickConnectsResponse :: Int -> ListQuickConnectsResponse
listQuickConnectsResponse_nextToken :: Lens' ListQuickConnectsResponse (Maybe Text)
listQuickConnectsResponse_quickConnectSummaryList :: Lens' ListQuickConnectsResponse (Maybe [QuickConnectSummary])
listQuickConnectsResponse_httpStatus :: Lens' ListQuickConnectsResponse Int

Creating a Request

data ListQuickConnects Source #

See: newListQuickConnects smart constructor.

Constructors

ListQuickConnects'

Fields

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.
quickConnectTypes :: Maybe [QuickConnectType]
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

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

newListQuickConnects Source #

Arguments

:: Text	`ListQuickConnects`
-> ListQuickConnects

Create a value of ListQuickConnects 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:ListQuickConnects', listQuickConnects_maxResults - The maximum number of results to return per page. The default MaxResult size is 100.

ListQuickConnects, listQuickConnects_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.

$sel:quickConnectTypes:ListQuickConnects', listQuickConnects_quickConnectTypes - The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

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

Request Lenses

listQuickConnects_maxResults :: Lens' ListQuickConnects (Maybe Natural) Source #

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

listQuickConnects_nextToken :: Lens' ListQuickConnects (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.

listQuickConnects_quickConnectTypes :: Lens' ListQuickConnects (Maybe [QuickConnectType]) Source #

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

listQuickConnects_instanceId :: Lens' ListQuickConnects Text Source #

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

Destructuring the Response

data ListQuickConnectsResponse Source #

See: newListQuickConnectsResponse smart constructor.

Constructors

ListQuickConnectsResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. quickConnectSummaryList :: Maybe [QuickConnectSummary] Information about the quick connects. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListQuickConnectsResponse Source #

Arguments

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

Create a value of ListQuickConnectsResponse 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:

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

$sel:quickConnectSummaryList:ListQuickConnectsResponse', listQuickConnectsResponse_quickConnectSummaryList - Information about the quick connects.

$sel:httpStatus:ListQuickConnectsResponse', listQuickConnectsResponse_httpStatus - The response's http status code.

Response Lenses

listQuickConnectsResponse_nextToken :: Lens' ListQuickConnectsResponse (Maybe Text) Source #

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

listQuickConnectsResponse_quickConnectSummaryList :: Lens' ListQuickConnectsResponse (Maybe [QuickConnectSummary]) Source #

Information about the quick connects.

listQuickConnectsResponse_httpStatus :: Lens' ListQuickConnectsResponse Int Source #

The response's http status code.