Skip to content

Commit 22dec27

Browse files
author
AWS
committed
Amazon Connect Service Update: This release adds support for the UpdateParticipantAuthentication API used for customer authentication within Amazon Connect chats.
1 parent d896468 commit 22dec27

File tree

2 files changed

+104
-5
lines changed

2 files changed

+104
-5
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Connect Service",
4+
"contributor": "",
5+
"description": "This release adds support for the UpdateParticipantAuthentication API used for customer authentication within Amazon Connect chats."
6+
}

services/connect/src/main/resources/codegen-resources/service-2.json

Lines changed: 98 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -701,7 +701,7 @@
701701
{"shape":"AccessDeniedException"},
702702
{"shape":"ServiceQuotaExceededException"}
703703
],
704-
"documentation":"<p>Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-up-push-notifications-for-mobile-chat.html\">Set up push notifications in Amazon Connect for mobile chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
704+
"documentation":"<p>Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/enable-push-notifications-for-mobile-chat.html\">Set up push notifications in Amazon Connect for mobile chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
705705
},
706706
"CreateQueue":{
707707
"name":"CreateQueue",
@@ -2420,7 +2420,7 @@
24202420
{"shape":"InvalidRequestException"},
24212421
{"shape":"ThrottlingException"}
24222422
],
2423-
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.</p>"
2423+
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.</p>"
24242424
},
24252425
"ListContactEvaluations":{
24262426
"name":"ListContactEvaluations",
@@ -4304,6 +4304,24 @@
43044304
],
43054305
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates an existing configuration for a resource type. This API is idempotent.</p>"
43064306
},
4307+
"UpdateParticipantAuthentication":{
4308+
"name":"UpdateParticipantAuthentication",
4309+
"http":{
4310+
"method":"POST",
4311+
"requestUri":"/contact/update-participant-authentication"
4312+
},
4313+
"input":{"shape":"UpdateParticipantAuthenticationRequest"},
4314+
"output":{"shape":"UpdateParticipantAuthenticationResponse"},
4315+
"errors":[
4316+
{"shape":"InvalidRequestException"},
4317+
{"shape":"InvalidParameterException"},
4318+
{"shape":"ConflictException"},
4319+
{"shape":"InternalServiceException"},
4320+
{"shape":"ThrottlingException"},
4321+
{"shape":"AccessDeniedException"}
4322+
],
4323+
"documentation":"<p>Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents:</p> <ul> <li> <p> <b>If a code is provided</b>: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles.</p> </li> <li> <p> <b>If an error is provided</b>: The error branch of the Authenticate Customer block is executed.</p> </li> </ul> <note> <p>The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.</p> </note>"
4324+
},
43074325
"UpdateParticipantRoleConfig":{
43084326
"name":"UpdateParticipantRoleConfig",
43094327
"http":{
@@ -6108,6 +6126,20 @@
61086126
"documentation":"<p>Contains information for score and potential quality issues for Audio</p>"
61096127
},
61106128
"AudioQualityScore":{"type":"float"},
6129+
"AuthenticationError":{
6130+
"type":"string",
6131+
"max":2048,
6132+
"min":1,
6133+
"pattern":"^[\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]*$",
6134+
"sensitive":true
6135+
},
6136+
"AuthenticationErrorDescription":{
6137+
"type":"string",
6138+
"max":2048,
6139+
"min":1,
6140+
"pattern":"^[\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]*$",
6141+
"sensitive":true
6142+
},
61116143
"AuthenticationProfile":{
61126144
"type":"structure",
61136145
"members":{
@@ -6211,6 +6243,12 @@
62116243
"type":"list",
62126244
"member":{"shape":"AuthenticationProfileSummary"}
62136245
},
6246+
"AuthorizationCode":{
6247+
"type":"string",
6248+
"max":2048,
6249+
"min":1,
6250+
"sensitive":true
6251+
},
62146252
"AutoAccept":{"type":"boolean"},
62156253
"AvailableNumberSummary":{
62166254
"type":"structure",
@@ -6880,6 +6918,10 @@
68806918
"shape":"WisdomInfo",
68816919
"documentation":"<p>Information about Amazon Connect Wisdom.</p>"
68826920
},
6921+
"CustomerId":{
6922+
"shape":"CustomerId",
6923+
"documentation":"<p>The customer's identification number. For example, the <code>CustomerId</code> may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the <code>CustomerSpeakerId</code> of the caller.</p>"
6924+
},
68836925
"CustomerEndpoint":{
68846926
"shape":"EndpointInfo",
68856927
"documentation":"<p>The customer or external third party participant endpoint.</p>"
@@ -9287,6 +9329,17 @@
92879329
},
92889330
"documentation":"<p>Information about the Customer on the contact.</p>"
92899331
},
9332+
"CustomerId":{
9333+
"type":"string",
9334+
"max":128,
9335+
"min":0
9336+
},
9337+
"CustomerIdNonEmpty":{
9338+
"type":"string",
9339+
"max":128,
9340+
"min":1,
9341+
"sensitive":true
9342+
},
92909343
"CustomerProfileAttributesSerialized":{"type":"string"},
92919344
"CustomerQualityMetrics":{
92929345
"type":"structure",
@@ -14465,7 +14518,8 @@
1446514518
"MULTI_PARTY_CONFERENCE",
1446614519
"HIGH_VOLUME_OUTBOUND",
1446714520
"ENHANCED_CONTACT_MONITORING",
14468-
"ENHANCED_CHAT_MONITORING"
14521+
"ENHANCED_CHAT_MONITORING",
14522+
"MULTI_PARTY_CHAT_CONFERENCE"
1446914523
]
1447014524
},
1447114525
"InstanceAttributeValue":{
@@ -14683,7 +14737,8 @@
1468314737
"FILE_SCANNER",
1468414738
"SES_IDENTITY",
1468514739
"ANALYTICS_CONNECTOR",
14686-
"CALL_TRANSFER_CONNECTOR"
14740+
"CALL_TRANSFER_CONNECTOR",
14741+
"COGNITO_USER_POOL"
1468714742
]
1468814743
},
1468914744
"InternalServiceException":{
@@ -22205,6 +22260,10 @@
2220522260
"SegmentAttributes":{
2220622261
"shape":"SegmentAttributes",
2220722262
"documentation":"<p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p> <note> <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in the SupportedMessagingContentTypes field of this API in order to set <code>SegmentAttributes</code> as {<code> \"connect:Subtype\": {\"valueString\" : \"connect:Guide\" }}</code>.</p> </note>"
22263+
},
22264+
"CustomerId":{
22265+
"shape":"CustomerIdNonEmpty",
22266+
"documentation":"<p>The customer's identification number. For example, the <code>CustomerId</code> may be a customer number from your CRM.</p>"
2220822267
}
2220922268
}
2221022269
},
@@ -24584,6 +24643,40 @@
2458424643
"StorageConfig":{"shape":"InstanceStorageConfig"}
2458524644
}
2458624645
},
24646+
"UpdateParticipantAuthenticationRequest":{
24647+
"type":"structure",
24648+
"required":[
24649+
"State",
24650+
"InstanceId"
24651+
],
24652+
"members":{
24653+
"State":{
24654+
"shape":"ParticipantToken",
24655+
"documentation":"<p>The <code>state</code> query parameter that was provided by Cognito in the <code>redirectUri</code>. This will also match the <code>state</code> parameter provided in the <code>AuthenticationUrl</code> from the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html\">GetAuthenticationUrl</a> response.</p>"
24656+
},
24657+
"InstanceId":{
24658+
"shape":"InstanceId",
24659+
"documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"
24660+
},
24661+
"Code":{
24662+
"shape":"AuthorizationCode",
24663+
"documentation":"<p>The <code>code</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p>"
24664+
},
24665+
"Error":{
24666+
"shape":"AuthenticationError",
24667+
"documentation":"<p>The <code>error</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p>"
24668+
},
24669+
"ErrorDescription":{
24670+
"shape":"AuthenticationErrorDescription",
24671+
"documentation":"<p>The <code>error_description</code> parameter provided by Cognito in the <code>redirectUri</code>.</p>"
24672+
}
24673+
}
24674+
},
24675+
"UpdateParticipantAuthenticationResponse":{
24676+
"type":"structure",
24677+
"members":{
24678+
}
24679+
},
2458724680
"UpdateParticipantRoleConfigChannelInfo":{
2458824681
"type":"structure",
2458924682
"members":{
@@ -26572,7 +26665,7 @@
2657226665
},
2657326666
"IvrRecordingTrack":{
2657426667
"shape":"IvrRecordingTrack",
26575-
"documentation":"<p>Identifies which IVR track is being recorded.</p>"
26668+
"documentation":"<p>Identifies which IVR track is being recorded.</p> <p>One and only one of the track configurations should be presented in the request.</p>"
2657626669
}
2657726670
},
2657826671
"documentation":"<p>Contains information about the recording configuration settings.</p>"

0 commit comments

Comments
 (0)