# Amazon Connect Cases
<a name="API_Operations_Amazon_Connect_Cases"></a>

The following actions are supported by Amazon Connect Cases:
+  [BatchGetCaseRule](API_connect-cases_BatchGetCaseRule.md) 
+  [BatchGetField](API_connect-cases_BatchGetField.md) 
+  [BatchPutFieldOptions](API_connect-cases_BatchPutFieldOptions.md) 
+  [CreateCase](API_connect-cases_CreateCase.md) 
+  [CreateCaseRule](API_connect-cases_CreateCaseRule.md) 
+  [CreateDomain](API_connect-cases_CreateDomain.md) 
+  [CreateField](API_connect-cases_CreateField.md) 
+  [CreateLayout](API_connect-cases_CreateLayout.md) 
+  [CreateRelatedItem](API_connect-cases_CreateRelatedItem.md) 
+  [CreateTemplate](API_connect-cases_CreateTemplate.md) 
+  [DeleteCase](API_connect-cases_DeleteCase.md) 
+  [DeleteCaseRule](API_connect-cases_DeleteCaseRule.md) 
+  [DeleteDomain](API_connect-cases_DeleteDomain.md) 
+  [DeleteField](API_connect-cases_DeleteField.md) 
+  [DeleteLayout](API_connect-cases_DeleteLayout.md) 
+  [DeleteRelatedItem](API_connect-cases_DeleteRelatedItem.md) 
+  [DeleteTemplate](API_connect-cases_DeleteTemplate.md) 
+  [GetCase](API_connect-cases_GetCase.md) 
+  [GetCaseAuditEvents](API_connect-cases_GetCaseAuditEvents.md) 
+  [GetCaseEventConfiguration](API_connect-cases_GetCaseEventConfiguration.md) 
+  [GetDomain](API_connect-cases_GetDomain.md) 
+  [GetLayout](API_connect-cases_GetLayout.md) 
+  [GetTemplate](API_connect-cases_GetTemplate.md) 
+  [ListCaseRules](API_connect-cases_ListCaseRules.md) 
+  [ListCasesForContact](API_connect-cases_ListCasesForContact.md) 
+  [ListDomains](API_connect-cases_ListDomains.md) 
+  [ListFieldOptions](API_connect-cases_ListFieldOptions.md) 
+  [ListFields](API_connect-cases_ListFields.md) 
+  [ListLayouts](API_connect-cases_ListLayouts.md) 
+  [ListTagsForResource](API_connect-cases_ListTagsForResource.md) 
+  [ListTemplates](API_connect-cases_ListTemplates.md) 
+  [PutCaseEventConfiguration](API_connect-cases_PutCaseEventConfiguration.md) 
+  [SearchAllRelatedItems](API_connect-cases_SearchAllRelatedItems.md) 
+  [SearchCases](API_connect-cases_SearchCases.md) 
+  [SearchRelatedItems](API_connect-cases_SearchRelatedItems.md) 
+  [TagResource](API_connect-cases_TagResource.md) 
+  [UntagResource](API_connect-cases_UntagResource.md) 
+  [UpdateCase](API_connect-cases_UpdateCase.md) 
+  [UpdateCaseRule](API_connect-cases_UpdateCaseRule.md) 
+  [UpdateField](API_connect-cases_UpdateField.md) 
+  [UpdateLayout](API_connect-cases_UpdateLayout.md) 
+  [UpdateRelatedItem](API_connect-cases_UpdateRelatedItem.md) 
+  [UpdateTemplate](API_connect-cases_UpdateTemplate.md) 

# BatchGetCaseRule
<a name="API_connect-cases_BatchGetCaseRule"></a>

Gets a batch of case rules. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_BatchGetCaseRule_RequestSyntax"></a>

```
POST /domains/domainId/rules-batch HTTP/1.1
Content-type: application/json

{
   "caseRules": [ 
      { 
         "id": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_BatchGetCaseRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_BatchGetCaseRule_RequestSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_BatchGetCaseRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [caseRules](#API_connect-cases_BatchGetCaseRule_RequestSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-request-caseRules"></a>
A list of case rule identifiers.  
Type: Array of [CaseRuleIdentifier](API_connect-cases_CaseRuleIdentifier.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_BatchGetCaseRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "caseRules": [ 
      { 
         "caseRuleArn": "string",
         "caseRuleId": "string",
         "createdTime": "string",
         "deleted": boolean,
         "description": "string",
         "lastModifiedTime": "string",
         "name": "string",
         "rule": { ... },
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "errors": [ 
      { 
         "errorCode": "string",
         "id": "string",
         "message": "string"
      }
   ],
   "unprocessedCaseRules": [ "string" ]
}
```

## Response Elements
<a name="API_connect-cases_BatchGetCaseRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [caseRules](#API_connect-cases_BatchGetCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-response-caseRules"></a>
A list of detailed case rule information.  
Type: Array of [GetCaseRuleResponse](API_connect-cases_GetCaseRuleResponse.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [errors](#API_connect-cases_BatchGetCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-response-errors"></a>
A list of case rule errors.  
Type: Array of [CaseRuleError](API_connect-cases_CaseRuleError.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [unprocessedCaseRules](#API_connect-cases_BatchGetCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-response-unprocessedCaseRules"></a>
A list of unprocessed case rule identifiers.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_BatchGetCaseRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_BatchGetCaseRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/BatchGetCaseRule) 

# BatchGetField
<a name="API_connect-cases_BatchGetField"></a>

Returns the description for the list of fields in the request parameters. 

## Request Syntax
<a name="API_connect-cases_BatchGetField_RequestSyntax"></a>

```
POST /domains/domainId/fields-batch HTTP/1.1
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_BatchGetField_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_BatchGetField_RequestSyntax) **   <a name="connect-connect-cases_BatchGetField-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_BatchGetField_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [fields](#API_connect-cases_BatchGetField_RequestSyntax) **   <a name="connect-connect-cases_BatchGetField-request-fields"></a>
A list of unique field identifiers.   
Type: Array of [FieldIdentifier](API_connect-cases_FieldIdentifier.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_BatchGetField_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "errorCode": "string",
         "id": "string",
         "message": "string"
      }
   ],
   "fields": [ 
      { 
         "attributes": { ... },
         "createdTime": "string",
         "deleted": boolean,
         "description": "string",
         "fieldArn": "string",
         "fieldId": "string",
         "lastModifiedTime": "string",
         "name": "string",
         "namespace": "string",
         "tags": { 
            "string" : "string" 
         },
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_BatchGetField_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_connect-cases_BatchGetField_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetField-response-errors"></a>
A list of field errors.   
Type: Array of [FieldError](API_connect-cases_FieldError.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [fields](#API_connect-cases_BatchGetField_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetField-response-fields"></a>
A list of detailed field information.   
Type: Array of [GetFieldResponse](API_connect-cases_GetFieldResponse.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

## Errors
<a name="API_connect-cases_BatchGetField_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_BatchGetField_Examples"></a>

### Request and Response example
<a name="API_connect-cases_BatchGetField_Example_1"></a>

This example illustrates one usage of BatchGetField.

```
{
   "fields":[   
   {
      "id":"[field_id_1]"
   },
   {
      "id":"[field_id_2]"
   },
   {
      "id":"case_id"
   }
   ]
}
```

```
{
   "errors":[
     ],
     "fields":[
      {
      "description":"Test with description",
      "fieldArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id_1]",
      "fieldId":"[field_id_1]",
      "name":"field1",
      "namespace":"Custom",
      "tags":{
         "resourceArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/5a17045a-9150-48f9-8cd5-8a5946585b73"
         },
      "type":"SingleSelect"
      },
      {
      "description":"Unique Identifier of the case",
      "fieldArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/case_id",
      "fieldId":"case_id",
      "name":"Case Id",
      "namespace":"System",
      "tags":{
         "resourceArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/case_id"
         },
      "type":"Text"
      },
      {
         "description":"test",
         "fieldArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id_2]",
         "fieldId":"[field_id_2]",
         "name":"field2",
         "namespace":"Custom",
         "tags":{
            "resourceArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id_2]"
            },
      "type":"SingleSelect"
      }
   ]
}
```

## See Also
<a name="API_connect-cases_BatchGetField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/BatchGetField) 

# BatchPutFieldOptions
<a name="API_connect-cases_BatchPutFieldOptions"></a>

Creates and updates a set of field options for a single select field in a Cases domain.

## Request Syntax
<a name="API_connect-cases_BatchPutFieldOptions_RequestSyntax"></a>

```
PUT /domains/domainId/fields/fieldId/options HTTP/1.1
Content-type: application/json

{
   "options": [ 
      { 
         "active": boolean,
         "name": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_BatchPutFieldOptions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_BatchPutFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_BatchPutFieldOptions-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [fieldId](#API_connect-cases_BatchPutFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_BatchPutFieldOptions-request-uri-fieldId"></a>
The unique identifier of a field.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_BatchPutFieldOptions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [options](#API_connect-cases_BatchPutFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_BatchPutFieldOptions-request-options"></a>
A list of `FieldOption` objects.  
Type: Array of [FieldOption](API_connect-cases_FieldOption.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_BatchPutFieldOptions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "errorCode": "string",
         "message": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_BatchPutFieldOptions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_connect-cases_BatchPutFieldOptions_ResponseSyntax) **   <a name="connect-connect-cases_BatchPutFieldOptions-response-errors"></a>
A list of field errors.   
Type: Array of [FieldOptionError](API_connect-cases_FieldOptionError.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

## Errors
<a name="API_connect-cases_BatchPutFieldOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_BatchPutFieldOptions_Examples"></a>

### Example
<a name="API_connect-cases_BatchPutFieldOptions_Example_1"></a>

Request and Response Example:

```
{
  "options": [
    {
    "active": true,
    "name": "California",
    "value": "CA"
    },
    {
    "active": true,
    "name": "Washington",
    "value": "WA"
    },
    {
    "active": false,
    "name": "New York",
    "value": "NY"
    },
    {
    "active": false,
    "name": "Massachusetts",
    "value": "MA"
    }
  ]
}
```

```
{
"errors": []
}
```

## See Also
<a name="API_connect-cases_BatchPutFieldOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/BatchPutFieldOptions) 

# CreateCase
<a name="API_connect-cases_CreateCase"></a>

**Note**  
If you provide a value for `PerformedBy.UserArn` you must also have [connect:DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the User ARN resource that you provide

Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.

When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case.

The following fields are required when creating a case:
+  `customer_id` - You must provide the full customer profile ARN in this format: `arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID` 
+  `title` 

## Request Syntax
<a name="API_connect-cases_CreateCase_RequestSyntax"></a>

```
POST /domains/domainId/cases HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "fields": [ 
      { 
         "id": "string",
         "value": { ... }
      }
   ],
   "performedBy": { ... },
   "tags": { 
      "string" : "string" 
   },
   "templateId": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS 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/).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Required: No

 ** [fields](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-fields"></a>
An array of objects with field ID (matching ListFields/DescribeField) and value union data.  
Type: Array of [FieldValue](API_connect-cases_FieldValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 220 items.  
Required: Yes

 ** [performedBy](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-performedBy"></a>
Represents the entity that performed the action.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [tags](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-tags"></a>
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.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?![aA][wW][sS]:)[a-zA-Z0-9 _.:/=+\-@]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `([a-zA-Z0-9 _.:/=+\-@]*)`   
Required: No

 ** [templateId](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-templateId"></a>
A unique identifier of a template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateCase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "caseArn": "string",
   "caseId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [caseArn](#API_connect-cases_CreateCase_ResponseSyntax) **   <a name="connect-connect-cases_CreateCase-response-caseArn"></a>
The Amazon Resource Name (ARN) of the case.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [caseId](#API_connect-cases_CreateCase_ResponseSyntax) **   <a name="connect-connect-cases_CreateCase-response-caseId"></a>
A unique identifier of the case.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateCase_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateCase_Example_1"></a>

This example illustrates one usage of CreateCase.

```
{
  "templateId": "[template_id]",
  "fields": [
  {
    "id": "customer_id",
    "value": {
      "stringValue": "[customer_id]"
     },
    {
    "id": "title",
    "value": {
      "stringValue": "Incorrect Shipping Address"
      }
    }
  ],
  "clientToken": "[clientToken]",
  "tags": {
    "Department": "Shipping",
    "Priority": "High"
  }
}
```

```
{
  "caseArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/case/[case_id]",
  "caseId": "[case_id]"
}
```

## See Also
<a name="API_connect-cases_CreateCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateCase) 

# CreateCaseRule
<a name="API_connect-cases_CreateCaseRule"></a>

Creates a new case rule. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_CreateCaseRule_RequestSyntax"></a>

```
POST /domains/domainId/case-rules HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "rule": { ... }
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateCaseRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_CreateCaseRule-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateCaseRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_connect-cases_CreateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_CreateCaseRule-request-description"></a>
The description of a case rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [name](#API_connect-cases_CreateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_CreateCaseRule-request-name"></a>
Name of the case rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

 ** [rule](#API_connect-cases_CreateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_CreateCaseRule-request-rule"></a>
Represents what rule type should take place, under what conditions.  
Type: [CaseRuleDetails](API_connect-cases_CaseRuleDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateCaseRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "caseRuleArn": "string",
   "caseRuleId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateCaseRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [caseRuleArn](#API_connect-cases_CreateCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_CreateCaseRule-response-caseRuleArn"></a>
The Amazon Resource Name (ARN) of a case rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [caseRuleId](#API_connect-cases_CreateCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_CreateCaseRule-response-caseRuleId"></a>
Unique identifier of a case rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateCaseRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateCaseRule_Examples"></a>

### Example
<a name="API_connect-cases_CreateCaseRule_Example_1"></a>

This example illustrates one usage of CreateCaseRule.

```
CreateCaseRule
POST /domains/domainId/case-rules HTTP/1.1
Content-type: application/json
{
	"name": "RequiredIfStatusOpen",
	"description": "Makes field required if status is set to Open",
	"rule": {
		"required": {
			"conditions": [
				{
					"equalTo": {
						"operandOne": {
							"fieldId": "status"
						},
						"operandTwo": {
							"doubleValue": "Open"
						},
						"result": true
					}
				}
			],
			"defaultValue": false
		}
	}
}
```

## See Also
<a name="API_connect-cases_CreateCaseRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateCaseRule) 

# CreateDomain
<a name="API_connect-cases_CreateDomain"></a>

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.

**Important**  
This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect [CreateIntegrationAssociation](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html) API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see [Onboard to Cases](https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam).

## Request Syntax
<a name="API_connect-cases_CreateDomain_RequestSyntax"></a>

```
POST /domains HTTP/1.1
Content-type: application/json

{
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateDomain_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-cases_CreateDomain_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [name](#API_connect-cases_CreateDomain_RequestSyntax) **   <a name="connect-connect-cases_CreateDomain-request-name"></a>
The name for your Cases domain. It must be unique for your AWS account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "domainArn": "string",
   "domainId": "string",
   "domainStatus": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [domainArn](#API_connect-cases_CreateDomain_ResponseSyntax) **   <a name="connect-connect-cases_CreateDomain-response-domainArn"></a>
The Amazon Resource Name (ARN) for the Cases domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [domainId](#API_connect-cases_CreateDomain_ResponseSyntax) **   <a name="connect-connect-cases_CreateDomain-response-domainId"></a>
The unique identifier of the Cases domain.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [domainStatus](#API_connect-cases_CreateDomain_ResponseSyntax) **   <a name="connect-connect-cases_CreateDomain-response-domainStatus"></a>
The status of the domain.  
Type: String  
Valid Values: `Active | CreationInProgress | CreationFailed` 

## Errors
<a name="API_connect-cases_CreateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateDomain_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateDomain_Example_1"></a>

This example illustrates one usage of CreateDomain.

```
{
  "name": "demo-amazon-cases-domain"
 }
```

```
{
  "domainArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]",
  "domainId": "[domain_id]",
  "domainStatus": "CreationInProgress"
}
```

## See Also
<a name="API_connect-cases_CreateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateDomain) 

# CreateField
<a name="API_connect-cases_CreateField"></a>

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain. 

## Request Syntax
<a name="API_connect-cases_CreateField_RequestSyntax"></a>

```
POST /domains/domainId/fields HTTP/1.1
Content-type: application/json

{
   "attributes": { ... },
   "description": "string",
   "name": "string",
   "type": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateField_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateField_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributes](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-attributes"></a>
Union of field attributes.  
Type: [FieldAttributes](API_connect-cases_FieldAttributes.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [description](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-description"></a>
The description of the field.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [name](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-name"></a>
The name of the field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

 ** [type](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-type"></a>
Defines the data type, some system constraints, and default display of the field.  
Type: String  
Valid Values: `Text | Number | Boolean | DateTime | SingleSelect | Url | User`   
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateField_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "fieldArn": "string",
   "fieldId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateField_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [fieldArn](#API_connect-cases_CreateField_ResponseSyntax) **   <a name="connect-connect-cases_CreateField-response-fieldArn"></a>
The Amazon Resource Name (ARN) of the field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [fieldId](#API_connect-cases_CreateField_ResponseSyntax) **   <a name="connect-connect-cases_CreateField-response-fieldId"></a>
The unique identifier of a field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateField_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateField_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateField_Example_1"></a>

This example illustrates one usage of CreateField.

```
{
  "name": "Color",
  "type": "Text",
  "description": "The color of the item"
}
```

```
{
  "fieldArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id]",
  "fieldId": "[field_id]"
}
```

## See Also
<a name="API_connect-cases_CreateField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateField) 

# CreateLayout
<a name="API_connect-cases_CreateLayout"></a>

Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
+ Fields to display to the users
+ Field ordering

**Note**  
Title and Status fields cannot be part of layouts since they are not configurable.

## Request Syntax
<a name="API_connect-cases_CreateLayout_RequestSyntax"></a>

```
POST /domains/domainId/layouts HTTP/1.1
Content-type: application/json

{
   "content": { ... },
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateLayout_RequestSyntax) **   <a name="connect-connect-cases_CreateLayout-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateLayout_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_connect-cases_CreateLayout_RequestSyntax) **   <a name="connect-connect-cases_CreateLayout-request-content"></a>
Information about which fields will be present in the layout, and information about the order of the fields.  
Type: [LayoutContent](API_connect-cases_LayoutContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [name](#API_connect-cases_CreateLayout_RequestSyntax) **   <a name="connect-connect-cases_CreateLayout-request-name"></a>
The name of the layout. It must be unique for the Cases domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "layoutArn": "string",
   "layoutId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [layoutArn](#API_connect-cases_CreateLayout_ResponseSyntax) **   <a name="connect-connect-cases_CreateLayout-response-layoutArn"></a>
The Amazon Resource Name (ARN) of the newly created layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [layoutId](#API_connect-cases_CreateLayout_ResponseSyntax) **   <a name="connect-connect-cases_CreateLayout-response-layoutId"></a>
The unique identifier of the layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateLayout_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateLayout_Example_1"></a>

This example illustrates one usage of CreateLayout.

```
{
  "content": {
    "basic": {
      "moreInfo": {
        "sections": [
          {
            "fieldGroup": {
              "fields": [
                {
                "id": "created_datetime"
                },
                {
                "id": "case_id"
                }
            ]
          }
        }
      ]
    },
  "topPanel": {
        "sections": [
          {
          "fieldGroup": {
          "fields": [
           {
           "id": "status"
           },
          {
          "id": "case_id"
          }
         ]
        }
       }
      ]
     }
    }
   },
  "name": "testLayout"
}
```

```
{
  "layoutArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/layout/[layout_id]",
  "layoutId": "[layout_id]"
}
```

## See Also
<a name="API_connect-cases_CreateLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateLayout) 

# CreateRelatedItem
<a name="API_connect-cases_CreateRelatedItem"></a>

Creates a related item (comments, tasks, and contacts) and associates it with a case.

There's a quota for the number of fields allowed in a Custom type related item. See [Amazon Connect Cases quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#cases-quotas).

 **Use cases** 

Following are examples of related items that you may want to associate with a case:
+ Related contacts, such as calls, chats, emails tasks
+ Comments, for agent notes
+ SLAs, to capture target resolution goals
+ Cases, to capture related Amazon Connect Cases
+ Files, such as policy documentation or customer-provided attachments
+ Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more

 **Important things to know** 
+ If you are associating a contact to a case by passing in `Contact` for a `type`, you must have [DescribeContact](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeContact.html) permission on the ARN of the contact that you provide in `content.contact.contactArn`.
+ A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a `contactArn`). All Related Items have their own internal identifier, the `relatedItemArn`. Examples of related items include `comments` and `contacts`.
+ If you provide a value for `performedBy.userArn` you must also have [DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the ARN of the user that you provide.
+ The `type` field is reserved for internal use only.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_connect-cases_CreateRelatedItem_RequestSyntax"></a>

```
POST /domains/domainId/cases/caseId/related-items/ HTTP/1.1
Content-type: application/json

{
   "content": { ... },
   "performedBy": { ... },
   "type": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateRelatedItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateRelatedItem_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-content"></a>
The content of a related item to be created.  
Type: [RelatedItemInputContent](API_connect-cases_RelatedItemInputContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [performedBy](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-performedBy"></a>
Represents the creator of the related item.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [type](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-type"></a>
The type of a related item.  
Type: String  
Valid Values: `Contact | Comment | File | Sla | ConnectCase | Custom`   
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateRelatedItem_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "relatedItemArn": "string",
   "relatedItemId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateRelatedItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [relatedItemArn](#API_connect-cases_CreateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-response-relatedItemArn"></a>
The Amazon Resource Name (ARN) of the related item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [relatedItemId](#API_connect-cases_CreateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-response-relatedItemId"></a>
The unique identifier of the related item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateRelatedItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateRelatedItem_Examples"></a>

This section provides examples for supported related item types.

### Type: Comment
<a name="API_connect-cases_CreateRelatedItem_Example_1"></a>

Request:

```
{
  "content": {
    "comment": {
      "body": "Hello World!",
      "contentType": "Text/Plain"
    }
  },
  "type": "Comment"
}
```

### Type: Sla
<a name="API_connect-cases_CreateRelatedItem_Example_2"></a>

Request: 
+  `name` is the descriptive name for the SLA
+  `targetSlaMinutes` is the time in minutes within which the SLA must be met
+  `type` only supports "CaseField"
+  `fieldId` only supports "status" field
+  `targetFieldValues` is the value that the field must reach for the SLA to be met and only supports one value.

```
{
  "content": {
    "sla": {
      "slaInputConfiguration": {
        "name": "Resolution SLA",
        "targetSlaMinutes": 10,
        "type": "CaseField",
        "fieldId": "status",
        "targetFieldValues": [
          {
            "stringValue": "closed"
          }
        ]
      }
    }
  },
  "type": "Sla"
}
```

### Type: File
<a name="API_connect-cases_CreateRelatedItem_Example_3"></a>

Request:

```
{
  "content": {
    "file": {
      "fileArn": "[fileArn]"
    }
  },
  "type": "File"
}
```

### Type: Contact
<a name="API_connect-cases_CreateRelatedItem_Example_4"></a>

Request to associate a customer contact with a case:

```
{
  "content": {
    "contact": {
      "contactArn": "[contactArn]"
    }
  },
  "type": "Contact"
}
```

### Type: Custom
<a name="API_connect-cases_CreateRelatedItem_Example_5"></a>

Request to associate a custom defined related item with a case:

**Note**  
 [System case fields](https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html#system-case-fields) cannot be used in a custom related item.

```
{
  "content": {
    "custom": {
        "fields": [
            {
            "id": "[field_id_1]",
            "value": {
                "stringValue": "Billing"
                },
            {
            "id": "[field_id_2]",
            "value": {
                "stringValue": "Incorrect Shipping Address"
                }
            }
        ],
    }
  },
  "type": "Custom"
}
```

### Type: ConnectCase
<a name="API_connect-cases_CreateRelatedItem_Example_6"></a>

Request to associate another Amazon Connect case with a case:

```
{
  "content": {
    "connectCase": {
      "caseId": "[caseId]"
    }
  },
  "type": "ConnectCase"
}
```

### CreateRelatedItem Response example
<a name="API_connect-cases_CreateRelatedItem_Example_7"></a>

All successful CreateRelatedItem requests return the same response structure: 

```
{
  "relatedItemArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/case/[case_id]/related-item/[related_item_id]",
  "relatedItemId": "[related_item_id]"
}
```

## See Also
<a name="API_connect-cases_CreateRelatedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateRelatedItem) 

# CreateTemplate
<a name="API_connect-cases_CreateTemplate"></a>

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.

 Other template APIs are: 
+  [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) 
+  [GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html) 
+  [ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html) 
+  [UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html) 

## Request Syntax
<a name="API_connect-cases_CreateTemplate_RequestSyntax"></a>

```
POST /domains/domainId/templates HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "layoutConfiguration": { 
      "defaultLayout": "string"
   },
   "name": "string",
   "requiredFields": [ 
      { 
         "fieldId": "string"
      }
   ],
   "rules": [ 
      { 
         "caseRuleId": "string",
         "fieldId": "string"
      }
   ],
   "status": "string",
   "tagPropagationConfigurations": [ 
      { 
         "resourceType": "string",
         "tagMap": { 
            "string" : "string" 
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-description"></a>
A brief description of the template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [layoutConfiguration](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-layoutConfiguration"></a>
Configuration of layouts associated to the template.  
Type: [LayoutConfiguration](API_connect-cases_LayoutConfiguration.md) object  
Required: No

 ** [name](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-name"></a>
A name for the template. It must be unique per domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

 ** [requiredFields](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-requiredFields"></a>
A list of fields that must contain a value for a case to be successfully created with this template.  
Type: Array of [RequiredField](API_connect-cases_RequiredField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** [rules](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-rules"></a>
A list of case rules (also known as [case field conditions](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html)) on a template.   
Type: Array of [TemplateRule](API_connect-cases_TemplateRule.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [status](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-status"></a>
The status of the template.  
Type: String  
Valid Values: `Active | Inactive`   
Required: No

 ** [tagPropagationConfigurations](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-tagPropagationConfigurations"></a>
Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.  
Type: Array of [TagPropagationConfiguration](API_connect-cases_TagPropagationConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

## Response Syntax
<a name="API_connect-cases_CreateTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "templateArn": "string",
   "templateId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [templateArn](#API_connect-cases_CreateTemplate_ResponseSyntax) **   <a name="connect-connect-cases_CreateTemplate-response-templateArn"></a>
The Amazon Resource Name (ARN) of the newly created template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [templateId](#API_connect-cases_CreateTemplate_ResponseSyntax) **   <a name="connect-connect-cases_CreateTemplate-response-templateId"></a>
A unique identifier of a template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateTemplate_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateTemplate_Example_1"></a>

This example illustrates one usage of CreateTemplate.

```
{
  "name": "Shipping",
  "layoutConfiguration": {
    "defaultLayout": "[layout_id]"
    },
  "requiredFields": [
    {
    "fieldId": "[field_id]"
    }
  ],
  "description": "This is an example template for shipping issues",
  "status": "Inactive",
  "tagPropagationConfigurations": [
    {
      "resourceType": "Cases",
      "tagMap": {
        "Department" : "Shipping"
      }
    }
  ]
}
```

```
{
  "templateArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/template/[template_id]",
  "templateId": "[template_id]"
}
```

## See Also
<a name="API_connect-cases_CreateTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateTemplate) 

# DeleteCase
<a name="API_connect-cases_DeleteCase"></a>

 The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot:
+ Retrieve related items
+ Access audit history
+ Perform any operations that require the CaseID

**Important**  
This action is irreversible. After you delete a case, you cannot recover its data.

## Request Syntax
<a name="API_connect-cases_DeleteCase_RequestSyntax"></a>

```
DELETE /domains/domainId/cases/caseId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_DeleteCase_RequestSyntax) **   <a name="connect-connect-cases_DeleteCase-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_DeleteCase_RequestSyntax) **   <a name="connect-connect-cases_DeleteCase-request-uri-domainId"></a>
A unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteCase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteCase_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteCase) 

# DeleteCaseRule
<a name="API_connect-cases_DeleteCaseRule"></a>

Deletes a case rule. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_DeleteCaseRule_RequestSyntax"></a>

```
DELETE /domains/domainId/case-rules/caseRuleId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteCaseRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseRuleId](#API_connect-cases_DeleteCaseRule_RequestSyntax) **   <a name="connect-connect-cases_DeleteCaseRule-request-uri-caseRuleId"></a>
Unique identifier of a case rule.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_DeleteCaseRule_RequestSyntax) **   <a name="connect-connect-cases_DeleteCaseRule-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteCaseRule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteCaseRule_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteCaseRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteCaseRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

## See Also
<a name="API_connect-cases_DeleteCaseRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteCaseRule) 

# DeleteDomain
<a name="API_connect-cases_DeleteDomain"></a>

Deletes a Cases domain.

**Note**  
After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See [DeleteIntegrationAssociation](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html).

## Request Syntax
<a name="API_connect-cases_DeleteDomain_RequestSyntax"></a>

```
DELETE /domains/domainId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_DeleteDomain_RequestSyntax) **   <a name="connect-connect-cases_DeleteDomain-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteDomain) 

# DeleteField
<a name="API_connect-cases_DeleteField"></a>

Deletes a field from a cases template.

After a field is deleted:
+ You can still retrieve the field by calling `BatchGetField`.
+ You cannot update a deleted field by calling `UpdateField`; it throws a `ValidationException`.
+ Deleted fields are not included in the `ListFields` response.
+ Calling `CreateCase` with a deleted field throws a `ValidationException` denoting which field identifiers in the request have been deleted.
+ Calling `GetCase` with a deleted field identifier returns the deleted field's value if one exists.
+ Calling `UpdateCase` with a deleted field ID throws a `ValidationException` if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using `emptyValue: {}`) the field's value from the case.
+  `GetTemplate` does not return field IDs for deleted fields.
+  `GetLayout` does not return field IDs for deleted fields.
+ Calling `SearchCases` with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.
+ Calling `SearchCases` with a `searchTerm` value that matches a deleted field's value on a case returns the case in the response.
+ Calling `BatchPutFieldOptions` with a deleted field ID throw a `ValidationException`.
+ Calling `GetCaseEventConfiguration` does not return field IDs for deleted fields.

## Request Syntax
<a name="API_connect-cases_DeleteField_RequestSyntax"></a>

```
DELETE /domains/domainId/fields/fieldId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteField_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_DeleteField_RequestSyntax) **   <a name="connect-connect-cases_DeleteField-request-uri-domainId"></a>
The unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [fieldId](#API_connect-cases_DeleteField_RequestSyntax) **   <a name="connect-connect-cases_DeleteField-request-uri-fieldId"></a>
Unique identifier of the field.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteField_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteField_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteField_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteField_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteField) 

# DeleteLayout
<a name="API_connect-cases_DeleteLayout"></a>

Deletes a layout from a cases template. You can delete up to 100 layouts per domain.

After a layout is deleted:
+ You can still retrieve the layout by calling `GetLayout`.
+ You cannot update a deleted layout by calling `UpdateLayout`; it throws a `ValidationException`.
+ Deleted layouts are not included in the `ListLayouts` response.

## Request Syntax
<a name="API_connect-cases_DeleteLayout_RequestSyntax"></a>

```
DELETE /domains/domainId/layouts/layoutId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_DeleteLayout_RequestSyntax) **   <a name="connect-connect-cases_DeleteLayout-request-uri-domainId"></a>
The unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [layoutId](#API_connect-cases_DeleteLayout_RequestSyntax) **   <a name="connect-connect-cases_DeleteLayout-request-uri-layoutId"></a>
The unique identifier of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteLayout_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteLayout) 

# DeleteRelatedItem
<a name="API_connect-cases_DeleteRelatedItem"></a>

Deletes the related item resource under a case.

**Note**  
This API cannot be used on a FILE type related attachment. To delete this type of file, use the [DeleteAttachedFile](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteAttachedFile.html) API

## Request Syntax
<a name="API_connect-cases_DeleteRelatedItem_RequestSyntax"></a>

```
DELETE /domains/domainId/cases/caseId/related-items/relatedItemId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteRelatedItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_DeleteRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_DeleteRelatedItem-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_DeleteRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_DeleteRelatedItem-request-uri-domainId"></a>
A unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [relatedItemId](#API_connect-cases_DeleteRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_DeleteRelatedItem-request-uri-relatedItemId"></a>
A unique identifier of a related item.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteRelatedItem_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteRelatedItem_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteRelatedItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteRelatedItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteRelatedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteRelatedItem) 

# DeleteTemplate
<a name="API_connect-cases_DeleteTemplate"></a>

Deletes a cases template. You can delete up to 100 templates per domain.

After a cases template is deleted:
+ You can still retrieve the template by calling `GetTemplate`.
+ You cannot update the template. 
+ You cannot create a case by using the deleted template.
+ Deleted templates are not included in the `ListTemplates` response.

## Request Syntax
<a name="API_connect-cases_DeleteTemplate_RequestSyntax"></a>

```
DELETE /domains/domainId/templates/templateId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_DeleteTemplate_RequestSyntax) **   <a name="connect-connect-cases_DeleteTemplate-request-uri-domainId"></a>
The unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [templateId](#API_connect-cases_DeleteTemplate_RequestSyntax) **   <a name="connect-connect-cases_DeleteTemplate-request-uri-templateId"></a>
A unique identifier of a template.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteTemplate) 

# GetCase
<a name="API_connect-cases_GetCase"></a>

Returns information about a specific case if it exists. 

## Request Syntax
<a name="API_connect-cases_GetCase_RequestSyntax"></a>

```
POST /domains/domainId/cases/caseId HTTP/1.1
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string"
      }
   ],
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_GetCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_GetCase_RequestSyntax) **   <a name="connect-connect-cases_GetCase-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_GetCase_RequestSyntax) **   <a name="connect-connect-cases_GetCase-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [fields](#API_connect-cases_GetCase_RequestSyntax) **   <a name="connect-connect-cases_GetCase-request-fields"></a>
A list of unique field identifiers.   
Type: Array of [FieldIdentifier](API_connect-cases_FieldIdentifier.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 220 items.  
Required: Yes

 ** [nextToken](#API_connect-cases_GetCase_RequestSyntax) **   <a name="connect-connect-cases_GetCase-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

## Response Syntax
<a name="API_connect-cases_GetCase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string",
         "value": { ... }
      }
   ],
   "nextToken": "string",
   "tags": { 
      "string" : "string" 
   },
   "templateId": "string"
}
```

## Response Elements
<a name="API_connect-cases_GetCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [fields](#API_connect-cases_GetCase_ResponseSyntax) **   <a name="connect-connect-cases_GetCase-response-fields"></a>
A list of detailed field information.   
Type: Array of [FieldValue](API_connect-cases_FieldValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 220 items.

 ** [nextToken](#API_connect-cases_GetCase_ResponseSyntax) **   <a name="connect-connect-cases_GetCase-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [tags](#API_connect-cases_GetCase_ResponseSyntax) **   <a name="connect-connect-cases_GetCase-response-tags"></a>
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.  
Type: String to string map

 ** [templateId](#API_connect-cases_GetCase_ResponseSyntax) **   <a name="connect-connect-cases_GetCase-response-templateId"></a>
A unique identifier of a template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_GetCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetCase_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetCase_Example_1"></a>

This example illustrates one usage of GetCase.

```
{
  "fields": [
  {
    "id": "title"
  },
  {
  "id": "status"
  }
 ]
}
```

```
{
  "fields": [
    {
      "id": "title",
      "value": {
         "stringValue": "Incorrect Shipping Address"
          }
     },
     {
      "id": "status",
      "value": {
         "stringValue": "Open"
          }
     }
  ],
  "templateId": "[template_id]",
  "tags": {},
  "nextToken": [nextToken]
}
```

## See Also
<a name="API_connect-cases_GetCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetCase) 

# GetCaseAuditEvents
<a name="API_connect-cases_GetCaseAuditEvents"></a>

Returns the audit history about a specific case if it exists.

## Request Syntax
<a name="API_connect-cases_GetCaseAuditEvents_RequestSyntax"></a>

```
POST /domains/domainId/cases/caseId/audit-history HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_GetCaseAuditEvents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_GetCaseAuditEvents_RequestSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_GetCaseAuditEvents_RequestSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-request-uri-domainId"></a>
The unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetCaseAuditEvents_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_connect-cases_GetCaseAuditEvents_RequestSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-request-maxResults"></a>
The maximum number of audit events to return. When no value is provided, 25 is the default.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 25.  
Required: No

 ** [nextToken](#API_connect-cases_GetCaseAuditEvents_RequestSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

## Response Syntax
<a name="API_connect-cases_GetCaseAuditEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "auditEvents": [ 
      { 
         "eventId": "string",
         "fields": [ 
            { 
               "eventFieldId": "string",
               "newValue": { ... },
               "oldValue": { ... }
            }
         ],
         "performedBy": { 
            "iamPrincipalArn": "string",
            "user": { ... }
         },
         "performedTime": "string",
         "relatedItemType": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_GetCaseAuditEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [auditEvents](#API_connect-cases_GetCaseAuditEvents_ResponseSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-response-auditEvents"></a>
A list of case audits where each represents a particular edit of the case.  
Type: Array of [AuditEvent](API_connect-cases_AuditEvent.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [nextToken](#API_connect-cases_GetCaseAuditEvents_ResponseSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_GetCaseAuditEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_GetCaseAuditEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetCaseAuditEvents) 

# GetCaseEventConfiguration
<a name="API_connect-cases_GetCaseEventConfiguration"></a>

Returns the case event publishing configuration.

## Request Syntax
<a name="API_connect-cases_GetCaseEventConfiguration_RequestSyntax"></a>

```
POST /domains/domainId/case-event-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_GetCaseEventConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_GetCaseEventConfiguration_RequestSyntax) **   <a name="connect-connect-cases_GetCaseEventConfiguration-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetCaseEventConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_GetCaseEventConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "eventBridge": { 
      "enabled": boolean,
      "includedData": { 
         "caseData": { 
            "fields": [ 
               { 
                  "id": "string"
               }
            ]
         },
         "relatedItemData": { 
            "includeContent": boolean
         }
      }
   }
}
```

## Response Elements
<a name="API_connect-cases_GetCaseEventConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [eventBridge](#API_connect-cases_GetCaseEventConfiguration_ResponseSyntax) **   <a name="connect-connect-cases_GetCaseEventConfiguration-response-eventBridge"></a>
Configuration to enable EventBridge case event delivery and determine what data is delivered.  
Type: [EventBridgeConfiguration](API_connect-cases_EventBridgeConfiguration.md) object

## Errors
<a name="API_connect-cases_GetCaseEventConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetCaseEventConfiguration_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetCaseEventConfiguration_Example_1"></a>

This example illustrates one usage of GetCaseEventConfiguration.

```
{ }
```

```
{
  "enabled":true,
  "includedData":{
   "caseData":{
   "fields":[
    {
    "id":"status"
    },
    {
    "id":"title"
    },
    {
    "id":"customer_id"
    },
    {
    "id":"case_reason"
    }
   ]
  },
  "relatedItemData":{
  "includeContent":true
  }
 }
}
```

## See Also
<a name="API_connect-cases_GetCaseEventConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetCaseEventConfiguration) 

# GetDomain
<a name="API_connect-cases_GetDomain"></a>

Returns information about a specific domain if it exists. 

## Request Syntax
<a name="API_connect-cases_GetDomain_RequestSyntax"></a>

```
POST /domains/domainId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_GetDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_GetDomain_RequestSyntax) **   <a name="connect-connect-cases_GetDomain-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_GetDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdTime": "string",
   "domainArn": "string",
   "domainId": "string",
   "domainStatus": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-cases_GetDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdTime](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-createdTime"></a>
The timestamp when the Cases domain was created.  
Type: Timestamp

 ** [domainArn](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-domainArn"></a>
The Amazon Resource Name (ARN) for the Cases domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [domainId](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-domainId"></a>
The unique identifier of the Cases domain.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [domainStatus](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-domainStatus"></a>
The status of the Cases domain.  
Type: String  
Valid Values: `Active | CreationInProgress | CreationFailed` 

 ** [name](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-name"></a>
The name of the Cases domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]` 

 ** [tags](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-tags"></a>
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.  
Type: String to string map

## Errors
<a name="API_connect-cases_GetDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetDomain_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetDomain_Example_1"></a>

This example illustrates one usage of GetDomain.

```
{ }
```

```
{
  "createdAt": "2021-03-05T21:25:30.261392Z",
  "domainArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]",
  "domainId": "[domain_id]",
  "domainStatus": "Active",
  "name": "Demo Domain",
  "tags": {}
}
```

## See Also
<a name="API_connect-cases_GetDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetDomain) 

# GetLayout
<a name="API_connect-cases_GetLayout"></a>

Returns the details for the requested layout.

## Request Syntax
<a name="API_connect-cases_GetLayout_RequestSyntax"></a>

```
POST /domains/domainId/layouts/layoutId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_GetLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_GetLayout_RequestSyntax) **   <a name="connect-connect-cases_GetLayout-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [layoutId](#API_connect-cases_GetLayout_RequestSyntax) **   <a name="connect-connect-cases_GetLayout-request-uri-layoutId"></a>
The unique identifier of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetLayout_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_GetLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "content": { ... },
   "createdTime": "string",
   "deleted": boolean,
   "lastModifiedTime": "string",
   "layoutArn": "string",
   "layoutId": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-cases_GetLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [content](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-content"></a>
Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.   
Type: [LayoutContent](API_connect-cases_LayoutContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdTime](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-createdTime"></a>
Timestamp at which the resource was created.  
Type: Timestamp

 ** [deleted](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-deleted"></a>
Denotes whether or not the resource has been deleted.  
Type: Boolean

 ** [lastModifiedTime](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-lastModifiedTime"></a>
Timestamp at which the resource was created or last modified.  
Type: Timestamp

 ** [layoutArn](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-layoutArn"></a>
The Amazon Resource Name (ARN) of the newly created layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [layoutId](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-layoutId"></a>
The unique identifier of the layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [name](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-name"></a>
The name of the layout. It must be unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]` 

 ** [tags](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-tags"></a>
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.  
Type: String to string map

## Errors
<a name="API_connect-cases_GetLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetLayout_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetLayout_Example_1"></a>

Following is an example of a content attribute.

```
{ }
```

```
{
  "name": "My layout",
  "content": {
  "basic": {
    "topPanel": {
      "sections": [
      {
        "fieldGroup": {
        "fields": [
          {
          "editable": false,
          "fieldId": "[field_id_1]"
          },
          {
          "editable": false,
          "fieldId": "[field_id_2]"
          }
         ]
       }
     }
    ]
  },
  "moreInfo": {
  "sections": [
      {
      "fieldGroup": {
        "name": "Address",
        "fields": [
          {
          "editable": false,
          "fieldId": "[field_id_3]"
          },
          {
          "editable": false,
          "fieldId": "[field_id_4]"
          }
         ]
        }
       }
      ]
     }
    }
  },
  "layoutArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/layout/[layout_id]",
  "layoutId": "[layout_id]",
  "tags": {}
}
```

## See Also
<a name="API_connect-cases_GetLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetLayout) 

# GetTemplate
<a name="API_connect-cases_GetTemplate"></a>

Returns the details for the requested template. Other template APIs are: 
+  [CreateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html) 
+  [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) 
+  [ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html) 
+  [UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html) 

## Request Syntax
<a name="API_connect-cases_GetTemplate_RequestSyntax"></a>

```
POST /domains/domainId/templates/templateId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_GetTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_GetTemplate_RequestSyntax) **   <a name="connect-connect-cases_GetTemplate-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [templateId](#API_connect-cases_GetTemplate_RequestSyntax) **   <a name="connect-connect-cases_GetTemplate-request-uri-templateId"></a>
A unique identifier of a template.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_GetTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdTime": "string",
   "deleted": boolean,
   "description": "string",
   "lastModifiedTime": "string",
   "layoutConfiguration": { 
      "defaultLayout": "string"
   },
   "name": "string",
   "requiredFields": [ 
      { 
         "fieldId": "string"
      }
   ],
   "rules": [ 
      { 
         "caseRuleId": "string",
         "fieldId": "string"
      }
   ],
   "status": "string",
   "tagPropagationConfigurations": [ 
      { 
         "resourceType": "string",
         "tagMap": { 
            "string" : "string" 
         }
      }
   ],
   "tags": { 
      "string" : "string" 
   },
   "templateArn": "string",
   "templateId": "string"
}
```

## Response Elements
<a name="API_connect-cases_GetTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdTime](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-createdTime"></a>
Timestamp at which the resource was created.  
Type: Timestamp

 ** [deleted](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-deleted"></a>
Denotes whether or not the resource has been deleted.  
Type: Boolean

 ** [description](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-description"></a>
A brief description of the template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [lastModifiedTime](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-lastModifiedTime"></a>
Timestamp at which the resource was created or last modified.  
Type: Timestamp

 ** [layoutConfiguration](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-layoutConfiguration"></a>
Configuration of layouts associated to the template.  
Type: [LayoutConfiguration](API_connect-cases_LayoutConfiguration.md) object

 ** [name](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-name"></a>
The name of the template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]` 

 ** [requiredFields](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-requiredFields"></a>
A list of fields that must contain a value for a case to be successfully created with this template.  
Type: Array of [RequiredField](API_connect-cases_RequiredField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [rules](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-rules"></a>
A list of case rules (also known as [case field conditions](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html)) on a template.   
Type: Array of [TemplateRule](API_connect-cases_TemplateRule.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [status](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-status"></a>
The status of the template.  
Type: String  
Valid Values: `Active | Inactive` 

 ** [tagPropagationConfigurations](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-tagPropagationConfigurations"></a>
Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.  
Type: Array of [TagPropagationConfiguration](API_connect-cases_TagPropagationConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.

 ** [tags](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-tags"></a>
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.  
Type: String to string map

 ** [templateArn](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-templateArn"></a>
The Amazon Resource Name (ARN) of the template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [templateId](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-templateId"></a>
A unique identifier of a template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_GetTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetTemplate_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetTemplate_Example_1"></a>

This example illustrates one usage of GetTemplate.

```
{ }
```

```
{
  "templateId": "[template_id]",
  "templateArn": "[template_arn]",
  "name": "Shipping",
  "layoutConfiguration": {
  "defaultLayout": "[layout_id]"
    },
  "requiredFields": [
    {
    "fieldId": "[field_id]"
    }
  ],
  "description": "This is an example template for shipping issues",
  "status": "Inactive",
  "tagPropagationConfigurations": [
    {
      "resourceType": "Cases",
      "tagMap": {
        "Department" : "Shipping"
      }
    }
  ]
}
```

## See Also
<a name="API_connect-cases_GetTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetTemplate) 

# ListCaseRules
<a name="API_connect-cases_ListCaseRules"></a>

Lists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_ListCaseRules_RequestSyntax"></a>

```
POST /domains/domainId/rules-list/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListCaseRules_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListCaseRules_RequestSyntax) **   <a name="connect-connect-cases_ListCaseRules-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListCaseRules_RequestSyntax) **   <a name="connect-connect-cases_ListCaseRules-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListCaseRules_RequestSyntax) **   <a name="connect-connect-cases_ListCaseRules-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Request Body
<a name="API_connect-cases_ListCaseRules_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListCaseRules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "caseRules": [ 
      { 
         "caseRuleArn": "string",
         "caseRuleId": "string",
         "description": "string",
         "name": "string",
         "ruleType": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListCaseRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [caseRules](#API_connect-cases_ListCaseRules_ResponseSyntax) **   <a name="connect-connect-cases_ListCaseRules-response-caseRules"></a>
A list of field summary objects.  
Type: Array of [CaseRuleSummary](API_connect-cases_CaseRuleSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_connect-cases_ListCaseRules_ResponseSyntax) **   <a name="connect-connect-cases_ListCaseRules-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListCaseRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_ListCaseRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListCaseRules) 

# ListCasesForContact
<a name="API_connect-cases_ListCasesForContact"></a>

Lists cases for a given contact.

## Request Syntax
<a name="API_connect-cases_ListCasesForContact_RequestSyntax"></a>

```
POST /domains/domainId/list-cases-for-contact HTTP/1.1
Content-type: application/json

{
   "contactArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_ListCasesForContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListCasesForContact_RequestSyntax) **   <a name="connect-connect-cases_ListCasesForContact-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_ListCasesForContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contactArn](#API_connect-cases_ListCasesForContact_RequestSyntax) **   <a name="connect-connect-cases_ListCasesForContact-request-contactArn"></a>
A unique identifier of a contact in Amazon Connect.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListCasesForContact_RequestSyntax) **   <a name="connect-connect-cases_ListCasesForContact-request-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [nextToken](#API_connect-cases_ListCasesForContact_RequestSyntax) **   <a name="connect-connect-cases_ListCasesForContact-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

## Response Syntax
<a name="API_connect-cases_ListCasesForContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cases": [ 
      { 
         "caseId": "string",
         "templateId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListCasesForContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cases](#API_connect-cases_ListCasesForContact_ResponseSyntax) **   <a name="connect-connect-cases_ListCasesForContact-response-cases"></a>
A list of Case summary information.  
Type: Array of [CaseSummary](API_connect-cases_CaseSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [nextToken](#API_connect-cases_ListCasesForContact_ResponseSyntax) **   <a name="connect-connect-cases_ListCasesForContact-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListCasesForContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListCasesForContact_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListCasesForContact_Example_1"></a>

This example illustrates one usage of ListCasesForContact.

```
{
  "contactArn": "arn:aws:connect:us-west-2:[account_id]:instance/[connect_instance_id]/contact/[contact_id]",
  "maxResults": 10
}
```

```
{
  "cases": [
    {
      "caseId": "[case_id_1]",
      "templateId": "[template_id_1]"
    },
    {
      "caseId": "[case_id_2]",
      "templateId": "[template_id_2]"
      },
      {
      "caseId": "[case_id_3]",
      "templateId": "[template_id_3]"
      }
    ]
  "nextToken": null
}
```

## See Also
<a name="API_connect-cases_ListCasesForContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListCasesForContact) 

# ListDomains
<a name="API_connect-cases_ListDomains"></a>

Lists all cases domains in the AWS account. Each list item is a condensed summary object of the domain.

## Request Syntax
<a name="API_connect-cases_ListDomains_RequestSyntax"></a>

```
POST /domains-list?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListDomains_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_connect-cases_ListDomains_RequestSyntax) **   <a name="connect-connect-cases_ListDomains-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [nextToken](#API_connect-cases_ListDomains_RequestSyntax) **   <a name="connect-connect-cases_ListDomains-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Request Body
<a name="API_connect-cases_ListDomains_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListDomains_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "domains": [ 
      { 
         "domainArn": "string",
         "domainId": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListDomains_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [domains](#API_connect-cases_ListDomains_ResponseSyntax) **   <a name="connect-connect-cases_ListDomains-response-domains"></a>
The Cases domain.  
Type: Array of [DomainSummary](API_connect-cases_DomainSummary.md) objects

 ** [nextToken](#API_connect-cases_ListDomains_ResponseSyntax) **   <a name="connect-connect-cases_ListDomains-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListDomains_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListDomains_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListDomains_Example_1"></a>

This example illustrates one usage of ListDomains.

```
{ }
```

```
{
"domains": [
  {
    "domainArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]",
    "domainId": "[domain_id]",
    "name": "[domain_name]"
  }
]
"nextToken": [nextToken]
}
```

## See Also
<a name="API_connect-cases_ListDomains_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListDomains) 

# ListFieldOptions
<a name="API_connect-cases_ListFieldOptions"></a>

Lists all of the field options for a field identifier in the domain. 

## Request Syntax
<a name="API_connect-cases_ListFieldOptions_RequestSyntax"></a>

```
POST /domains/domainId/fields/fieldId/options-list?maxResults=maxResults&nextToken=nextToken&values=values HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListFieldOptions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [fieldId](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-fieldId"></a>
The unique identifier of a field.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [values](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-values"></a>
A list of `FieldOption` values to filter on for `ListFieldOptions`.  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Length Constraints: Minimum length of 0. Maximum length of 100.

## Request Body
<a name="API_connect-cases_ListFieldOptions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListFieldOptions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "options": [ 
      { 
         "active": boolean,
         "name": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_ListFieldOptions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_connect-cases_ListFieldOptions_ResponseSyntax) **   <a name="connect-connect-cases_ListFieldOptions-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [options](#API_connect-cases_ListFieldOptions_ResponseSyntax) **   <a name="connect-connect-cases_ListFieldOptions-response-options"></a>
A list of `FieldOption` objects.  
Type: Array of [FieldOption](API_connect-cases_FieldOption.md) objects

## Errors
<a name="API_connect-cases_ListFieldOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListFieldOptions_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListFieldOptions_Example_1"></a>

This example illustrates one usage of ListFieldOptions.

```
{ }
```

```
{
  "nextToken": [nextToken],
  "options": [
     {
     "active": true,
     "name": "California",
     "value": "CA"
     },
     {
     "active": true,
     "name": "Washington",
     "value": "WA"
     },
     {
     "active": true,
     "name": "New York",
     "value": "NY"
     },
     {
     "active": false,
     "name": "Massachusetts",
     "value": "MA"
     }
  ]
}
```

## See Also
<a name="API_connect-cases_ListFieldOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListFieldOptions) 

# ListFields
<a name="API_connect-cases_ListFields"></a>

Lists all fields in a Cases domain.

## Request Syntax
<a name="API_connect-cases_ListFields_RequestSyntax"></a>

```
POST /domains/domainId/fields-list?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListFields_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListFields_RequestSyntax) **   <a name="connect-connect-cases_ListFields-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListFields_RequestSyntax) **   <a name="connect-connect-cases_ListFields-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListFields_RequestSyntax) **   <a name="connect-connect-cases_ListFields-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Request Body
<a name="API_connect-cases_ListFields_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListFields_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "fields": [ 
      { 
         "attributes": { ... },
         "fieldArn": "string",
         "fieldId": "string",
         "name": "string",
         "namespace": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListFields_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [fields](#API_connect-cases_ListFields_ResponseSyntax) **   <a name="connect-connect-cases_ListFields-response-fields"></a>
List of detailed field information.  
Type: Array of [FieldSummary](API_connect-cases_FieldSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_connect-cases_ListFields_ResponseSyntax) **   <a name="connect-connect-cases_ListFields-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListFields_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListFields_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListFields_Example_1"></a>

This example illustrates one usage of ListFields.

```
{ }
```

```
{
  "fields": [
  {
    "fieldId": "[field_id]",
    "fieldArn": "[field_arn]",
    "name": "Color",
    "type": "Text",
    "namespace": "Custom",
    "tags": {}
    }
   ],
   "nextToken": [nextToken]
}
```

## See Also
<a name="API_connect-cases_ListFields_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListFields) 

# ListLayouts
<a name="API_connect-cases_ListLayouts"></a>

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

## Request Syntax
<a name="API_connect-cases_ListLayouts_RequestSyntax"></a>

```
POST /domains/domainId/layouts-list?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListLayouts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListLayouts_RequestSyntax) **   <a name="connect-connect-cases_ListLayouts-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListLayouts_RequestSyntax) **   <a name="connect-connect-cases_ListLayouts-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListLayouts_RequestSyntax) **   <a name="connect-connect-cases_ListLayouts-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Request Body
<a name="API_connect-cases_ListLayouts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListLayouts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "layouts": [ 
      { 
         "layoutArn": "string",
         "layoutId": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListLayouts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [layouts](#API_connect-cases_ListLayouts_ResponseSyntax) **   <a name="connect-connect-cases_ListLayouts-response-layouts"></a>
The layouts for the domain.  
Type: Array of [LayoutSummary](API_connect-cases_LayoutSummary.md) objects

 ** [nextToken](#API_connect-cases_ListLayouts_ResponseSyntax) **   <a name="connect-connect-cases_ListLayouts-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListLayouts_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListLayouts_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListLayouts_Example_1"></a>

This example illustrates one usage of ListLayouts.

```
{ }
```

```
{
  "layouts": [
    {
      "layoutArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/layout/[layout_id]",
      "layoutId": "[layout_id]",
      "name": "[layout_name]"
    }
  ],
  "nextToken": "[nextToken]"
}
```

## See Also
<a name="API_connect-cases_ListLayouts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListLayouts) 

# ListTagsForResource
<a name="API_connect-cases_ListTagsForResource"></a>

Lists tags for a resource.

## Request Syntax
<a name="API_connect-cases_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/arn HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-cases_ListTagsForResource_RequestSyntax) **   <a name="connect-connect-cases_ListTagsForResource-request-uri-arn"></a>
The Amazon Resource Name (ARN)  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-cases_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_connect-cases_ListTagsForResource_ResponseSyntax) **   <a name="connect-connect-cases_ListTagsForResource-response-tags"></a>
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.  
Type: String to string map

## Errors
<a name="API_connect-cases_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListTagsForResource_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListTagsForResource_Example_1"></a>

This example illustrates one usage of ListTagsForResource.

```
{ }
```

```
{
  "tags": {
  "some_key": "some_value"
  }
}
```

## See Also
<a name="API_connect-cases_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListTagsForResource) 

# ListTemplates
<a name="API_connect-cases_ListTemplates"></a>

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. 

 Other template APIs are: 
+  [CreateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html) 
+  [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) 
+  [GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html) 
+  [UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html) 

## Request Syntax
<a name="API_connect-cases_ListTemplates_RequestSyntax"></a>

```
POST /domains/domainId/templates-list?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListTemplates_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListTemplates_RequestSyntax) **   <a name="connect-connect-cases_ListTemplates-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListTemplates_RequestSyntax) **   <a name="connect-connect-cases_ListTemplates-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListTemplates_RequestSyntax) **   <a name="connect-connect-cases_ListTemplates-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [status](#API_connect-cases_ListTemplates_RequestSyntax) **   <a name="connect-connect-cases_ListTemplates-request-uri-status"></a>
A list of status values to filter on.  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Valid Values: `Active | Inactive` 

## Request Body
<a name="API_connect-cases_ListTemplates_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListTemplates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "templates": [ 
      { 
         "name": "string",
         "status": "string",
         "tagPropagationConfigurations": [ 
            { 
               "resourceType": "string",
               "tagMap": { 
                  "string" : "string" 
               }
            }
         ],
         "templateArn": "string",
         "templateId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_ListTemplates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_connect-cases_ListTemplates_ResponseSyntax) **   <a name="connect-connect-cases_ListTemplates-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [templates](#API_connect-cases_ListTemplates_ResponseSyntax) **   <a name="connect-connect-cases_ListTemplates-response-templates"></a>
List of template summary objects.  
Type: Array of [TemplateSummary](API_connect-cases_TemplateSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors
<a name="API_connect-cases_ListTemplates_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListTemplates_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListTemplates_Example_1"></a>

This example illustrates one usage of ListTemplates.

```
{ }
```

```
{
  "templates":[
  {
    "name":"Test",   
    "templateArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/template/[template_id]",
    "templateId":"[template_id]",
    "status": "Active",
    "tagPropagationConfigurations": [
      {
        "resourceType": "Cases",
        "tagMap": {
          "Department" : "Support"
        }
      }
    ]
  }
  ],
  "nextToken":"[nextToken]"
}
```

## See Also
<a name="API_connect-cases_ListTemplates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListTemplates) 

# PutCaseEventConfiguration
<a name="API_connect-cases_PutCaseEventConfiguration"></a>

Adds case event publishing configuration. For a complete list of fields you can add to the event message, see [Create case fields](https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html) in the *Amazon Connect Administrator Guide* 

## Request Syntax
<a name="API_connect-cases_PutCaseEventConfiguration_RequestSyntax"></a>

```
PUT /domains/domainId/case-event-configuration HTTP/1.1
Content-type: application/json

{
   "eventBridge": { 
      "enabled": boolean,
      "includedData": { 
         "caseData": { 
            "fields": [ 
               { 
                  "id": "string"
               }
            ]
         },
         "relatedItemData": { 
            "includeContent": boolean
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_connect-cases_PutCaseEventConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_PutCaseEventConfiguration_RequestSyntax) **   <a name="connect-connect-cases_PutCaseEventConfiguration-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_PutCaseEventConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [eventBridge](#API_connect-cases_PutCaseEventConfiguration_RequestSyntax) **   <a name="connect-connect-cases_PutCaseEventConfiguration-request-eventBridge"></a>
Configuration to enable EventBridge case event delivery and determine what data is delivered.  
Type: [EventBridgeConfiguration](API_connect-cases_EventBridgeConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-cases_PutCaseEventConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_PutCaseEventConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_PutCaseEventConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_PutCaseEventConfiguration_Examples"></a>

### Request and Response example
<a name="API_connect-cases_PutCaseEventConfiguration_Example_1"></a>

This example illustrates one use of PutCaseEventConfiguration. 

```
{
  "enabled":true,
  "includedData":{
    "caseData":{
      "fields":[
        {
        "id":"status"
        },
        {
        "id":"title"
        },
        {
        "id":"customer_id"
        },
        {
        "id":"case_reason"
        }
        ]
    },
   "relatedItemData":{
       "includeContent":true
    }
  }}
```

```
{ }
```

## See Also
<a name="API_connect-cases_PutCaseEventConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/PutCaseEventConfiguration) 

# SearchAllRelatedItems
<a name="API_connect-cases_SearchAllRelatedItems"></a>

Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific [SearchRelatedItems](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItems.html) API.

 **Use cases** 

Following are common uses cases for this API:
+ Find cases with similar issues across the domain. For example, search for all cases containing comments about "product defect" to identify patterns and existing solutions.
+ Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey. 
+ Monitor SLA compliance across cases. For example, search for all cases with "Active" SLA status to prioritize remediation efforts.

 **Important things to know** 
+ This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the [GetCase](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetCase.html) API for each returned case ID. 
+ This API searches across related items content, not case fields. Use the [SearchCases](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchCases.html) API to search within case field values.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_connect-cases_SearchAllRelatedItems_RequestSyntax"></a>

```
POST /domains/domainId/related-items-search HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { ... }
   ],
   "maxResults": number,
   "nextToken": "string",
   "sorts": [ 
      { 
         "sortOrder": "string",
         "sortProperty": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_SearchAllRelatedItems_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_SearchAllRelatedItems_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-filters"></a>
The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.  
Type: Array of [RelatedItemTypeFilter](API_connect-cases_RelatedItemTypeFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [maxResults](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 25.  
Required: No

 ** [nextToken](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

 ** [sorts](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-sorts"></a>
A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.  
Type: Array of [SearchAllRelatedItemsSort](API_connect-cases_SearchAllRelatedItemsSort.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

## Response Syntax
<a name="API_connect-cases_SearchAllRelatedItems_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "relatedItems": [ 
      { 
         "associationTime": "string",
         "caseId": "string",
         "content": { ... },
         "performedBy": { ... },
         "relatedItemId": "string",
         "tags": { 
            "string" : "string" 
         },
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_SearchAllRelatedItems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_connect-cases_SearchAllRelatedItems_ResponseSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [relatedItems](#API_connect-cases_SearchAllRelatedItems_ResponseSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-response-relatedItems"></a>
A list of items related to a case.  
Type: Array of [SearchAllRelatedItemsResponseItem](API_connect-cases_SearchAllRelatedItemsResponseItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

## Errors
<a name="API_connect-cases_SearchAllRelatedItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_SearchAllRelatedItems_Examples"></a>

### Example request to search for all contact-type related items
<a name="API_connect-cases_SearchAllRelatedItems_Example_1"></a>

The following example shows how to search for all contact-type related items across cases in a domain, filtering by a specific contactArn and sorting results by association time in descending order, then by case ID in descending order.

```
{
  "sorts": [
    {
      "sortProperty": "AssociationTime",
      "sortOrder": "Desc"
    },
    {
      "sortProperty": "CaseId",
      "sortOrder": "Desc"
    }
  ],
  "maxResults": 10,
  "filters": [
    {
      "contact": {
        "contactArn": "arn:aws:connect:us-west-2:[account-id]:instance/[instance-id]/contact/[contact-id]"
      }
    }
  ]
}
```

### Example response for a successful search
<a name="API_connect-cases_SearchAllRelatedItems_Example_2"></a>

The following example shows a successful search returning two contact-type related items from different cases, each with their associated case identifiers, contact details, and metadata sorted by most recent association time first.

```
{
  "nextToken": null,
  "relatedItems": [
    {
      "associationTime": "2025-05-16T13:18:37.608074706Z",
      "caseId": "[case-id-1]",
      "content": {
        "contact": {
          "contactArn": "arn:aws:connect:us-west-2:[account-id]:instance/[instance-id]/contact/[contact-id]",
          "channel": "VOICE",
          "connectedToSystemTime": "2025-05-16T13:18:30.000000000Z"
        }
      },
      "performedBy": null,
      "relatedItemId": "[related-item-id-1]",
      "tags": {
        "Company": "AWS",
        "Team": "Connect"
      },
      "type": "Contact"
    },
    {
      "associationTime": "2025-05-16T13:18:19.270469991Z",
      "caseId": "[case-id-2]",
      "content": {
        "contact": {
          "contactArn": "arn:aws:connect:us-west-2:[account-id]:instance/[instance-id]/contact/[contact-id]",
          "channel": "CHAT",
          "connectedToSystemTime": "2025-05-16T13:18:15.000000000Z"
        }
      },
      "performedBy": null,
      "relatedItemId": "[related-item-id-2]",
      "tags": {},
      "type": "Contact"
    }
  ]
}
```

## See Also
<a name="API_connect-cases_SearchAllRelatedItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/SearchAllRelatedItems) 

# SearchCases
<a name="API_connect-cases_SearchCases"></a>

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

**Note**  
For `customer_id` you must provide the full customer profile ARN in this format: ` arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID`. 

## Request Syntax
<a name="API_connect-cases_SearchCases_RequestSyntax"></a>

```
POST /domains/domainId/cases-search HTTP/1.1
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string"
      }
   ],
   "filter": { ... },
   "maxResults": number,
   "nextToken": "string",
   "searchTerm": "string",
   "sorts": [ 
      { 
         "fieldId": "string",
         "sortOrder": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_SearchCases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_SearchCases_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [fields](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-fields"></a>
The list of field identifiers to be returned as part of the response.  
Type: Array of [FieldIdentifier](API_connect-cases_FieldIdentifier.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Required: No

 ** [filter](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-filter"></a>
A list of filter objects.  
Type: [CaseFilter](API_connect-cases_CaseFilter.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [maxResults](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-maxResults"></a>
The maximum number of cases to return. When no value is provided, 25 is the default.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

 ** [searchTerm](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-searchTerm"></a>
A word or phrase used to perform a quick search.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [sorts](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-sorts"></a>
A list of sorts where each sort specifies a field and their sort order to be applied to the results.   
Type: Array of [Sort](API_connect-cases_Sort.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

## Response Syntax
<a name="API_connect-cases_SearchCases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cases": [ 
      { 
         "caseId": "string",
         "fields": [ 
            { 
               "id": "string",
               "value": { ... }
            }
         ],
         "tags": { 
            "string" : "string" 
         },
         "templateId": "string"
      }
   ],
   "nextToken": "string",
   "totalCount": number
}
```

## Response Elements
<a name="API_connect-cases_SearchCases_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cases](#API_connect-cases_SearchCases_ResponseSyntax) **   <a name="connect-connect-cases_SearchCases-response-cases"></a>
A list of case documents where each case contains the properties `CaseId` and `Fields` where each field is a complex union structure.   
Type: Array of [SearchCasesResponseItem](API_connect-cases_SearchCasesResponseItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_connect-cases_SearchCases_ResponseSyntax) **   <a name="connect-connect-cases_SearchCases-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [totalCount](#API_connect-cases_SearchCases_ResponseSyntax) **   <a name="connect-connect-cases_SearchCases-response-totalCount"></a>
The total number of cases that matched the search criteria.  
Type: Long  
Valid Range: Minimum value of 0.

## Errors
<a name="API_connect-cases_SearchCases_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_SearchCases_Examples"></a>

### Request example
<a name="API_connect-cases_SearchCases_Example_1"></a>

This example illustrates one usage of SearchCases.

```
{
   "filter":{
      "andAll":[
         {
            "field":{
               "equalTo":{
                  "id":"title",
                  "value":{
                     "stringValue":"Forward Web Engineer"
                  }
               }
            }
         },
         {
            "not":{
               "field":{
                  "greaterThan":{
                     "id":"customer_age",
                     "value":{
                        "doubleValue":38
                     }
                  }
               }
            }
         }
      ]
   },
   "fields":[
      {
         "id":"title"
      }
   ],
   "maxResults":10,
   "nextToken":null,
   "sorts":[
      {
         "fieldId":"created_datetime",
         "sortOrder":"Asc"
      }
   ]
}
```

### Response example
<a name="API_connect-cases_SearchCases_Example_2"></a>

This example illustrates one usage of SearchCases.

```
{
   "cases":[
      {
         "caseId":"[case_id_1]",
         "fields":[
            {
               "id":"title",
               "value":{
                  "stringValue":"Forward Web Engineer-1"
               }
            }
         ],
         "tags":{
            
         },
         "templateId":"[template_id]"
      },
      {
         "caseId":"[case_id_2]",
         "fields":[
            {
               "id":"title",
               "value":{
                  "stringValue":"Forward Web Engineer-2"
               }
            }
         ],
         "tags":{
            
         },
         "templateId":"[template_id]"
      },
      {
         "caseId":"[case_id_3]",
         "fields":[
            {
               "id":"title",
               "value":{
                  "stringValue":"Forward Web Engineer-3"
               }
            }
         ],
         "tags":{
            
         },
         "templateId":"[template_id]"
      }
   ],
   "nextToken":"[nextToken]"
}
```

## See Also
<a name="API_connect-cases_SearchCases_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/SearchCases) 

# SearchRelatedItems
<a name="API_connect-cases_SearchRelatedItems"></a>

Searches for related items that are associated with a case.

**Note**  
If no filters are provided, this returns all related items associated with a case.

## Request Syntax
<a name="API_connect-cases_SearchRelatedItems_RequestSyntax"></a>

```
POST /domains/domainId/cases/caseId/related-items-search HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { ... }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_SearchRelatedItems_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_SearchRelatedItems_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-filters"></a>
The list of types of related items and their parameters to use for filtering.  
Type: Array of [RelatedItemTypeFilter](API_connect-cases_RelatedItemTypeFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [maxResults](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 25.  
Required: No

 ** [nextToken](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

## Response Syntax
<a name="API_connect-cases_SearchRelatedItems_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "relatedItems": [ 
      { 
         "associationTime": "string",
         "content": { ... },
         "performedBy": { ... },
         "relatedItemId": "string",
         "tags": { 
            "string" : "string" 
         },
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_SearchRelatedItems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_connect-cases_SearchRelatedItems_ResponseSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [relatedItems](#API_connect-cases_SearchRelatedItems_ResponseSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-response-relatedItems"></a>
A list of items related to a case.   
Type: Array of [SearchRelatedItemsResponseItem](API_connect-cases_SearchRelatedItemsResponseItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

## Errors
<a name="API_connect-cases_SearchRelatedItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_SearchRelatedItems_Examples"></a>

### Request and Response example
<a name="API_connect-cases_SearchRelatedItems_Example_1"></a>

This example illustrates one usage of SearchRelatedItems.

```
{
  "maxResults": 25,
  "filters": [
  {
    "contact": {
      "contactArn": "arn:aws:connect:us-west-2:[account_id]:instance/[connect_instance_id]/contact/[contact_id]"
      }
    }
  ]
}
```

```
{
  "nextToken": null,
  "relatedItems": [
    {
    "associationTime": "2022-06-06T18:59:09.865709Z",
    "content": {
      "contact": {
      "channel": "CHAT",
      "connectedToSystemTime": "2022-06-08T18:57:50.558897Z",
      "contactArn": "arn:aws:connect:us-west-2:[account_id]:instance/[connect_instance_id]/contact/[contact_id]"
      }
    },
  "relatedItemId": "[relatedItem_id]",
  "tags": {},
  "type": "Contact"
   }
  ]
}
```

## See Also
<a name="API_connect-cases_SearchRelatedItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/SearchRelatedItems) 

# TagResource
<a name="API_connect-cases_TagResource"></a>

Adds tags to a resource.

## Request Syntax
<a name="API_connect-cases_TagResource_RequestSyntax"></a>

```
POST /tags/arn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-cases_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-cases_TagResource_RequestSyntax) **   <a name="connect-connect-cases_TagResource-request-uri-arn"></a>
The Amazon Resource Name (ARN)  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_connect-cases_TagResource_RequestSyntax) **   <a name="connect-connect-cases_TagResource-request-tags"></a>
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.  
Type: String to string map  
Required: Yes

## Response Syntax
<a name="API_connect-cases_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_TagResource_Examples"></a>

### Request and Response example
<a name="API_connect-cases_TagResource_Example_1"></a>

This example illustrates one usage of TagResource.

```
{
  "tags": {
  "some_key": "some_value"
  }
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/TagResource) 

# UntagResource
<a name="API_connect-cases_UntagResource"></a>

Untags a resource.

## Request Syntax
<a name="API_connect-cases_UntagResource_RequestSyntax"></a>

```
DELETE /tags/arn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-cases_UntagResource_RequestSyntax) **   <a name="connect-connect-cases_UntagResource-request-uri-arn"></a>
The Amazon Resource Name (ARN)  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [tagKeys](#API_connect-cases_UntagResource_RequestSyntax) **   <a name="connect-connect-cases_UntagResource-request-uri-tagKeys"></a>
List of tag keys.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Required: Yes

## Request Body
<a name="API_connect-cases_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UntagResource_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UntagResource_Example_1"></a>

This example illustrates one usage of UntagResource.

```
{ }
```

```
{ }
```

## See Also
<a name="API_connect-cases_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UntagResource) 

# UpdateCase
<a name="API_connect-cases_UpdateCase"></a>

**Note**  
If you provide a value for `PerformedBy.UserArn` you must also have [connect:DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the User ARN resource that you provide

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the `CreateCase` input .

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Request Syntax
<a name="API_connect-cases_UpdateCase_RequestSyntax"></a>

```
PUT /domains/domainId/cases/caseId HTTP/1.1
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string",
         "value": { ... }
      }
   ],
   "performedBy": { ... }
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_UpdateCase_RequestSyntax) **   <a name="connect-connect-cases_UpdateCase-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_UpdateCase_RequestSyntax) **   <a name="connect-connect-cases_UpdateCase-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [fields](#API_connect-cases_UpdateCase_RequestSyntax) **   <a name="connect-connect-cases_UpdateCase-request-fields"></a>
An array of objects with `fieldId` (matching ListFields/DescribeField) and value union data, structured identical to `CreateCase`.  
Type: Array of [FieldValue](API_connect-cases_FieldValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 220 items.  
Required: Yes

 ** [performedBy](#API_connect-cases_UpdateCase_RequestSyntax) **   <a name="connect-connect-cases_UpdateCase-request-performedBy"></a>
Represents the entity that performed the action.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateCase_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateCase_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UpdateCase_Example_1"></a>

This example illustrates one usage of UpdateCase.

```
{
  "fields": [
    {
      "id": "title",
      "value": {
        "stringValue": "New Title"
        }
      }
  ]
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_UpdateCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateCase) 

# UpdateCaseRule
<a name="API_connect-cases_UpdateCaseRule"></a>

Updates a case rule. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_UpdateCaseRule_RequestSyntax"></a>

```
PUT /domains/domainId/case-rules/caseRuleId HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "rule": { ... }
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateCaseRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseRuleId](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-uri-caseRuleId"></a>
Unique identifier of a case rule.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateCaseRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-description"></a>
Description of a case rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [name](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-name"></a>
Name of the case rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: No

 ** [rule](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-rule"></a>
Represents what rule type should take place, under what conditions.  
Type: [CaseRuleDetails](API_connect-cases_CaseRuleDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateCaseRule_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateCaseRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateCaseRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_UpdateCaseRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateCaseRule) 

# UpdateField
<a name="API_connect-cases_UpdateField"></a>

Updates the properties of an existing field. 

## Request Syntax
<a name="API_connect-cases_UpdateField_RequestSyntax"></a>

```
PUT /domains/domainId/fields/fieldId HTTP/1.1
Content-type: application/json

{
   "attributes": { ... },
   "description": "string",
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateField_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [fieldId](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-uri-fieldId"></a>
The unique identifier of a field.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateField_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributes](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-attributes"></a>
Union of field attributes.  
Type: [FieldAttributes](API_connect-cases_FieldAttributes.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [description](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-description"></a>
The description of a field.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [name](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-name"></a>
The name of the field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateField_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateField_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateField_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateField_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UpdateField_Example_1"></a>

This example illustrates one usage of UpdateField.

```
{
  "name": "updated_field_name"
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_UpdateField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateField) 

# UpdateLayout
<a name="API_connect-cases_UpdateLayout"></a>

Updates the attributes of an existing layout.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

A `ValidationException` is returned when you add non-existent `fieldIds` to a layout.

**Note**  
Title and Status fields cannot be part of layouts because they are not configurable.

## Request Syntax
<a name="API_connect-cases_UpdateLayout_RequestSyntax"></a>

```
PUT /domains/domainId/layouts/layoutId HTTP/1.1
Content-type: application/json

{
   "content": { ... },
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_UpdateLayout_RequestSyntax) **   <a name="connect-connect-cases_UpdateLayout-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [layoutId](#API_connect-cases_UpdateLayout_RequestSyntax) **   <a name="connect-connect-cases_UpdateLayout-request-uri-layoutId"></a>
The unique identifier of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateLayout_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_connect-cases_UpdateLayout_RequestSyntax) **   <a name="connect-connect-cases_UpdateLayout-request-content"></a>
Information about which fields will be present in the layout, the order of the fields.  
Type: [LayoutContent](API_connect-cases_LayoutContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [name](#API_connect-cases_UpdateLayout_RequestSyntax) **   <a name="connect-connect-cases_UpdateLayout-request-name"></a>
The name of the layout. It must be unique per domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateLayout_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UpdateLayout_Example_1"></a>

This example illustrates one usage of UpdateLayout.

```
{
  "content": {
    "basic": {
      "moreInfo": {
        "sections": [
          {
          "fieldGroup": {
            "fields": [
              {
              "id": "created_datetime"
              },
              {
              "id": "case_id"
              }
            ]
           }
          }
         ]
      },
    "topPanel": {
      "sections": [
        {
        "fieldGroup": {
          "fields": [
            {
              "id": "summary"
               },
              {
              "id": "status"
              },
              {
              "id": "case_id"
              }
            ]
          }
        }
      ]
    }
  }
},
"name": "testLayout"
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_UpdateLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateLayout) 

# UpdateRelatedItem
<a name="API_connect-cases_UpdateRelatedItem"></a>

Updates the content of a related item associated with a case. The following related item types are supported:
+  **Comment** - Update the text content of an existing comment
+  **Custom** - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There's a quota for the number of fields allowed in a Custom type related item. See [Amazon Connect Cases quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#cases-quotas).

 **Important things to know** 
+ When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed.
+ If you provide a value for `performedBy.userArn` you must also have [DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the ARN of the user that you provide.
+  [System case fields](https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html#system-case-fields) cannot be used in a custom related item.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_connect-cases_UpdateRelatedItem_RequestSyntax"></a>

```
PUT /domains/domainId/cases/caseId/related-items/relatedItemId HTTP/1.1
Content-type: application/json

{
   "content": { ... },
   "performedBy": { ... }
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateRelatedItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [relatedItemId](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-uri-relatedItemId"></a>
Unique identifier of a related item.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateRelatedItem_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-content"></a>
The content of a related item to be updated.  
Type: [RelatedItemUpdateContent](API_connect-cases_RelatedItemUpdateContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [performedBy](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-performedBy"></a>
Represents the user who performed the update of the related item.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateRelatedItem_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "associationTime": "string",
   "content": { ... },
   "createdBy": { ... },
   "lastUpdatedUser": { ... },
   "relatedItemArn": "string",
   "relatedItemId": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string"
}
```

## Response Elements
<a name="API_connect-cases_UpdateRelatedItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [associationTime](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-associationTime"></a>
Time at which the related item was associated with the case.  
Type: Timestamp

 ** [content](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-content"></a>
Represents the content of the updated related item.  
Type: [RelatedItemContent](API_connect-cases_RelatedItemContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdBy](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-createdBy"></a>
Represents the creator of the related item.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [lastUpdatedUser](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-lastUpdatedUser"></a>
Represents the last user that updated the related item.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [relatedItemArn](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-relatedItemArn"></a>
The Amazon Resource Name (ARN) of the updated related item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [relatedItemId](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-relatedItemId"></a>
The unique identifier of the updated related item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [tags](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-tags"></a>
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.  
Type: String to string map

 ** [type](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-type"></a>
Type of the updated related item.  
Type: String  
Valid Values: `Contact | Comment | File | Sla | ConnectCase | Custom` 

## Errors
<a name="API_connect-cases_UpdateRelatedItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateRelatedItem_Examples"></a>

This section provides examples for updating supported related item types.

### Update Comment related item
<a name="API_connect-cases_UpdateRelatedItem_Example_1"></a>

Request to update a comment's text and content type:

```
{
  "domainId": "[domain_id]",
  "caseId": "[case_id]",
  "relatedItemId": "[related_item_id]",
  "content": {
    "comment": {
      "body": "Updated comment text with additional details",
      "contentType": "Text/Plain"
    }
  }
}
```

### Update Custom related item
<a name="API_connect-cases_UpdateRelatedItem_Example_2"></a>

Request to update field values in a custom related item:

**Note**  
 [System case fields](https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html#system-case-fields) cannot be used in a custom related item.

```
{
  "domainId": "[domain_id]",
  "caseId": "[case_id]",
  "relatedItemId": "[related_item_id]",
  "content": {
    "custom": {
      "fields": [
        {
          "id": "[field_id_1]",
          "value": {
            "stringValue": "Updated value for first field"
          }
        },
        {
          "id": "[field_id_2]",
          "value": {
            "stringValue": "Updated value for second field"
          }
        },
        {
          "id": "[field_id_3]",
          "value": {
            "stringValue": "Existing value that remains unchanged"
          }
        }
      ]
    }
  }
}
```

### Update with performedBy parameter
<a name="API_connect-cases_UpdateRelatedItem_Example_3"></a>

Request to update a comment and specify who performed the update:

```
{
  "domainId": "[domain_id]",
  "caseId": "[case_id]",
  "relatedItemId": "[related_item_id]",
  "content": {
    "comment": {
      "body": "Updated comment text with additional details",
      "contentType": "Text/Plain"
    }
  },
  "performedBy": {
    "userArn": "arn:aws:connect:us-west-2:[account_id]:instance/[instance_id]/agent/[agent_id]"
  }
}
```

### UpdateRelatedItem Response example
<a name="API_connect-cases_UpdateRelatedItem_Example_4"></a>

All successful UpdateRelatedItem requests return the updated related item: 

```
{
  "relatedItemArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/case/[case_id]/related-item/[related_item_id]",
  "relatedItemId": "[related_item_id]",
  "type": "Comment",
  "content": {
    "comment": {
      "body": "Updated comment text with additional details",
      "contentType": "Text/Plain"
    }
  },
  "associationTime": "2024-11-22T01:35:46.329Z",
  "lastUpdatedUser": {
    "userArn": "arn:aws:connect:us-west-2:[account_id]:instance/[instance_id]/agent/[agent_id]"
  },
  "createdBy": {
    "userArn": "arn:aws:connect:us-west-2:[account_id]:instance/[instance_id]/agent/[agent_id]"
  }
}
```

## See Also
<a name="API_connect-cases_UpdateRelatedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateRelatedItem) 

# UpdateTemplate
<a name="API_connect-cases_UpdateTemplate"></a>

Updates the attributes of an existing template. The template attributes that can be modified include `name`, `description`, `layoutConfiguration`, `requiredFields`, and `status`. 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.

Other template APIs are:
+  [CreateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html) 
+  [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) 
+  [GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html) 
+  [ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html) 

## Request Syntax
<a name="API_connect-cases_UpdateTemplate_RequestSyntax"></a>

```
PUT /domains/domainId/templates/templateId HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "layoutConfiguration": { 
      "defaultLayout": "string"
   },
   "name": "string",
   "requiredFields": [ 
      { 
         "fieldId": "string"
      }
   ],
   "rules": [ 
      { 
         "caseRuleId": "string",
         "fieldId": "string"
      }
   ],
   "status": "string",
   "tagPropagationConfigurations": [ 
      { 
         "resourceType": "string",
         "tagMap": { 
            "string" : "string" 
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [templateId](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-uri-templateId"></a>
A unique identifier for the template.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-description"></a>
A brief description of the template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [layoutConfiguration](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-layoutConfiguration"></a>
Configuration of layouts associated to the template.  
Type: [LayoutConfiguration](API_connect-cases_LayoutConfiguration.md) object  
Required: No

 ** [name](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-name"></a>
The name of the template. It must be unique per domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: No

 ** [requiredFields](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-requiredFields"></a>
A list of fields that must contain a value for a case to be successfully created with this template.  
Type: Array of [RequiredField](API_connect-cases_RequiredField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** [rules](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-rules"></a>
A list of case rules (also known as [case field conditions](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html)) on a template.  
Type: Array of [TemplateRule](API_connect-cases_TemplateRule.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [status](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-status"></a>
The status of the template.  
Type: String  
Valid Values: `Active | Inactive`   
Required: No

 ** [tagPropagationConfigurations](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-tagPropagationConfigurations"></a>
Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.  
Type: Array of [TagPropagationConfiguration](API_connect-cases_TagPropagationConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateTemplate_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UpdateTemplate_Example_1"></a>

This example illustrates one usage of UpdateTemplate.

```
{
  "name": "updated_template_name",
  "tagPropagationConfigurations": [
    {
      "resourceType": "Cases",
      "tagMap": {
        "Department" : "UpdatedShipping"
      }
    }
  ]
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_UpdateTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateTemplate)