Skip to content

Commit f668689

Browse files
SDK release for TaskTemplateInfo in Contact for DescribeContact response.
1 parent a4800bc commit f668689

20 files changed

+611
-155
lines changed

generator/ServiceModels/connect/connect-2017-08-08.api.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6140,6 +6140,7 @@
61406140
"Recordings":{"shape":"Recordings"},
61416141
"DisconnectReason":{"shape":"String"},
61426142
"ContactEvaluations":{"shape":"ContactEvaluations"},
6143+
"TaskTemplateInfo":{"shape":"TaskTemplateInfoV2"},
61436144
"ContactDetails":{"shape":"ContactDetails"},
61446145
"Attributes":{"shape":"Attributes"}
61456146
}
@@ -17654,6 +17655,13 @@
1765417655
"max":500,
1765517656
"min":1
1765617657
},
17658+
"TaskTemplateInfoV2":{
17659+
"type":"structure",
17660+
"members":{
17661+
"Arn":{"shape":"ARN"},
17662+
"Name":{"shape":"TaskTemplateName"}
17663+
}
17664+
},
1765717665
"TaskTemplateList":{
1765817666
"type":"list",
1765917667
"member":{"shape":"TaskTemplateMetadata"}

generator/ServiceModels/connect/connect-2017-08-08.docs.json

Lines changed: 15 additions & 7 deletions
Large diffs are not rendered by default.

generator/ServiceModels/connect/connect-2017-08-08.endpoint-rule-set.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@
55
"builtIn": "AWS::Region",
66
"required": false,
77
"documentation": "The AWS region used to dispatch the request.",
8-
"type": "String"
8+
"type": "string"
99
},
1010
"UseDualStack": {
1111
"builtIn": "AWS::UseDualStack",
1212
"required": true,
1313
"default": false,
1414
"documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.",
15-
"type": "Boolean"
15+
"type": "boolean"
1616
},
1717
"UseFIPS": {
1818
"builtIn": "AWS::UseFIPS",
1919
"required": true,
2020
"default": false,
2121
"documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.",
22-
"type": "Boolean"
22+
"type": "boolean"
2323
},
2424
"Endpoint": {
2525
"builtIn": "SDK::Endpoint",
2626
"required": false,
2727
"documentation": "Override the endpoint used to send this request",
28-
"type": "String"
28+
"type": "string"
2929
}
3030
},
3131
"rules": [

generator/ServiceModels/connect/connect-2017-08-08.normal.json

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
{"shape":"ThrottlingException"},
102102
{"shape":"InternalServiceException"}
103103
],
104-
"documentation":"<p>Associates a queued contact with an agent.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>Custom contact routing. You can build custom contact routing mechanisms beyond the default system routing in Amazon Connect. You can create tailored contact distribution logic that offers queued contacts directly to specific agents.</p> </li> <li> <p>Manual contact assignment. You can programmatically assign queued contacts to available users. This provides flexibility to contact centers that require manual oversight or specialized routing workflows outside of standard queue management.</p> <p>For information about how manual contact assignment works in the agent workspace, see the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html\">Access the Worklist app in the Amazon Connect agent workspace</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>Use this API chat/SMS, email, and task contacts. It does not support voice contacts.</p> </li> <li> <p>Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations.</p> </li> <li> <p>It honors the IAM context key <code>connect:PreferredUserArn</code> to prevent unauthorized contact associations.</p> </li> <li> <p>It respects the IAM context key <code>connect:PreferredUserArn</code> to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
104+
"documentation":"<p>Associates a queued contact with an agent.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>Programmatically assign queued contacts to available users.</p> </li> <li> <p>Leverage the IAM context key <code>connect:PreferredUserArn</code> to restrict contact association to specific preferred user.</p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>Use this API with chat, email, and task contacts. It does not support voice contacts.</p> </li> <li> <p>Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations.</p> </li> <li> <p>It honors the IAM context key <code>connect:PreferredUserArn</code> to prevent unauthorized contact associations.</p> </li> <li> <p>It respects the IAM context key <code>connect:PreferredUserArn</code> to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases.</p> </li> <li> <p>The service quota <i>Queues per routing profile per instance</i> applies to manually assigned queues, too. For more information about this quota, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas\">Amazon Connect quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
105105
},
106106
"AssociateDefaultVocabulary":{
107107
"name":"AssociateDefaultVocabulary",
@@ -1496,7 +1496,7 @@
14961496
{"shape":"InternalServiceException"},
14971497
{"shape":"ThrottlingException"}
14981498
],
1499-
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified contact. </p> <important> <ul> <li> <p> <code>SystemEndpoint</code> is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK</p> </li> <li> <p>Contact information remains available in Amazon Connect for 24 months from the <code>InitiationTimestamp</code>, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.</p> </li> </ul> </important>"
1499+
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified contact. </p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions.</p> </li> <li> <p>Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord\">ContactTraceRecord</a> to detect this event and then re-queue the chat for followup.</p> </li> <li> <p>Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-events.html\">contact event stream</a>. </p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p> <code>SystemEndpoint</code> is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK</p> </li> <li> <p>Contact information remains available in Amazon Connect for 24 months from the <code>InitiationTimestamp</code>, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
15001500
},
15011501
"DescribeContactEvaluation":{
15021502
"name":"DescribeContactEvaluation",
@@ -2930,7 +2930,7 @@
29302930
{"shape":"ThrottlingException"},
29312931
{"shape":"InternalServiceException"}
29322932
],
2933-
"documentation":"<p>Lists the manual assignment queues associated with a routing profile.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>This API returns list of queues where contacts can be manually assigned or picked. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown).</p> <p>For information about how manual contact assignment works in the agent workspace, see the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html\">Access the Worklist app in the Amazon Connect agent workspace</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
2933+
"documentation":"<p>Lists the manual assignment queues associated with a routing profile.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown).</p> <p>For information about how manual contact assignment works in the agent workspace, see the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html\">Access the Worklist app in the Amazon Connect agent workspace</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
29342934
},
29352935
"ListRoutingProfileQueues":{
29362936
"name":"ListRoutingProfileQueues",
@@ -7309,6 +7309,10 @@
73097309
"shape":"ContactEvaluations",
73107310
"documentation":"<p>Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.</p>"
73117311
},
7312+
"TaskTemplateInfo":{
7313+
"shape":"TaskTemplateInfoV2",
7314+
"documentation":"<p>If this contact was created using a task template, this contains information about the task template.</p>"
7315+
},
73127316
"ContactDetails":{
73137317
"shape":"ContactDetails",
73147318
"documentation":"<p>A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.</p>"
@@ -16997,7 +17001,7 @@
1699717001
"members":{
1699817002
"InstanceId":{
1699917003
"shape":"InstanceId",
17000-
"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>",
17004+
"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. Both Instance ID and Instance ARN are supported input formats. </p>",
1700117005
"location":"uri",
1700217006
"locationName":"InstanceId"
1700317007
},
@@ -21161,7 +21165,7 @@
2116121165
},
2116221166
"Channel":{
2116321167
"shape":"Channel",
21164-
"documentation":"<p>The channels this queue supports. Valid Values: CHAT | TASK | EMAIL </p>"
21168+
"documentation":"<p>The channels this queue supports. Valid Values: CHAT | TASK | EMAIL </p> <important> <p>VOICE is not supported. The information shown below is incorrect. We're working to correct it. </p> </important>"
2116521169
}
2116621170
},
2116721171
"documentation":"<p>Contains summary information about a routing profile manual assignment queue.</p>"
@@ -21779,7 +21783,7 @@
2177921783
"documentation":"<p>The match type combining multiple time range filters.</p>"
2178021784
}
2178121785
},
21782-
"documentation":"<p>Time range that you additionally want to filter on.</p>"
21786+
"documentation":"<p>Time range that you <b>additionally</b> want to filter on.</p> <note> <p>This is different from the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchContactsTimeRange.html\">SearchContactsTimeRange</a> data type.</p> </note>"
2178321787
},
2178421788
"SearchContactsAdditionalTimeRangeCriteria":{
2178521789
"type":"structure",
@@ -21910,7 +21914,7 @@
2191021914
"documentation":"<p>Condition of the timestamp on the contact.</p>"
2191121915
}
2191221916
},
21913-
"documentation":"<p>The timestamp condition indicating which timestamp should be used and how it should be filtered.</p>"
21917+
"documentation":"<p>The timestamp condition indicating which contact timestamp should be used and how it should be filtered. It is not an actual timestamp value. </p>"
2191421918
},
2191521919
"SearchCriteria":{
2191621920
"type":"structure",
@@ -24590,6 +24594,20 @@
2459024594
"max":500,
2459124595
"min":1
2459224596
},
24597+
"TaskTemplateInfoV2":{
24598+
"type":"structure",
24599+
"members":{
24600+
"Arn":{
24601+
"shape":"ARN",
24602+
"documentation":"<p>The Amazon Resource Name (ARN) of the task template used to create this contact.</p>"
24603+
},
24604+
"Name":{
24605+
"shape":"TaskTemplateName",
24606+
"documentation":"<p>The name of the task template used to create this contact.</p>"
24607+
}
24608+
},
24609+
"documentation":"<p>Information about the task template used to create this contact.</p>"
24610+
},
2459324611
"TaskTemplateList":{
2459424612
"type":"list",
2459524613
"member":{"shape":"TaskTemplateMetadata"}

sdk/code-analysis/ServiceAnalysis/Connect/Generated/PropertyValueRules.xml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5623,6 +5623,11 @@
56235623
<min>1</min>
56245624
<max>100</max>
56255625
</property-value-rule>
5626+
<property-value-rule>
5627+
<property>Amazon.Connect.Model.TaskTemplateInfoV2.Name</property>
5628+
<min>1</min>
5629+
<max>100</max>
5630+
</property-value-rule>
56265631
<property-value-rule>
56275632
<property>Amazon.Connect.Model.TaskTemplateMetadata.Arn</property>
56285633
<min>1</min>

sdk/src/Services/Connect/Generated/Model/AssociateContactWithUserRequest.cs

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,30 +43,20 @@ namespace Amazon.Connect.Model
4343
/// </para>
4444
/// <ul> <li>
4545
/// <para>
46-
/// Custom contact routing. You can build custom contact routing mechanisms beyond the
47-
/// default system routing in Amazon Connect. You can create tailored contact distribution
48-
/// logic that offers queued contacts directly to specific agents.
46+
/// Programmatically assign queued contacts to available users.
4947
/// </para>
5048
/// </li> <li>
5149
/// <para>
52-
/// Manual contact assignment. You can programmatically assign queued contacts to available
53-
/// users. This provides flexibility to contact centers that require manual oversight
54-
/// or specialized routing workflows outside of standard queue management.
55-
/// </para>
56-
///
57-
/// <para>
58-
/// For information about how manual contact assignment works in the agent workspace,
59-
/// see the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html">Access
60-
/// the Worklist app in the Amazon Connect agent workspace</a> in the <i>Amazon Connect
61-
/// Administrator Guide</i>.
50+
/// Leverage the IAM context key <c>connect:PreferredUserArn</c> to restrict contact association
51+
/// to specific preferred user.
6252
/// </para>
6353
/// </li> </ul>
6454
/// <para>
6555
/// <b>Important things to know</b>
6656
/// </para>
6757
/// <ul> <li>
6858
/// <para>
69-
/// Use this API chat/SMS, email, and task contacts. It does not support voice contacts.
59+
/// Use this API with chat, email, and task contacts. It does not support voice contacts.
7060
/// </para>
7161
/// </li> <li>
7262
/// <para>
@@ -85,6 +75,12 @@ namespace Amazon.Connect.Model
8575
/// controls and prevent unauthorized contact associations. Verify that your IAM policies
8676
/// are properly configured to support your intended use cases.
8777
/// </para>
78+
/// </li> <li>
79+
/// <para>
80+
/// The service quota <i>Queues per routing profile per instance</i> applies to manually
81+
/// assigned queues, too. For more information about this quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon
82+
/// Connect quotas</a> in the <i>Amazon Connect Administrator Guide</i>.
83+
/// </para>
8884
/// </li> </ul>
8985
/// <para>
9086
/// <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon

sdk/src/Services/Connect/Generated/Model/Contact.cs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ public partial class Contact
7474
private Dictionary<string, SegmentAttributeValue> _segmentAttributes = AWSConfigs.InitializeCollections ? new Dictionary<string, SegmentAttributeValue>() : null;
7575
private EndpointInfo _systemEndpoint;
7676
private Dictionary<string, string> _tags = AWSConfigs.InitializeCollections ? new Dictionary<string, string>() : null;
77+
private TaskTemplateInfoV2 _taskTemplateInfo;
7778
private int? _totalPauseCount;
7879
private int? _totalPauseDurationInSeconds;
7980
private WisdomInfo _wisdomInfo;
@@ -863,6 +864,25 @@ internal bool IsSetTags()
863864
return this._tags != null && (this._tags.Count > 0 || !AWSConfigs.InitializeCollections);
864865
}
865866

867+
/// <summary>
868+
/// Gets and sets the property TaskTemplateInfo.
869+
/// <para>
870+
/// If this contact was created using a task template, this contains information about
871+
/// the task template.
872+
/// </para>
873+
/// </summary>
874+
public TaskTemplateInfoV2 TaskTemplateInfo
875+
{
876+
get { return this._taskTemplateInfo; }
877+
set { this._taskTemplateInfo = value; }
878+
}
879+
880+
// Check to see if TaskTemplateInfo property is set
881+
internal bool IsSetTaskTemplateInfo()
882+
{
883+
return this._taskTemplateInfo != null;
884+
}
885+
866886
/// <summary>
867887
/// Gets and sets the property TotalPauseCount.
868888
/// <para>

0 commit comments

Comments
 (0)