Interface StartTaskContactRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,ConnectRequest.Builder
,CopyableBuilder<StartTaskContactRequest.Builder,
,StartTaskContactRequest> SdkBuilder<StartTaskContactRequest.Builder,
,StartTaskContactRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartTaskContactRequest
-
Method Summary
Modifier and TypeMethodDescriptionattributes
(Map<String, String> attributes) A custom key-value pair using an attribute map.clientToken
(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.contactFlowId
(String contactFlowId) The identifier of the flow for initiating the tasks.description
(String description) A description of the task that is shown to an agent in the Contact Control Panel (CCP).instanceId
(String instanceId) The identifier of the Amazon Connect instance.The name of a task that is shown to an agent in the Contact Control Panel (CCP).overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.previousContactId
(String previousContactId) The identifier of the previous chat, voice, or task contact.quickConnectId
(String quickConnectId) The identifier for the quick connect.references
(Map<String, Reference> references) A formatted URL that is shown to an agent in the Contact Control Panel (CCP).relatedContactId
(String relatedContactId) The contactId that is related to this contact.scheduledTime
(Instant scheduledTime) The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow.taskTemplateId
(String taskTemplateId) A unique identifier for the task template.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Parameters:
instanceId
- The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
previousContactId
The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same
PreviousContactID
will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.- Parameters:
previousContactId
- The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the samePreviousContactID
will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contactFlowId
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, 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
- Parameters:
contactFlowId
- The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, 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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
- Parameters:
name
- The name of a task that is shown to an agent in the Contact Control Panel (CCP).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
references
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation:
URL
|NUMBER
|STRING
|DATE
|EMAIL
.ATTACHMENT
is not a supported reference type during task creation.- Parameters:
references
- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation:URL
|NUMBER
|STRING
|DATE
|EMAIL
.ATTACHMENT
is not a supported reference type during task creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
- Parameters:
description
- A description of the task that is shown to an agent in the Contact Control Panel (CCP).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskTemplateId
A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
- Parameters:
taskTemplateId
- A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
quickConnectId
The identifier for the quick connect. Tasks that are created by using
QuickConnectId
will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.- Parameters:
quickConnectId
- The identifier for the quick connect. Tasks that are created by usingQuickConnectId
will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
StartTaskContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartTaskContactRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-