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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.

For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.

Synopsis

Creating a Request

data PutUserStatus Source #

See: newPutUserStatus smart constructor.

Constructors

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

newPutUserStatus Source #

Arguments

:: Text	`PutUserStatus`
-> Text	`PutUserStatus`
-> Text	`PutUserStatus`
-> PutUserStatus

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

PutUserStatus, putUserStatus_userId - The identifier of the user.

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

PutUserStatus, putUserStatus_agentStatusId - The identifier of the agent status.

Request Lenses

putUserStatus_userId :: Lens' PutUserStatus Text Source #

The identifier of the user.

putUserStatus_instanceId :: Lens' PutUserStatus Text Source #

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

putUserStatus_agentStatusId :: Lens' PutUserStatus Text Source #

The identifier of the agent status.

Destructuring the Response

data PutUserStatusResponse Source #

See: newPutUserStatusResponse smart constructor.

Constructors

PutUserStatusResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newPutUserStatusResponse Source #

Arguments

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

Create a value of PutUserStatusResponse 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:httpStatus:PutUserStatusResponse', putUserStatusResponse_httpStatus - The response's http status code.

Response Lenses

putUserStatusResponse_httpStatus :: Lens' PutUserStatusResponse Int Source #

The response's http status code.