1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package connect
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Initiates a flow to start a new task contact. For more information about task
// contacts, see Concepts: Tasks in Amazon Connect (https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html)
// in the Amazon Connect Administrator Guide. When using PreviousContactId and
// RelatedContactId input parameters, note the following:
// - PreviousContactId
// - Any updates to user-defined task contact attributes on any contact linked
// through the same PreviousContactId will affect every contact in the chain.
// - There can be a maximum of 12 linked task contacts in a chain. That is, 12
// task contacts can be created that share the same PreviousContactId .
// - RelatedContactId
// - Copies contact attributes from the related task contact to the new contact.
// - Any update on attributes in a new task contact does not update attributes
// on previous contact.
// - There’s no limit on the number of task contacts that can be created that
// use the same RelatedContactId .
//
// In addition, when calling StartTaskContact include only one of these
// parameters: ContactFlowID , QuickConnectID , or TaskTemplateID . Only one
// parameter is required as long as the task template has a flow configured to run
// it. If more than one parameter is specified, or only the TaskTemplateID is
// specified but it does not have a flow configured, the request returns an error
// because Amazon Connect cannot identify the unique flow to run when the task is
// created. A ServiceQuotaExceededException occurs when the number of open tasks
// exceeds the active tasks quota or there are already 12 tasks referencing the
// same PreviousContactId . For more information about service quotas for task
// contacts, see Amazon Connect service quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html)
// in the Amazon Connect Administrator Guide.
func (c *Client) StartTaskContact(ctx context.Context, params *StartTaskContactInput, optFns ...func(*Options)) (*StartTaskContactOutput, error) {
if params == nil {
params = &StartTaskContactInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartTaskContact", params, optFns, c.addOperationStartTaskContactMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartTaskContactOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartTaskContactInput struct {
// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
// in the Amazon Resource Name (ARN) of the instance.
//
// This member is required.
InstanceId *string
// The name of a task that is shown to an agent in the Contact Control Panel (CCP).
//
// This member is required.
Name *string
// 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.
Attributes map[string]string
// 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 (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
// .
ClientToken *string
// 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
ContactFlowId *string
// A description of the task that is shown to an agent in the Contact Control
// Panel (CCP).
Description *string
// 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.
PreviousContactId *string
// 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 (https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html)
// .
QuickConnectId *string
// 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.
References map[string]types.Reference
// The contactId that is related (https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks)
// to this contact. Linking tasks together by using RelatedContactID copies over
// contact attributes from the related task contact to the new task contact. All
// updates to user-defined attributes in the new task contact are limited to the
// individual contact ID, unlike what happens when tasks are linked by using
// PreviousContactID . There are no limits to the number of contacts that can be
// linked by using RelatedContactId .
RelatedContactId *string
// 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.
ScheduledTime *time.Time
// A unique identifier for the task template. For more information about task
// templates, see Create task templates (https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html)
// in the Amazon Connect Administrator Guide.
TaskTemplateId *string
noSmithyDocumentSerde
}
type StartTaskContactOutput struct {
// The identifier of this contact within the Amazon Connect instance.
ContactId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartTaskContactMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpStartTaskContact{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpStartTaskContact{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "StartTaskContact"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addIdempotencyToken_opStartTaskContactMiddleware(stack, options); err != nil {
return err
}
if err = addOpStartTaskContactValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartTaskContact(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
type idempotencyToken_initializeOpStartTaskContact struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpStartTaskContact) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpStartTaskContact) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*StartTaskContactInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *StartTaskContactInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opStartTaskContactMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpStartTaskContact{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opStartTaskContact(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "StartTaskContact",
}
}
|