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
|
// 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"
)
// Enables rehydration of chats for the lifespan of a contact. For more
// information about chat rehydration, see Enable persistent chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html)
// in the Amazon Connect Administrator Guide.
func (c *Client) CreatePersistentContactAssociation(ctx context.Context, params *CreatePersistentContactAssociationInput, optFns ...func(*Options)) (*CreatePersistentContactAssociationOutput, error) {
if params == nil {
params = &CreatePersistentContactAssociationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreatePersistentContactAssociation", params, optFns, c.addOperationCreatePersistentContactAssociationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreatePersistentContactAssociationOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreatePersistentContactAssociationInput struct {
// This is the contactId of the current contact that the
// CreatePersistentContactAssociation API is being called from.
//
// This member is required.
InitialContactId *string
// 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 contactId chosen for rehydration depends on the type chosen.
// - ENTIRE_PAST_SESSION : Rehydrates a chat from the most recently terminated
// past chat contact of the specified past ended chat session. To use this type,
// provide the initialContactId of the past ended chat session in the
// sourceContactId field. In this type, Amazon Connect determines what the most
// recent chat contact on the past ended chat session and uses it to start a
// persistent chat.
// - FROM_SEGMENT : Rehydrates a chat from the specified past chat contact
// provided in the sourceContactId field.
// The actual contactId used for rehydration is provided in the response of this
// API. To illustrate how to use rehydration type, consider the following example:
// A customer starts a chat session. Agent a1 accepts the chat and a conversation
// starts between the customer and Agent a1. This first contact creates a contact
// ID C1. Agent a1 then transfers the chat to Agent a2. This creates another
// contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded
// to the disconnect flow for a post chat survey that creates another contact ID
// C3. After the chat survey, the chat session ends. Later, the customer returns
// and wants to resume their past chat session. At this point, the customer can
// have following use cases:
// - Use Case 1: The customer wants to continue the past chat session but they
// want to hide the post chat survey. For this they will use the following
// configuration:
// - Configuration
// - SourceContactId = "C2"
// - RehydrationType = "FROM_SEGMENT"
// - Expected behavior
// - This starts a persistent chat session from the specified past ended contact
// (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current
// persistent chat session. Note that chat segment C3 is dropped from the
// persistent chat session.
// - Use Case 2: The customer wants to continue the past chat session and see
// the transcript of the entire past engagement, including the post chat survey.
// For this they will use the following configuration:
// - Configuration
// - SourceContactId = "C1"
// - RehydrationType = "ENTIRE_PAST_SESSION"
// - Expected behavior
// - This starts a persistent chat session from the most recently ended chat
// contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in
// the current persistent chat session.
//
// This member is required.
RehydrationType types.RehydrationType
// The contactId from which a persistent chat session must be started.
//
// This member is required.
SourceContactId *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
noSmithyDocumentSerde
}
type CreatePersistentContactAssociationOutput struct {
// The contactId from which a persistent chat session is started. This field is
// populated only for persistent chat.
ContinuedFromContactId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreatePersistentContactAssociationMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreatePersistentContactAssociation{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreatePersistentContactAssociation{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreatePersistentContactAssociation"); 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 = addOpCreatePersistentContactAssociationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreatePersistentContactAssociation(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
}
func newServiceMetadataMiddleware_opCreatePersistentContactAssociation(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreatePersistentContactAssociation",
}
}
|