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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creates an agent status for the specified Amazon Connect instance.

Synopsis

data CreateAgentStatus = CreateAgentStatus' {
- description :: Maybe Text
- displayOrder :: Maybe Natural
- tags :: Maybe (HashMap Text Text)
- instanceId :: Text
- name :: Text
- state :: AgentStatusState
}
newCreateAgentStatus :: Text -> Text -> AgentStatusState -> CreateAgentStatus
createAgentStatus_description :: Lens' CreateAgentStatus (Maybe Text)
createAgentStatus_displayOrder :: Lens' CreateAgentStatus (Maybe Natural)
createAgentStatus_tags :: Lens' CreateAgentStatus (Maybe (HashMap Text Text))
createAgentStatus_instanceId :: Lens' CreateAgentStatus Text
createAgentStatus_name :: Lens' CreateAgentStatus Text
createAgentStatus_state :: Lens' CreateAgentStatus AgentStatusState
data CreateAgentStatusResponse = CreateAgentStatusResponse' {
- agentStatusARN :: Maybe Text
- agentStatusId :: Maybe Text
- httpStatus :: Int
}
newCreateAgentStatusResponse :: Int -> CreateAgentStatusResponse
createAgentStatusResponse_agentStatusARN :: Lens' CreateAgentStatusResponse (Maybe Text)
createAgentStatusResponse_agentStatusId :: Lens' CreateAgentStatusResponse (Maybe Text)
createAgentStatusResponse_httpStatus :: Lens' CreateAgentStatusResponse Int

Creating a Request

data CreateAgentStatus Source #

See: newCreateAgentStatus smart constructor.

Constructors

CreateAgentStatus'

Fields

description :: Maybe Text
The description of the status.
displayOrder :: Maybe Natural
The display order of the status.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name :: Text
The name of the status.
state :: AgentStatusState
The state of the status.

Instances

Instances details

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

newCreateAgentStatus Source #

Arguments

:: Text	`CreateAgentStatus`
-> Text	`CreateAgentStatus`
-> AgentStatusState	`CreateAgentStatus`
-> CreateAgentStatus

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

CreateAgentStatus, createAgentStatus_description - The description of the status.

CreateAgentStatus, createAgentStatus_displayOrder - The display order of the status.

CreateAgentStatus, createAgentStatus_tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

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

CreateAgentStatus, createAgentStatus_name - The name of the status.

CreateAgentStatus, createAgentStatus_state - The state of the status.

Request Lenses

createAgentStatus_description :: Lens' CreateAgentStatus (Maybe Text) Source #

The description of the status.

createAgentStatus_displayOrder :: Lens' CreateAgentStatus (Maybe Natural) Source #

The display order of the status.

createAgentStatus_tags :: Lens' CreateAgentStatus (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

createAgentStatus_instanceId :: Lens' CreateAgentStatus Text Source #

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

createAgentStatus_name :: Lens' CreateAgentStatus Text Source #

The name of the status.

createAgentStatus_state :: Lens' CreateAgentStatus AgentStatusState Source #

The state of the status.

Destructuring the Response

data CreateAgentStatusResponse Source #

See: newCreateAgentStatusResponse smart constructor.

Constructors

CreateAgentStatusResponse'
Fields agentStatusARN :: Maybe Text The Amazon Resource Name (ARN) of the agent status. agentStatusId :: Maybe Text The identifier of the agent status. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateAgentStatusResponse Source #

Arguments

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

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

CreateAgentStatusResponse, createAgentStatusResponse_agentStatusARN - The Amazon Resource Name (ARN) of the agent status.

CreateAgentStatusResponse, createAgentStatusResponse_agentStatusId - The identifier of the agent status.

$sel:httpStatus:CreateAgentStatusResponse', createAgentStatusResponse_httpStatus - The response's http status code.

Response Lenses

createAgentStatusResponse_agentStatusARN :: Lens' CreateAgentStatusResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the agent status.

createAgentStatusResponse_agentStatusId :: Lens' CreateAgentStatusResponse (Maybe Text) Source #

The identifier of the agent status.

createAgentStatusResponse_httpStatus :: Lens' CreateAgentStatusResponse Int Source #

The response's http status code.