Skip to content

Commit

Permalink
Amazon Connect Cases Update: This release adds the ability to disable…
Browse files Browse the repository at this point in the history
… templates through the UpdateTemplate API. Disabling templates prevents customers from creating cases using the template. For more information see https://docs.aws.amazon.com/cases/latest/APIReference/Welcome.html
  • Loading branch information
AWS committed Nov 9, 2022
1 parent bb7fd16 commit 2cd8188
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 48 deletions.
6 changes: 6 additions & 0 deletions .changes/next-release/feature-AmazonConnectCases-cdcfaf8.json
@@ -0,0 +1,6 @@
{
"type": "feature",
"category": "Amazon Connect Cases",
"contributor": "",
"description": "This release adds the ability to disable templates through the UpdateTemplate API. Disabling templates prevents customers from creating cases using the template. For more information see https://docs.aws.amazon.com/cases/latest/APIReference/Welcome.html"
}
Expand Up @@ -9,8 +9,8 @@
},
"params": {
"UseDualStack": true,
"Region": "us-gov-east-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "us-gov-east-1"
}
},
{
Expand All @@ -22,8 +22,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-gov-east-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "us-gov-east-1"
}
},
{
Expand All @@ -35,8 +35,8 @@
},
"params": {
"UseDualStack": true,
"Region": "us-gov-east-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "us-gov-east-1"
}
},
{
Expand All @@ -48,8 +48,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-gov-east-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "us-gov-east-1"
}
},
{
Expand All @@ -61,8 +61,8 @@
},
"params": {
"UseDualStack": true,
"Region": "cn-north-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "cn-north-1"
}
},
{
Expand All @@ -74,8 +74,8 @@
},
"params": {
"UseDualStack": false,
"Region": "cn-north-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "cn-north-1"
}
},
{
Expand All @@ -87,8 +87,8 @@
},
"params": {
"UseDualStack": true,
"Region": "cn-north-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "cn-north-1"
}
},
{
Expand All @@ -100,8 +100,8 @@
},
"params": {
"UseDualStack": false,
"Region": "cn-north-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "cn-north-1"
}
},
{
Expand All @@ -111,8 +111,8 @@
},
"params": {
"UseDualStack": true,
"Region": "us-iso-east-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "us-iso-east-1"
}
},
{
Expand All @@ -124,8 +124,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-iso-east-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "us-iso-east-1"
}
},
{
Expand All @@ -135,8 +135,8 @@
},
"params": {
"UseDualStack": true,
"Region": "us-iso-east-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "us-iso-east-1"
}
},
{
Expand All @@ -148,8 +148,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-iso-east-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "us-iso-east-1"
}
},
{
Expand All @@ -161,8 +161,8 @@
},
"params": {
"UseDualStack": true,
"Region": "us-east-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "us-east-1"
}
},
{
Expand All @@ -174,8 +174,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-east-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "us-east-1"
}
},
{
Expand All @@ -187,8 +187,8 @@
},
"params": {
"UseDualStack": true,
"Region": "us-east-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "us-east-1"
}
},
{
Expand All @@ -200,8 +200,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-east-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "us-east-1"
}
},
{
Expand All @@ -211,8 +211,8 @@
},
"params": {
"UseDualStack": true,
"Region": "us-isob-east-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "us-isob-east-1"
}
},
{
Expand All @@ -224,8 +224,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-isob-east-1",
"UseFIPS": true
"UseFIPS": true,
"Region": "us-isob-east-1"
}
},
{
Expand All @@ -235,8 +235,8 @@
},
"params": {
"UseDualStack": true,
"Region": "us-isob-east-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "us-isob-east-1"
}
},
{
Expand All @@ -248,8 +248,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-isob-east-1",
"UseFIPS": false
"UseFIPS": false,
"Region": "us-isob-east-1"
}
},
{
Expand All @@ -261,8 +261,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-east-1",
"UseFIPS": false,
"Region": "us-east-1",
"Endpoint": "https://example.com"
}
},
Expand All @@ -273,8 +273,8 @@
},
"params": {
"UseDualStack": false,
"Region": "us-east-1",
"UseFIPS": true,
"Region": "us-east-1",
"Endpoint": "https://example.com"
}
},
Expand All @@ -285,8 +285,8 @@
},
"params": {
"UseDualStack": true,
"Region": "us-east-1",
"UseFIPS": false,
"Region": "us-east-1",
"Endpoint": "https://example.com"
}
}
Expand Down
Expand Up @@ -170,7 +170,7 @@
{"shape":"ConflictException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Creates a template in the Cases domain. This template is used to define the case object model (that is, define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template.</p>",
"documentation":"<p>Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.</p>",
"idempotent":true
},
"GetCase":{
Expand Down Expand Up @@ -532,7 +532,8 @@
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"}
{"shape":"ConflictException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Updates the attributes of an existing layout.</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p> <p>A <code>ValidationException</code> is returned when you add non-existent <code>fieldIds</code> to a layout.</p> <note> <p>Title and Status fields cannot be part of layouts because they are not configurable.</p> </note>",
"idempotent":true
Expand All @@ -554,7 +555,7 @@
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Updates the attributes of an existing template. The template attributes that can be modified include <code>name</code>, <code>description</code>, <code>layouts</code>, and <code>requiredFields</code>. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.</p>",
"documentation":"<p>Updates the attributes of an existing template. The template attributes that can be modified include <code>name</code>, <code>description</code>, <code>layoutConfiguration</code>, <code>requiredFields</code>, and <code>status</code>. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.</p>",
"idempotent":true
}
},
Expand Down Expand Up @@ -891,7 +892,7 @@
"members":{
"clientToken":{
"shape":"CreateCaseRequestClientTokenString",
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"documentation":"<p>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 <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>",
"idempotencyToken":true
},
"domainId":{
Expand Down Expand Up @@ -1132,6 +1133,10 @@
"requiredFields":{
"shape":"RequiredFieldList",
"documentation":"<p>A list of fields that must contain a value for a case to be successfully created with this template.</p>"
},
"status":{
"shape":"TemplateStatus",
"documentation":"<p>The status of the template.</p>"
}
}
},
Expand Down Expand Up @@ -1321,7 +1326,7 @@
"FieldGroupFieldsList":{
"type":"list",
"member":{"shape":"FieldItem"},
"max":30,
"max":100,
"min":0
},
"FieldGroupNameString":{
Expand Down Expand Up @@ -1771,6 +1776,7 @@
"type":"structure",
"required":[
"name",
"status",
"templateArn",
"templateId"
],
Expand All @@ -1791,6 +1797,10 @@
"shape":"RequiredFieldList",
"documentation":"<p>A list of fields that must contain a value for a case to be successfully created with this template.</p>"
},
"status":{
"shape":"TemplateStatus",
"documentation":"<p>The status of the template.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>"
Expand Down Expand Up @@ -2165,6 +2175,12 @@
"documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"status":{
"shape":"TemplateStatusFilters",
"documentation":"<p>A list of status values to filter on.</p>",
"location":"querystring",
"locationName":"status"
}
}
},
Expand Down Expand Up @@ -2662,10 +2678,26 @@
"min":1,
"pattern":"^.*[\\S]$"
},
"TemplateStatus":{
"type":"string",
"documentation":"<p>Status of a template</p>",
"enum":[
"Active",
"Inactive"
]
},
"TemplateStatusFilters":{
"type":"list",
"member":{"shape":"TemplateStatus"},
"documentation":"<p>List of filters used on the ListTemplates result set</p>",
"max":2,
"min":1
},
"TemplateSummary":{
"type":"structure",
"required":[
"name",
"status",
"templateArn",
"templateId"
],
Expand All @@ -2674,6 +2706,10 @@
"shape":"TemplateName",
"documentation":"<p>The template name.</p>"
},
"status":{
"shape":"TemplateStatus",
"documentation":"<p>The status of the template.</p>"
},
"templateArn":{
"shape":"TemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the template.</p>"
Expand Down Expand Up @@ -2854,6 +2890,10 @@
"shape":"RequiredFieldList",
"documentation":"<p>A list of fields that must contain a value for a case to be successfully created with this template.</p>"
},
"status":{
"shape":"TemplateStatus",
"documentation":"<p>The status of the template.</p>"
},
"templateId":{
"shape":"TemplateId",
"documentation":"<p>A unique identifier for the template.</p>",
Expand Down

0 comments on commit 2cd8188

Please sign in to comment.