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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

This API is in preview release for Amazon Connect and is subject to change.

Updates agent status.

Synopsis

data UpdateAgentStatus = UpdateAgentStatus' {
- description :: Maybe Text
- displayOrder :: Maybe Natural
- name :: Maybe Text
- resetOrderNumber :: Maybe Bool
- state :: Maybe AgentStatusState
- instanceId :: Text
- agentStatusId :: Text
}
newUpdateAgentStatus :: Text -> Text -> UpdateAgentStatus
updateAgentStatus_description :: Lens' UpdateAgentStatus (Maybe Text)
updateAgentStatus_displayOrder :: Lens' UpdateAgentStatus (Maybe Natural)
updateAgentStatus_name :: Lens' UpdateAgentStatus (Maybe Text)
updateAgentStatus_resetOrderNumber :: Lens' UpdateAgentStatus (Maybe Bool)
updateAgentStatus_state :: Lens' UpdateAgentStatus (Maybe AgentStatusState)
updateAgentStatus_instanceId :: Lens' UpdateAgentStatus Text
updateAgentStatus_agentStatusId :: Lens' UpdateAgentStatus Text
data UpdateAgentStatusResponse = UpdateAgentStatusResponse' {
}
newUpdateAgentStatusResponse :: UpdateAgentStatusResponse

Creating a Request

data UpdateAgentStatus Source #

See: newUpdateAgentStatus smart constructor.

Constructors

UpdateAgentStatus'

Fields

description :: Maybe Text
The description of the agent status.
displayOrder :: Maybe Natural
The display order of the agent status.
name :: Maybe Text
The name of the agent status.
resetOrderNumber :: Maybe Bool
A number indicating the reset order of the agent status.
state :: Maybe AgentStatusState
The state of the agent status.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
agentStatusId :: Text
The identifier of the agent status.

Instances

Instances details

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

newUpdateAgentStatus Source #

Arguments

:: Text	`UpdateAgentStatus`
-> Text	`UpdateAgentStatus`
-> UpdateAgentStatus

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

UpdateAgentStatus, updateAgentStatus_description - The description of the agent status.

UpdateAgentStatus, updateAgentStatus_displayOrder - The display order of the agent status.

UpdateAgentStatus, updateAgentStatus_name - The name of the agent status.

$sel:resetOrderNumber:UpdateAgentStatus', updateAgentStatus_resetOrderNumber - A number indicating the reset order of the agent status.

UpdateAgentStatus, updateAgentStatus_state - The state of the agent status.

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

UpdateAgentStatus, updateAgentStatus_agentStatusId - The identifier of the agent status.

Request Lenses

updateAgentStatus_description :: Lens' UpdateAgentStatus (Maybe Text) Source #

The description of the agent status.

updateAgentStatus_displayOrder :: Lens' UpdateAgentStatus (Maybe Natural) Source #

The display order of the agent status.

updateAgentStatus_name :: Lens' UpdateAgentStatus (Maybe Text) Source #

The name of the agent status.

updateAgentStatus_resetOrderNumber :: Lens' UpdateAgentStatus (Maybe Bool) Source #

A number indicating the reset order of the agent status.

updateAgentStatus_state :: Lens' UpdateAgentStatus (Maybe AgentStatusState) Source #

The state of the agent status.

updateAgentStatus_instanceId :: Lens' UpdateAgentStatus Text Source #

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

updateAgentStatus_agentStatusId :: Lens' UpdateAgentStatus Text Source #

The identifier of the agent status.

Destructuring the Response

data UpdateAgentStatusResponse Source #

See: newUpdateAgentStatusResponse smart constructor.

Constructors

UpdateAgentStatusResponse'

Instances

Instances details

Generic UpdateAgentStatusResponse Source #
Instance details Defined in Amazonka.Connect.UpdateAgentStatus Associated Types type Rep UpdateAgentStatusResponse :: Type -> Type # Methods from :: UpdateAgentStatusResponse -> Rep UpdateAgentStatusResponse x # to :: Rep UpdateAgentStatusResponse x -> UpdateAgentStatusResponse #
Read UpdateAgentStatusResponse Source #
Instance details Defined in Amazonka.Connect.UpdateAgentStatus Methods readsPrec :: Int -> ReadS UpdateAgentStatusResponse # readList :: ReadS [UpdateAgentStatusResponse] # readPrec :: ReadPrec UpdateAgentStatusResponse # readListPrec :: ReadPrec [UpdateAgentStatusResponse] #
Show UpdateAgentStatusResponse Source #
Instance details Defined in Amazonka.Connect.UpdateAgentStatus Methods showsPrec :: Int -> UpdateAgentStatusResponse -> ShowS # show :: UpdateAgentStatusResponse -> String # showList :: [UpdateAgentStatusResponse] -> ShowS #
NFData UpdateAgentStatusResponse Source #
Instance details Defined in Amazonka.Connect.UpdateAgentStatus Methods rnf :: UpdateAgentStatusResponse -> () #
Eq UpdateAgentStatusResponse Source #
Instance details Defined in Amazonka.Connect.UpdateAgentStatus Methods (==) :: UpdateAgentStatusResponse -> UpdateAgentStatusResponse -> Bool # (/=) :: UpdateAgentStatusResponse -> UpdateAgentStatusResponse -> Bool #
type Rep UpdateAgentStatusResponse Source #
Instance details Defined in Amazonka.Connect.UpdateAgentStatus type Rep UpdateAgentStatusResponse = D1 ('MetaData "UpdateAgentStatusResponse" "Amazonka.Connect.UpdateAgentStatus" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UpdateAgentStatusResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateAgentStatusResponse :: UpdateAgentStatusResponse Source #

Create a value of UpdateAgentStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.