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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Initiates a flow to start a new task.

Synopsis

data StartTaskContact = StartTaskContact' {
- attributes :: Maybe (HashMap Text Text)
- clientToken :: Maybe Text
- contactFlowId :: Maybe Text
- description :: Maybe Text
- previousContactId :: Maybe Text
- quickConnectId :: Maybe Text
- references :: Maybe (HashMap Text Reference)
- scheduledTime :: Maybe POSIX
- taskTemplateId :: Maybe Text
- instanceId :: Text
- name :: Text
}
newStartTaskContact :: Text -> Text -> StartTaskContact
startTaskContact_attributes :: Lens' StartTaskContact (Maybe (HashMap Text Text))
startTaskContact_clientToken :: Lens' StartTaskContact (Maybe Text)
startTaskContact_contactFlowId :: Lens' StartTaskContact (Maybe Text)
startTaskContact_description :: Lens' StartTaskContact (Maybe Text)
startTaskContact_previousContactId :: Lens' StartTaskContact (Maybe Text)
startTaskContact_quickConnectId :: Lens' StartTaskContact (Maybe Text)
startTaskContact_references :: Lens' StartTaskContact (Maybe (HashMap Text Reference))
startTaskContact_scheduledTime :: Lens' StartTaskContact (Maybe UTCTime)
startTaskContact_taskTemplateId :: Lens' StartTaskContact (Maybe Text)
startTaskContact_instanceId :: Lens' StartTaskContact Text
startTaskContact_name :: Lens' StartTaskContact Text
data StartTaskContactResponse = StartTaskContactResponse' {
- contactId :: Maybe Text
- httpStatus :: Int
}
newStartTaskContactResponse :: Int -> StartTaskContactResponse
startTaskContactResponse_contactId :: Lens' StartTaskContactResponse (Maybe Text)
startTaskContactResponse_httpStatus :: Lens' StartTaskContactResponse Int

Creating a Request

data StartTaskContact Source #

See: newStartTaskContact smart constructor.

Constructors

StartTaskContact'

Fields

attributes :: Maybe (HashMap Text Text)
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
contactFlowId :: Maybe Text
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose __Show additional flow information__. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
description :: Maybe Text
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
previousContactId :: Maybe Text
The identifier of the previous chat, voice, or task contact.
quickConnectId :: Maybe Text
The identifier for the quick connect.
references :: Maybe (HashMap Text Reference)
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
scheduledTime :: Maybe POSIX
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
taskTemplateId :: Maybe Text
A unique identifier for the task template.
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 a task that is shown to an agent in the Contact Control Panel (CCP).

Instances

Instances details

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

newStartTaskContact Source #

Arguments

:: Text	`StartTaskContact`
-> Text	`StartTaskContact`
-> StartTaskContact

Create a value of StartTaskContact 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:attributes:StartTaskContact', startTaskContact_attributes - A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

$sel:clientToken:StartTaskContact', startTaskContact_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

StartTaskContact, startTaskContact_contactFlowId - The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose __Show additional flow information__. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

StartTaskContact, startTaskContact_description - A description of the task that is shown to an agent in the Contact Control Panel (CCP).

StartTaskContact, startTaskContact_previousContactId - The identifier of the previous chat, voice, or task contact.

StartTaskContact, startTaskContact_quickConnectId - The identifier for the quick connect.

StartTaskContact, startTaskContact_references - A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

$sel:scheduledTime:StartTaskContact', startTaskContact_scheduledTime - The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

$sel:taskTemplateId:StartTaskContact', startTaskContact_taskTemplateId - A unique identifier for the task template.

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

StartTaskContact, startTaskContact_name - The name of a task that is shown to an agent in the Contact Control Panel (CCP).

Request Lenses

startTaskContact_attributes :: Lens' StartTaskContact (Maybe (HashMap Text Text)) Source #

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

startTaskContact_clientToken :: Lens' StartTaskContact (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

startTaskContact_contactFlowId :: Lens' StartTaskContact (Maybe Text) Source #

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose __Show additional flow information__. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

startTaskContact_description :: Lens' StartTaskContact (Maybe Text) Source #

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

startTaskContact_previousContactId :: Lens' StartTaskContact (Maybe Text) Source #

The identifier of the previous chat, voice, or task contact.

startTaskContact_quickConnectId :: Lens' StartTaskContact (Maybe Text) Source #

The identifier for the quick connect.

startTaskContact_references :: Lens' StartTaskContact (Maybe (HashMap Text Reference)) Source #

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

startTaskContact_scheduledTime :: Lens' StartTaskContact (Maybe UTCTime) Source #

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

startTaskContact_taskTemplateId :: Lens' StartTaskContact (Maybe Text) Source #

A unique identifier for the task template.

startTaskContact_instanceId :: Lens' StartTaskContact Text Source #

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

startTaskContact_name :: Lens' StartTaskContact Text Source #

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

Destructuring the Response

data StartTaskContactResponse Source #

See: newStartTaskContactResponse smart constructor.

Constructors

StartTaskContactResponse'
Fields contactId :: Maybe Text The identifier of this contact within the Amazon Connect instance. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartTaskContactResponse Source #

Arguments

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

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

StartTaskContactResponse, startTaskContactResponse_contactId - The identifier of this contact within the Amazon Connect instance.

$sel:httpStatus:StartTaskContactResponse', startTaskContactResponse_httpStatus - The response's http status code.

Response Lenses

startTaskContactResponse_contactId :: Lens' StartTaskContactResponse (Maybe Text) Source #

The identifier of this contact within the Amazon Connect instance.

startTaskContactResponse_httpStatus :: Lens' StartTaskContactResponse Int Source #

The response's http status code.