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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the real-time active user data from the specified Amazon Connect instance.

Synopsis

data GetCurrentUserData = GetCurrentUserData' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- instanceId :: Text
- filters :: UserDataFilters
}
newGetCurrentUserData :: Text -> UserDataFilters -> GetCurrentUserData
getCurrentUserData_maxResults :: Lens' GetCurrentUserData (Maybe Natural)
getCurrentUserData_nextToken :: Lens' GetCurrentUserData (Maybe Text)
getCurrentUserData_instanceId :: Lens' GetCurrentUserData Text
getCurrentUserData_filters :: Lens' GetCurrentUserData UserDataFilters
data GetCurrentUserDataResponse = GetCurrentUserDataResponse' {
- approximateTotalCount :: Maybe Integer
- nextToken :: Maybe Text
- userDataList :: Maybe [UserData]
- httpStatus :: Int
}
newGetCurrentUserDataResponse :: Int -> GetCurrentUserDataResponse
getCurrentUserDataResponse_approximateTotalCount :: Lens' GetCurrentUserDataResponse (Maybe Integer)
getCurrentUserDataResponse_nextToken :: Lens' GetCurrentUserDataResponse (Maybe Text)
getCurrentUserDataResponse_userDataList :: Lens' GetCurrentUserDataResponse (Maybe [UserData])
getCurrentUserDataResponse_httpStatus :: Lens' GetCurrentUserDataResponse Int

Creating a Request

data GetCurrentUserData Source #

See: newGetCurrentUserData smart constructor.

Constructors

GetCurrentUserData'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page.
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.
filters :: UserDataFilters
The filters to apply to returned user data. You can filter up to the following limits:
- Queues: 100
- Routing profiles: 100
- Agents: 100
- Contact states: 9
- User hierarchy groups: 1
The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
Currently tagging is only supported on the resources that are passed in the filter.

Instances

Instances details

ToJSON GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Methods toJSON :: GetCurrentUserData -> Value # toEncoding :: GetCurrentUserData -> Encoding # toJSONList :: [GetCurrentUserData] -> Value # toEncodingList :: [GetCurrentUserData] -> Encoding #
ToHeaders GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Methods toHeaders :: GetCurrentUserData -> [Header] #
ToPath GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Methods toPath :: GetCurrentUserData -> ByteString #
ToQuery GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Methods toQuery :: GetCurrentUserData -> QueryString #
AWSRequest GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Associated Types type AWSResponse GetCurrentUserData # Methods request :: (Service -> Service) -> GetCurrentUserData -> Request GetCurrentUserData # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetCurrentUserData -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCurrentUserData))) #
Generic GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Associated Types type Rep GetCurrentUserData :: Type -> Type # Methods from :: GetCurrentUserData -> Rep GetCurrentUserData x # to :: Rep GetCurrentUserData x -> GetCurrentUserData #
Read GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Methods readsPrec :: Int -> ReadS GetCurrentUserData # readList :: ReadS [GetCurrentUserData] # readPrec :: ReadPrec GetCurrentUserData # readListPrec :: ReadPrec [GetCurrentUserData] #
Show GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Methods showsPrec :: Int -> GetCurrentUserData -> ShowS # show :: GetCurrentUserData -> String # showList :: [GetCurrentUserData] -> ShowS #
NFData GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Methods rnf :: GetCurrentUserData -> () #
Eq GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Methods (==) :: GetCurrentUserData -> GetCurrentUserData -> Bool # (/=) :: GetCurrentUserData -> GetCurrentUserData -> Bool #
Hashable GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData Methods hashWithSalt :: Int -> GetCurrentUserData -> Int # hash :: GetCurrentUserData -> Int #
type AWSResponse GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData type AWSResponse GetCurrentUserData = GetCurrentUserDataResponse
type Rep GetCurrentUserData Source #
Instance details Defined in Amazonka.Connect.GetCurrentUserData type Rep GetCurrentUserData = D1 ('MetaData "GetCurrentUserData" "Amazonka.Connect.GetCurrentUserData" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "GetCurrentUserData'" '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 "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserDataFilters))))

newGetCurrentUserData Source #

Arguments

:: Text	`GetCurrentUserData`
-> UserDataFilters	`$sel:filters:GetCurrentUserData'`
-> GetCurrentUserData

Create a value of GetCurrentUserData 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:GetCurrentUserData', getCurrentUserData_maxResults - The maximum number of results to return per page.

GetCurrentUserData, getCurrentUserData_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.

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

$sel:filters:GetCurrentUserData', getCurrentUserData_filters - The filters to apply to returned user data. You can filter up to the following limits:

Queues: 100
Routing profiles: 100
Agents: 100
Contact states: 9
User hierarchy groups: 1

The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

Currently tagging is only supported on the resources that are passed in the filter.

Request Lenses

getCurrentUserData_maxResults :: Lens' GetCurrentUserData (Maybe Natural) Source #

The maximum number of results to return per page.

getCurrentUserData_nextToken :: Lens' GetCurrentUserData (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.

getCurrentUserData_instanceId :: Lens' GetCurrentUserData Text Source #

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

getCurrentUserData_filters :: Lens' GetCurrentUserData UserDataFilters Source #

The filters to apply to returned user data. You can filter up to the following limits:

Queues: 100
Routing profiles: 100
Agents: 100
Contact states: 9
User hierarchy groups: 1

The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

Currently tagging is only supported on the resources that are passed in the filter.

Destructuring the Response

data GetCurrentUserDataResponse Source #

See: newGetCurrentUserDataResponse smart constructor.

Constructors

GetCurrentUserDataResponse'
Fields approximateTotalCount :: Maybe Integer The total count of the result, regardless of the current page size. nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. userDataList :: Maybe [UserData] A list of the user data that is returned. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetCurrentUserDataResponse Source #

Arguments

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

Create a value of GetCurrentUserDataResponse 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:approximateTotalCount:GetCurrentUserDataResponse', getCurrentUserDataResponse_approximateTotalCount - The total count of the result, regardless of the current page size.

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

$sel:userDataList:GetCurrentUserDataResponse', getCurrentUserDataResponse_userDataList - A list of the user data that is returned.

$sel:httpStatus:GetCurrentUserDataResponse', getCurrentUserDataResponse_httpStatus - The response's http status code.

Response Lenses

getCurrentUserDataResponse_approximateTotalCount :: Lens' GetCurrentUserDataResponse (Maybe Integer) Source #

The total count of the result, regardless of the current page size.

getCurrentUserDataResponse_nextToken :: Lens' GetCurrentUserDataResponse (Maybe Text) Source #

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

getCurrentUserDataResponse_userDataList :: Lens' GetCurrentUserDataResponse (Maybe [UserData]) Source #

A list of the user data that is returned.

getCurrentUserDataResponse_httpStatus :: Lens' GetCurrentUserDataResponse Int Source #

The response's http status code.