{ "version":"2.0", "metadata":{ "apiVersion":"2022-10-03", "endpointPrefix":"cases", "jsonVersion":"1.1", "protocol":"rest-json", "serviceAbbreviation":"ConnectCases", "serviceFullName":"Amazon Connect Cases", "serviceId":"ConnectCases", "signatureVersion":"v4", "signingName":"cases", "uid":"connectcases-2022-10-03" }, "operations":{ "BatchGetField":{ "name":"BatchGetField", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/fields-batch", "responseCode":200 }, "input":{"shape":"BatchGetFieldRequest"}, "output":{"shape":"BatchGetFieldResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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

" }, "BatchPutFieldOptions":{ "name":"BatchPutFieldOptions", "http":{ "method":"PUT", "requestUri":"/domains/{domainId}/fields/{fieldId}/options", "responseCode":200 }, "input":{"shape":"BatchPutFieldOptionsRequest"}, "output":{"shape":"BatchPutFieldOptionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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

", "idempotent":true }, "CreateCase":{ "name":"CreateCase", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/cases", "responseCode":200 }, "input":{"shape":"CreateCaseRequest"}, "output":{"shape":"CreateCaseResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"} ], "documentation":"

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.

The following fields are required when creating a case:

     <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>

", "idempotent":true }, "CreateDomain":{ "name":"CreateDomain", "http":{ "method":"POST", "requestUri":"/domains", "responseCode":200 }, "input":{"shape":"CreateDomainRequest"}, "output":{"shape":"CreateDomainResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.

     </important>

", "idempotent":true }, "CreateField":{ "name":"CreateField", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/fields", "responseCode":200 }, "input":{"shape":"CreateFieldRequest"}, "output":{"shape":"CreateFieldResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

", "idempotent":true }, "CreateLayout":{ "name":"CreateLayout", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/layouts", "responseCode":200 }, "input":{"shape":"CreateLayoutRequest"}, "output":{"shape":"CreateLayoutResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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

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

" }, "CreateRelatedItem":{ "name":"CreateRelatedItem", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/cases/{caseId}/related-items/", "responseCode":200 }, "input":{"shape":"CreateRelatedItemRequest"}, "output":{"shape":"CreateRelatedItemResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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

- 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 permission on the ARN of the user that you provide.

     </note>

", "idempotent":true }, "CreateTemplate":{ "name":"CreateTemplate", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/templates", "responseCode":200 }, "input":{"shape":"CreateTemplateRequest"}, "output":{"shape":"CreateTemplateResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

", "idempotent":true }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ "method":"DELETE", "requestUri":"/domains/{domainId}", "responseCode":200 }, "input":{"shape":"DeleteDomainRequest"}, "output":{"shape":"DeleteDomainResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes a Cases domain.

     <note> <p>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 <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note>

", "idempotent":true }, "GetCase":{ "name":"GetCase", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/cases/{caseId}", "responseCode":200 }, "input":{"shape":"GetCaseRequest"}, "output":{"shape":"GetCaseResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Returns information about a specific case if it exists.

" }, "GetCaseEventConfiguration":{ "name":"GetCaseEventConfiguration", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/case-event-configuration", "responseCode":200 }, "input":{"shape":"GetCaseEventConfigurationRequest"}, "output":{"shape":"GetCaseEventConfigurationResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Returns the case event publishing configuration.

" }, "GetDomain":{ "name":"GetDomain", "http":{ "method":"POST", "requestUri":"/domains/{domainId}", "responseCode":200 }, "input":{"shape":"GetDomainRequest"}, "output":{"shape":"GetDomainResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Returns information about a specific domain if it exists.

" }, "GetLayout":{ "name":"GetLayout", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/layouts/{layoutId}", "responseCode":200 }, "input":{"shape":"GetLayoutRequest"}, "output":{"shape":"GetLayoutResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Returns the details for the requested layout.

" }, "GetTemplate":{ "name":"GetTemplate", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/templates/{templateId}", "responseCode":200 }, "input":{"shape":"GetTemplateRequest"}, "output":{"shape":"GetTemplateResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Returns the details for the requested template.

" }, "ListCasesForContact":{ "name":"ListCasesForContact", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/list-cases-for-contact", "responseCode":200 }, "input":{"shape":"ListCasesForContactRequest"}, "output":{"shape":"ListCasesForContactResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists cases for a given contact.

" }, "ListDomains":{ "name":"ListDomains", "http":{ "method":"POST", "requestUri":"/domains-list", "responseCode":200 }, "input":{"shape":"ListDomainsRequest"}, "output":{"shape":"ListDomainsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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

" }, "ListFieldOptions":{ "name":"ListFieldOptions", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/fields/{fieldId}/options-list", "responseCode":200 }, "input":{"shape":"ListFieldOptionsRequest"}, "output":{"shape":"ListFieldOptionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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

" }, "ListFields":{ "name":"ListFields", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/fields-list", "responseCode":200 }, "input":{"shape":"ListFieldsRequest"}, "output":{"shape":"ListFieldsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists all fields in a Cases domain.

" }, "ListLayouts":{ "name":"ListLayouts", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/layouts-list", "responseCode":200 }, "input":{"shape":"ListLayoutsRequest"}, "output":{"shape":"ListLayoutsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{arn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists tags for a resource.

", "idempotent":true }, "ListTemplates":{ "name":"ListTemplates", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/templates-list", "responseCode":200 }, "input":{"shape":"ListTemplatesRequest"}, "output":{"shape":"ListTemplatesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

" }, "PutCaseEventConfiguration":{ "name":"PutCaseEventConfiguration", "http":{ "method":"PUT", "requestUri":"/domains/{domainId}/case-event-configuration", "responseCode":200 }, "input":{"shape":"PutCaseEventConfigurationRequest"}, "output":{"shape":"PutCaseEventConfigurationResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide

" }, "SearchCases":{ "name":"SearchCases", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/cases-search", "responseCode":200 }, "input":{"shape":"SearchCasesRequest"}, "output":{"shape":"SearchCasesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

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`.

" }, "SearchRelatedItems":{ "name":"SearchRelatedItems", "http":{ "method":"POST", "requestUri":"/domains/{domainId}/cases/{caseId}/related-items-search", "responseCode":200 }, "input":{"shape":"SearchRelatedItemsRequest"}, "output":{"shape":"SearchRelatedItemsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Searches for related items that are associated with a case.

If no filters are provided, this returns all related items associated with a case.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{arn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Adds tags to a resource.

", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{arn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Untags a resource.

", "idempotent":true }, "UpdateCase":{ "name":"UpdateCase", "http":{ "method":"PUT", "requestUri":"/domains/{domainId}/cases/{caseId}", "responseCode":200 }, "input":{"shape":"UpdateCaseRequest"}, "output":{"shape":"UpdateCaseResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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.

" }, "UpdateField":{ "name":"UpdateField", "http":{ "method":"PUT", "requestUri":"/domains/{domainId}/fields/{fieldId}", "responseCode":200 }, "input":{"shape":"UpdateFieldRequest"}, "output":{"shape":"UpdateFieldResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"} ], "documentation":"

Updates the properties of an existing field.

", "idempotent":true }, "UpdateLayout":{ "name":"UpdateLayout", "http":{ "method":"PUT", "requestUri":"/domains/{domainId}/layouts/{layoutId}", "responseCode":200 }, "input":{"shape":"UpdateLayoutRequest"}, "output":{"shape":"UpdateLayoutResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

Title and Status fields cannot be part of layouts because they are not configurable.

", "idempotent":true }, "UpdateTemplate":{ "name":"UpdateTemplate", "http":{ "method":"PUT", "requestUri":"/domains/{domainId}/templates/{templateId}", "responseCode":200 }, "input":{"shape":"UpdateTemplateRequest"}, "output":{"shape":"UpdateTemplateResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"} ], "documentation":"

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.

", "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

You do not have sufficient access to perform this action.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "Arn":{ "type":"string", "max":500, "min":1 }, "AssociationTime":{ "type":"timestamp", "timestampFormat":"iso8601" }, "BasicLayout":{ "type":"structure", "members":{ "moreInfo":{ "shape":"LayoutSections", "documentation":"

This represents sections in a tab of the page layout.

" }, "topPanel":{ "shape":"LayoutSections", "documentation":"

This represents sections in a panel of the page layout.

" } }, "documentation":"

Content specific to `BasicLayout` type. It configures fields in the top panel and More Info tab of agent application.

" }, "BatchGetFieldIdentifierList":{ "type":"list", "member":{"shape":"FieldIdentifier"}, "max":50, "min":1 }, "BatchGetFieldRequest":{ "type":"structure", "required":[ "domainId", "fields" ], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "fields":{ "shape":"BatchGetFieldIdentifierList", "documentation":"

A list of unique field identifiers.

" } } }, "BatchGetFieldResponse":{ "type":"structure", "required":[ "errors", "fields" ], "members":{ "errors":{ "shape":"BatchGetFieldResponseErrorsList", "documentation":"

A list of field errors.

" }, "fields":{ "shape":"BatchGetFieldResponseFieldsList", "documentation":"

A list of detailed field information.

" } } }, "BatchGetFieldResponseErrorsList":{ "type":"list", "member":{"shape":"FieldError"}, "max":50, "min":0 }, "BatchGetFieldResponseFieldsList":{ "type":"list", "member":{"shape":"GetFieldResponse"}, "max":50, "min":0 }, "BatchPutFieldOptionsRequest":{ "type":"structure", "required":[ "domainId", "fieldId", "options" ], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "fieldId":{ "shape":"FieldId", "documentation":"

The unique identifier of a field.

", "location":"uri", "locationName":"fieldId" }, "options":{ "shape":"BatchPutFieldOptionsRequestOptionsList", "documentation":"

A list of `FieldOption` objects.

" } } }, "BatchPutFieldOptionsRequestOptionsList":{ "type":"list", "member":{"shape":"FieldOption"}, "max":50, "min":0 }, "BatchPutFieldOptionsResponse":{ "type":"structure", "members":{ "errors":{ "shape":"BatchPutFieldOptionsResponseErrorsList", "documentation":"

A list of field errors.

" } } }, "BatchPutFieldOptionsResponseErrorsList":{ "type":"list", "member":{"shape":"FieldOptionError"}, "max":50, "min":0 }, "Boolean":{ "type":"boolean", "box":true }, "CaseArn":{ "type":"string", "max":500, "min":1 }, "CaseEventIncludedData":{ "type":"structure", "required":["fields"], "members":{ "fields":{ "shape":"CaseEventIncludedDataFieldsList", "documentation":"

List of field identifiers.

" } }, "documentation":"

Details of what case data is published through the case event stream.

" }, "CaseEventIncludedDataFieldsList":{ "type":"list", "member":{"shape":"FieldIdentifier"}, "max":200, "min":0 }, "CaseFilter":{ "type":"structure", "members":{ "andAll":{ "shape":"CaseFilterAndAllList", "documentation":"

Provides \"and all\" filtering.

" }, "field":{ "shape":"FieldFilter", "documentation":"

A list of fields to filter on.

" }, "not":{"shape":"CaseFilter"}, "orAll":{ "shape":"CaseFilterOrAllList", "documentation":"

Provides \"or all\" filtering.

" } }, "documentation":"

A filter for cases. Only one value can be provided.

", "union":true }, "CaseFilterAndAllList":{ "type":"list", "member":{"shape":"CaseFilter"}, "max":10, "min":0 }, "CaseFilterOrAllList":{ "type":"list", "member":{"shape":"CaseFilter"}, "max":10, "min":0 }, "CaseId":{ "type":"string", "max":500, "min":1 }, "CaseSummary":{ "type":"structure", "required":[ "caseId", "templateId" ], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

A unique identifier of the case.

" }, "templateId":{ "shape":"TemplateId", "documentation":"

A unique identifier of a template.

" } }, "documentation":"

Case summary information.

" }, "Channel":{ "type":"string", "max":100, "min":1 }, "CommentBody":{ "type":"string", "max":3000, "min":1 }, "CommentBodyTextType":{ "type":"string", "enum":["Text/Plain"] }, "CommentContent":{ "type":"structure", "required":[ "body", "contentType" ], "members":{ "body":{ "shape":"CommentBody", "documentation":"

Text in the body of a `Comment` on a case.

" }, "contentType":{ "shape":"CommentBodyTextType", "documentation":"

Type of the text in the box of a `Comment` on a case.

" } }, "documentation":"

Represents the content of a `Comment` to be returned to agents.

" }, "CommentFilter":{ "type":"structure", "members":{ }, "documentation":"

A filter for related items of type `Comment`.

" }, "ConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

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.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ConnectedToSystemTime":{ "type":"timestamp", "timestampFormat":"iso8601" }, "Contact":{ "type":"structure", "required":["contactArn"], "members":{ "contactArn":{ "shape":"ContactArn", "documentation":"

A unique identifier of a contact in Amazon Connect.

" } }, "documentation":"

An object that represents an Amazon Connect contact object.

" }, "ContactArn":{ "type":"string", "max":500, "min":1 }, "ContactContent":{ "type":"structure", "required":[ "channel", "connectedToSystemTime", "contactArn" ], "members":{ "channel":{ "shape":"Channel", "documentation":"

A list of channels to filter on for related items of type `Contact`.

" }, "connectedToSystemTime":{ "shape":"ConnectedToSystemTime", "documentation":"

The difference between the `InitiationTimestamp` and the `DisconnectTimestamp` of the contact.

" }, "contactArn":{ "shape":"ContactArn", "documentation":"

A unique identifier of a contact in Amazon Connect.

" } }, "documentation":"

An object that represents a content of an Amazon Connect contact object.

" }, "ContactFilter":{ "type":"structure", "members":{ "channel":{ "shape":"ContactFilterChannelList", "documentation":"

A list of channels to filter on for related items of type `Contact`.

" }, "contactArn":{ "shape":"ContactArn", "documentation":"

A unique identifier of a contact in Amazon Connect.

" } }, "documentation":"

A filter for related items of type `Contact`.

" }, "ContactFilterChannelList":{ "type":"list", "member":{"shape":"Channel"}, "max":3, "min":0 }, "CreateCaseRequest":{ "type":"structure", "required":[ "domainId", "fields", "templateId" ], "members":{ "clientToken":{ "shape":"CreateCaseRequestClientTokenString", "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", "idempotencyToken":true }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "fields":{ "shape":"CreateCaseRequestFieldsList", "documentation":"

An array of objects with field ID (matching ListFields/DescribeField) and value union data.

" }, "templateId":{ "shape":"TemplateId", "documentation":"

A unique identifier of a template.

" } } }, "CreateCaseRequestClientTokenString":{ "type":"string", "max":64, "min":0 }, "CreateCaseRequestFieldsList":{ "type":"list", "member":{"shape":"FieldValue"}, "max":100, "min":0 }, "CreateCaseResponse":{ "type":"structure", "required":[ "caseArn", "caseId" ], "members":{ "caseArn":{ "shape":"CaseArn", "documentation":"

The Amazon Resource Name (ARN) of the case.

" }, "caseId":{ "shape":"CaseId", "documentation":"

A unique identifier of the case.

" } } }, "CreateDomainRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"DomainName", "documentation":"

The name for your Cases domain. It must be unique for your Amazon Web Services account.

" } } }, "CreateDomainResponse":{ "type":"structure", "required":[ "domainArn", "domainId", "domainStatus" ], "members":{ "domainArn":{ "shape":"DomainArn", "documentation":"

The Amazon Resource Name (ARN) for the Cases domain.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

" }, "domainStatus":{ "shape":"DomainStatus", "documentation":"

The status of the domain.

" } } }, "CreateFieldRequest":{ "type":"structure", "required":[ "domainId", "name", "type" ], "members":{ "description":{ "shape":"FieldDescription", "documentation":"

The description of the field.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "name":{ "shape":"FieldName", "documentation":"

The name of the field.

" }, "type":{ "shape":"FieldType", "documentation":"

Defines the data type, some system constraints, and default display of the field.

" } } }, "CreateFieldResponse":{ "type":"structure", "required":[ "fieldArn", "fieldId" ], "members":{ "fieldArn":{ "shape":"FieldArn", "documentation":"

The Amazon Resource Name (ARN) of the field.

" }, "fieldId":{ "shape":"FieldId", "documentation":"

The unique identifier of a field.

" } } }, "CreateLayoutRequest":{ "type":"structure", "required":[ "content", "domainId", "name" ], "members":{ "content":{ "shape":"LayoutContent", "documentation":"

Information about which fields will be present in the layout, and information about the order of the fields.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "name":{ "shape":"LayoutName", "documentation":"

The name of the layout. It must be unique for the Cases domain.

" } } }, "CreateLayoutResponse":{ "type":"structure", "required":[ "layoutArn", "layoutId" ], "members":{ "layoutArn":{ "shape":"LayoutArn", "documentation":"

The Amazon Resource Name (ARN) of the newly created layout.

" }, "layoutId":{ "shape":"LayoutId", "documentation":"

The unique identifier of the layout.

" } } }, "CreateRelatedItemRequest":{ "type":"structure", "required":[ "caseId", "content", "domainId", "type" ], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

A unique identifier of the case.

", "location":"uri", "locationName":"caseId" }, "content":{ "shape":"RelatedItemInputContent", "documentation":"

The content of a related item to be created.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "performedBy":{ "shape":"UserUnion", "documentation":"

Represents the creator of the related item.

" }, "type":{ "shape":"RelatedItemType", "documentation":"

The type of a related item.

" } } }, "CreateRelatedItemResponse":{ "type":"structure", "required":[ "relatedItemArn", "relatedItemId" ], "members":{ "relatedItemArn":{ "shape":"RelatedItemArn", "documentation":"

The Amazon Resource Name (ARN) of the related item.

" }, "relatedItemId":{ "shape":"RelatedItemId", "documentation":"

The unique identifier of the related item.

" } } }, "CreateTemplateRequest":{ "type":"structure", "required":[ "domainId", "name" ], "members":{ "description":{ "shape":"TemplateDescription", "documentation":"

A brief description of the template.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "layoutConfiguration":{ "shape":"LayoutConfiguration", "documentation":"

Configuration of layouts associated to the template.

" }, "name":{ "shape":"TemplateName", "documentation":"

A name for the template. It must be unique per domain.

" }, "requiredFields":{ "shape":"RequiredFieldList", "documentation":"

A list of fields that must contain a value for a case to be successfully created with this template.

" }, "status":{ "shape":"TemplateStatus", "documentation":"

The status of the template.

" } } }, "CreateTemplateResponse":{ "type":"structure", "required":[ "templateArn", "templateId" ], "members":{ "templateArn":{ "shape":"TemplateArn", "documentation":"

The Amazon Resource Name (ARN) of the newly created template.

" }, "templateId":{ "shape":"TemplateId", "documentation":"

A unique identifier of a template.

" } } }, "CreatedTime":{ "type":"timestamp", "timestampFormat":"iso8601" }, "DeleteDomainRequest":{ "type":"structure", "required":["domainId"], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" } } }, "DeleteDomainResponse":{ "type":"structure", "members":{ } }, "DomainArn":{ "type":"string", "max":500, "min":1 }, "DomainId":{ "type":"string", "max":500, "min":1 }, "DomainName":{ "type":"string", "max":100, "min":1, "pattern":"^.*[\\S]$" }, "DomainStatus":{ "type":"string", "enum":[ "Active", "CreationInProgress", "CreationFailed" ] }, "DomainSummary":{ "type":"structure", "required":[ "domainArn", "domainId", "name" ], "members":{ "domainArn":{ "shape":"DomainArn", "documentation":"

The Amazon Resource Name (ARN) of the domain.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the domain.

" }, "name":{ "shape":"DomainName", "documentation":"

The name of the domain.

" } }, "documentation":"

Object for the summarized details of the domain.

" }, "DomainSummaryList":{ "type":"list", "member":{"shape":"DomainSummary"} }, "Double":{ "type":"double", "box":true }, "EmptyFieldValue":{ "type":"structure", "members":{ }, "documentation":"

An empty value. You cannot set `EmptyFieldValue` on a field that is required on a case template.

This structure will never have any data members. It signifies an empty value on a case field.

" }, "EventBridgeConfiguration":{ "type":"structure", "required":["enabled"], "members":{ "enabled":{ "shape":"Boolean", "documentation":"

Indicates whether the to broadcast case event data to the customer.

" }, "includedData":{ "shape":"EventIncludedData", "documentation":"

Details of what case and related item data is published through the case event stream.

" } }, "documentation":"

Configuration to enable EventBridge case event delivery and determine what data is delivered.

" }, "EventIncludedData":{ "type":"structure", "members":{ "caseData":{ "shape":"CaseEventIncludedData", "documentation":"

Details of what case data is published through the case event stream.

" }, "relatedItemData":{ "shape":"RelatedItemEventIncludedData", "documentation":"

Details of what related item data is published through the case event stream.

" } }, "documentation":"

Details of what case and related item data is published through the case event stream.

" }, "FieldArn":{ "type":"string", "max":500, "min":1 }, "FieldDescription":{ "type":"string", "max":255, "min":0 }, "FieldError":{ "type":"structure", "required":[ "errorCode", "id" ], "members":{ "errorCode":{ "shape":"String", "documentation":"

The error code from getting a field.

" }, "id":{ "shape":"FieldId", "documentation":"

The field identifier that caused the error.

" }, "message":{ "shape":"String", "documentation":"

The error message from getting a field.

" } }, "documentation":"

Object for errors on fields.

" }, "FieldFilter":{ "type":"structure", "members":{ "contains":{ "shape":"FieldValue", "documentation":"

Object containing field identifier and value information.

" }, "equalTo":{ "shape":"FieldValue", "documentation":"

Object containing field identifier and value information.

" }, "greaterThan":{ "shape":"FieldValue", "documentation":"

Object containing field identifier and value information.

" }, "greaterThanOrEqualTo":{ "shape":"FieldValue", "documentation":"

Object containing field identifier and value information.

" }, "lessThan":{ "shape":"FieldValue", "documentation":"

Object containing field identifier and value information.

" }, "lessThanOrEqualTo":{ "shape":"FieldValue", "documentation":"

Object containing field identifier and value information.

" } }, "documentation":"

A filter for fields. Only one value can be provided.

", "union":true }, "FieldGroup":{ "type":"structure", "required":["fields"], "members":{ "fields":{ "shape":"FieldGroupFieldsList", "documentation":"

Represents an ordered list containing field related information.

" }, "name":{ "shape":"FieldGroupNameString", "documentation":"

Name of the field group.

" } }, "documentation":"

Object for a group of fields and associated properties.

" }, "FieldGroupFieldsList":{ "type":"list", "member":{"shape":"FieldItem"}, "max":100, "min":0 }, "FieldGroupNameString":{ "type":"string", "max":100, "min":0 }, "FieldId":{ "type":"string", "max":500, "min":1 }, "FieldIdentifier":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"FieldId", "documentation":"

Unique identifier of a field.

" } }, "documentation":"

Object for unique identifier of a field.

" }, "FieldItem":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"FieldId", "documentation":"

Unique identifier of a field.

" } }, "documentation":"

Object for field related information.

" }, "FieldName":{ "type":"string", "max":100, "min":1, "pattern":"^.*[\\S]$" }, "FieldNamespace":{ "type":"string", "enum":[ "System", "Custom" ] }, "FieldOption":{ "type":"structure", "required":[ "active", "name", "value" ], "members":{ "active":{ "shape":"Boolean", "documentation":"

Describes whether the `FieldOption` is active (displayed) or inactive.

" }, "name":{ "shape":"FieldOptionName", "documentation":"

`FieldOptionName` has max length 100 and disallows trailing spaces.

" }, "value":{ "shape":"FieldOptionValue", "documentation":"

`FieldOptionValue` has max length 100 and must be alphanumeric with hyphens and underscores.

" } }, "documentation":"

Object for field Options information.

" }, "FieldOptionError":{ "type":"structure", "required":[ "errorCode", "message", "value" ], "members":{ "errorCode":{ "shape":"String", "documentation":"

Error code from creating or updating field option.

" }, "message":{ "shape":"String", "documentation":"

Error message from creating or updating field option.

" }, "value":{ "shape":"FieldOptionValue", "documentation":"

The field option value that caused the error.

" } }, "documentation":"

Object for field Options errors.

" }, "FieldOptionName":{ "type":"string", "max":100, "min":1, "pattern":"^.*[\\S]$" }, "FieldOptionValue":{ "type":"string", "max":100, "min":1, "pattern":"^.*[\\S]$" }, "FieldOptionsList":{ "type":"list", "member":{"shape":"FieldOption"} }, "FieldSummary":{ "type":"structure", "required":[ "fieldArn", "fieldId", "name", "namespace", "type" ], "members":{ "fieldArn":{ "shape":"FieldArn", "documentation":"

The Amazon Resource Name (ARN) of the field.

" }, "fieldId":{ "shape":"FieldId", "documentation":"

The unique identifier of a field.

" }, "name":{ "shape":"FieldName", "documentation":"

Name of the field.

" }, "namespace":{ "shape":"FieldNamespace", "documentation":"

The namespace of a field.

" }, "type":{ "shape":"FieldType", "documentation":"

The type of a field.

" } }, "documentation":"

Object for the summarized details of the field.

" }, "FieldType":{ "type":"string", "enum":[ "Text", "Number", "Boolean", "DateTime", "SingleSelect", "Url" ] }, "FieldValue":{ "type":"structure", "required":[ "id", "value" ], "members":{ "id":{ "shape":"FieldId", "documentation":"

Unique identifier of a field.

" }, "value":{ "shape":"FieldValueUnion", "documentation":"

Union of potential field value types.

" } }, "documentation":"

Object for case field values.

" }, "FieldValueUnion":{ "type":"structure", "members":{ "booleanValue":{ "shape":"Boolean", "documentation":"

Can be either null, or have a Boolean value type. Only one value can be provided.

" }, "doubleValue":{ "shape":"Double", "documentation":"

Can be either null, or have a Double number value type. Only one value can be provided.

" }, "emptyValue":{ "shape":"EmptyFieldValue", "documentation":"

An empty value.

" }, "stringValue":{ "shape":"FieldValueUnionStringValueString", "documentation":"

String value type.

" } }, "documentation":"

Object to store union of Field values.

", "union":true }, "FieldValueUnionStringValueString":{ "type":"string", "max":1500, "min":0 }, "GetCaseEventConfigurationRequest":{ "type":"structure", "required":["domainId"], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" } } }, "GetCaseEventConfigurationResponse":{ "type":"structure", "required":["eventBridge"], "members":{ "eventBridge":{ "shape":"EventBridgeConfiguration", "documentation":"

Configuration to enable EventBridge case event delivery and determine what data is delivered.

" } } }, "GetCaseRequest":{ "type":"structure", "required":[ "caseId", "domainId", "fields" ], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

A unique identifier of the case.

", "location":"uri", "locationName":"caseId" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "fields":{ "shape":"GetCaseRequestFieldsList", "documentation":"

A list of unique field identifiers.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "GetCaseRequestFieldsList":{ "type":"list", "member":{"shape":"FieldIdentifier"}, "max":100, "min":1 }, "GetCaseResponse":{ "type":"structure", "required":[ "fields", "templateId" ], "members":{ "fields":{ "shape":"GetCaseResponseFieldsList", "documentation":"

A list of detailed field information.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. This is null if there are no more results to return.

" }, "tags":{ "shape":"Tags", "documentation":"

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.

" }, "templateId":{ "shape":"TemplateId", "documentation":"

A unique identifier of a template.

" } } }, "GetCaseResponseFieldsList":{ "type":"list", "member":{"shape":"FieldValue"}, "max":100, "min":0 }, "GetDomainRequest":{ "type":"structure", "required":["domainId"], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" } } }, "GetDomainResponse":{ "type":"structure", "required":[ "createdTime", "domainArn", "domainId", "domainStatus", "name" ], "members":{ "createdTime":{ "shape":"CreatedTime", "documentation":"

The timestamp when the Cases domain was created.

" }, "domainArn":{ "shape":"DomainArn", "documentation":"

The Amazon Resource Name (ARN) for the Cases domain.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

" }, "domainStatus":{ "shape":"DomainStatus", "documentation":"

The status of the Cases domain.

" }, "name":{ "shape":"DomainName", "documentation":"

The name of the Cases domain.

" }, "tags":{ "shape":"Tags", "documentation":"

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.

" } } }, "GetFieldResponse":{ "type":"structure", "required":[ "fieldArn", "fieldId", "name", "namespace", "type" ], "members":{ "description":{ "shape":"FieldDescription", "documentation":"

Description of the field.

" }, "fieldArn":{ "shape":"FieldArn", "documentation":"

The Amazon Resource Name (ARN) of the field.

" }, "fieldId":{ "shape":"FieldId", "documentation":"

Unique identifier of the field.

" }, "name":{ "shape":"FieldName", "documentation":"

Name of the field.

" }, "namespace":{ "shape":"FieldNamespace", "documentation":"

Namespace of the field.

" }, "tags":{ "shape":"Tags", "documentation":"

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":{ "shape":"FieldType", "documentation":"

Type of the field.

" } }, "documentation":"

Object to store detailed field information.

" }, "GetLayoutRequest":{ "type":"structure", "required":[ "domainId", "layoutId" ], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "layoutId":{ "shape":"LayoutId", "documentation":"

The unique identifier of the layout.

", "location":"uri", "locationName":"layoutId" } } }, "GetLayoutResponse":{ "type":"structure", "required":[ "content", "layoutArn", "layoutId", "name" ], "members":{ "content":{ "shape":"LayoutContent", "documentation":"

Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.

" }, "layoutArn":{ "shape":"LayoutArn", "documentation":"

The Amazon Resource Name (ARN) of the newly created layout.

" }, "layoutId":{ "shape":"LayoutId", "documentation":"

The unique identifier of the layout.

" }, "name":{ "shape":"LayoutName", "documentation":"

The name of the layout. It must be unique.

" }, "tags":{ "shape":"Tags", "documentation":"

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.

" } } }, "GetTemplateRequest":{ "type":"structure", "required":[ "domainId", "templateId" ], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "templateId":{ "shape":"TemplateId", "documentation":"

A unique identifier of a template.

", "location":"uri", "locationName":"templateId" } } }, "GetTemplateResponse":{ "type":"structure", "required":[ "name", "status", "templateArn", "templateId" ], "members":{ "description":{ "shape":"TemplateDescription", "documentation":"

A brief description of the template.

" }, "layoutConfiguration":{ "shape":"LayoutConfiguration", "documentation":"

Configuration of layouts associated to the template.

" }, "name":{ "shape":"TemplateName", "documentation":"

The name of the template.

" }, "requiredFields":{ "shape":"RequiredFieldList", "documentation":"

A list of fields that must contain a value for a case to be successfully created with this template.

" }, "status":{ "shape":"TemplateStatus", "documentation":"

The status of the template.

" }, "tags":{ "shape":"Tags", "documentation":"

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.

" }, "templateArn":{ "shape":"TemplateArn", "documentation":"

The Amazon Resource Name (ARN) of the template.

" }, "templateId":{ "shape":"TemplateId", "documentation":"

A unique identifier of a template.

" } } }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "retryAfterSeconds":{ "shape":"Integer", "documentation":"

Advice to clients on when the call can be safely retried.

", "location":"header", "locationName":"Retry-After" } }, "documentation":"

We couldn't process your request because of an issue with the server. Try again later.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "LayoutArn":{ "type":"string", "max":500, "min":1 }, "LayoutConfiguration":{ "type":"structure", "members":{ "defaultLayout":{ "shape":"LayoutId", "documentation":"

Unique identifier of a layout.

" } }, "documentation":"

Object to store configuration of layouts associated to the template.

" }, "LayoutContent":{ "type":"structure", "members":{ "basic":{ "shape":"BasicLayout", "documentation":"

Content specific to `BasicLayout` type. It configures fields in the top panel and More Info tab of Cases user interface.

" } }, "documentation":"

Object to store union of different versions of layout content.

", "union":true }, "LayoutId":{ "type":"string", "max":500, "min":1 }, "LayoutName":{ "type":"string", "max":100, "min":1, "pattern":"^.*[\\S]$" }, "LayoutSections":{ "type":"structure", "members":{ "sections":{"shape":"SectionsList"} }, "documentation":"

Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.

" }, "LayoutSummary":{ "type":"structure", "required":[ "layoutArn", "layoutId", "name" ], "members":{ "layoutArn":{ "shape":"LayoutArn", "documentation":"

The Amazon Resource Name (ARN) of the layout.

" }, "layoutId":{ "shape":"LayoutId", "documentation":"

The unique identifier for of the layout.

" }, "name":{ "shape":"LayoutName", "documentation":"

The name of the layout.

" } }, "documentation":"

Object for the summarized details of the layout.

" }, "LayoutSummaryList":{ "type":"list", "member":{"shape":"LayoutSummary"} }, "ListCasesForContactRequest":{ "type":"structure", "required":[ "contactArn", "domainId" ], "members":{ "contactArn":{ "shape":"ContactArn", "documentation":"

A unique identifier of a contact in Amazon Connect.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "maxResults":{ "shape":"ListCasesForContactRequestMaxResultsInteger", "documentation":"

The maximum number of results to return per page.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "ListCasesForContactRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":10, "min":1 }, "ListCasesForContactResponse":{ "type":"structure", "required":["cases"], "members":{ "cases":{ "shape":"ListCasesForContactResponseCasesList", "documentation":"

A list of Case summary information.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. This is null if there are no more results to return.

" } } }, "ListCasesForContactResponseCasesList":{ "type":"list", "member":{"shape":"CaseSummary"}, "max":10, "min":0 }, "ListDomainsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListDomainsRequestMaxResultsInteger", "documentation":"

The maximum number of results to return per page.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListDomainsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":10, "min":1 }, "ListDomainsResponse":{ "type":"structure", "required":["domains"], "members":{ "domains":{ "shape":"DomainSummaryList", "documentation":"

The Cases domain.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. This is null if there are no more results to return.

" } } }, "ListFieldOptionsRequest":{ "type":"structure", "required":[ "domainId", "fieldId" ], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "fieldId":{ "shape":"FieldId", "documentation":"

The unique identifier of a field.

", "location":"uri", "locationName":"fieldId" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return per page.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "values":{ "shape":"ValuesList", "documentation":"

A list of `FieldOption` values to filter on for `ListFieldOptions`.

", "location":"querystring", "locationName":"values" } } }, "ListFieldOptionsResponse":{ "type":"structure", "required":["options"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. This is null if there are no more results to return.

" }, "options":{ "shape":"FieldOptionsList", "documentation":"

A list of `FieldOption` objects.

" } } }, "ListFieldsRequest":{ "type":"structure", "required":["domainId"], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return per page.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListFieldsResponse":{ "type":"structure", "required":["fields"], "members":{ "fields":{ "shape":"ListFieldsResponseFieldsList", "documentation":"

List of detailed field information.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. This is null if there are no more results to return.

" } } }, "ListFieldsResponseFieldsList":{ "type":"list", "member":{"shape":"FieldSummary"}, "max":100, "min":0 }, "ListLayoutsRequest":{ "type":"structure", "required":["domainId"], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return per page.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListLayoutsResponse":{ "type":"structure", "required":["layouts"], "members":{ "layouts":{ "shape":"LayoutSummaryList", "documentation":"

The layouts for the domain.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. This is null if there are no more results to return.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN)

", "location":"uri", "locationName":"arn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"Tags", "documentation":"

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.

" } } }, "ListTemplatesRequest":{ "type":"structure", "required":["domainId"], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return per page.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "status":{ "shape":"TemplateStatusFilters", "documentation":"

A list of status values to filter on.

", "location":"querystring", "locationName":"status" } } }, "ListTemplatesResponse":{ "type":"structure", "required":["templates"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. This is null if there are no more results to return.

" }, "templates":{ "shape":"ListTemplatesResponseTemplatesList", "documentation":"

List of template summary objects.

" } } }, "ListTemplatesResponseTemplatesList":{ "type":"list", "member":{"shape":"TemplateSummary"}, "max":100, "min":0 }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "NextToken":{ "type":"string", "max":9000, "min":0 }, "Order":{ "type":"string", "enum":[ "Asc", "Desc" ] }, "PutCaseEventConfigurationRequest":{ "type":"structure", "required":[ "domainId", "eventBridge" ], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "eventBridge":{ "shape":"EventBridgeConfiguration", "documentation":"

Configuration to enable EventBridge case event delivery and determine what data is delivered.

" } } }, "PutCaseEventConfigurationResponse":{ "type":"structure", "members":{ } }, "RelatedItemArn":{ "type":"string", "max":500, "min":1 }, "RelatedItemContent":{ "type":"structure", "members":{ "comment":{ "shape":"CommentContent", "documentation":"

Represents the content of a comment to be returned to agents.

" }, "contact":{ "shape":"ContactContent", "documentation":"

Represents the content of a contact to be returned to agents.

" } }, "documentation":"

Represents the content of a particular type of related item.

", "union":true }, "RelatedItemEventIncludedData":{ "type":"structure", "required":["includeContent"], "members":{ "includeContent":{ "shape":"Boolean", "documentation":"

Details of what related item data is published through the case event stream.

" } }, "documentation":"

Details of what related item data is published through the case event stream.

" }, "RelatedItemId":{ "type":"string", "max":500, "min":1 }, "RelatedItemInputContent":{ "type":"structure", "members":{ "comment":{ "shape":"CommentContent", "documentation":"

Represents the content of a comment to be returned to agents.

" }, "contact":{ "shape":"Contact", "documentation":"

Object representing a contact in Amazon Connect as an API request field.

" } }, "documentation":"

Represents the content of a related item to be created.

", "union":true }, "RelatedItemType":{ "type":"string", "enum":[ "Contact", "Comment" ] }, "RelatedItemTypeFilter":{ "type":"structure", "members":{ "comment":{ "shape":"CommentFilter", "documentation":"

A filter for related items of type `Comment`.

" }, "contact":{ "shape":"ContactFilter", "documentation":"

A filter for related items of type `Contact`.

" } }, "documentation":"

The list of types of related items and their parameters to use for filtering.

", "union":true }, "RequiredField":{ "type":"structure", "required":["fieldId"], "members":{ "fieldId":{ "shape":"FieldId", "documentation":"

Unique identifier of a field.

" } }, "documentation":"

List of fields that must have a value provided to create a case.

" }, "RequiredFieldList":{ "type":"list", "member":{"shape":"RequiredField"}, "max":100, "min":0 }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"

Unique identifier of the resource affected.

" }, "resourceType":{ "shape":"String", "documentation":"

Type of the resource affected.

" } }, "documentation":"

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "SearchCasesRequest":{ "type":"structure", "required":["domainId"], "members":{ "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "fields":{ "shape":"SearchCasesRequestFieldsList", "documentation":"

The list of field identifiers to be returned as part of the response.

" }, "filter":{ "shape":"CaseFilter", "documentation":"

A list of filter objects.

" }, "maxResults":{ "shape":"SearchCasesRequestMaxResultsInteger", "documentation":"

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "searchTerm":{ "shape":"SearchCasesRequestSearchTermString", "documentation":"

A word or phrase used to perform a quick search.

" }, "sorts":{ "shape":"SearchCasesRequestSortsList", "documentation":"

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

" } } }, "SearchCasesRequestFieldsList":{ "type":"list", "member":{"shape":"FieldIdentifier"}, "max":10, "min":0 }, "SearchCasesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":25, "min":1 }, "SearchCasesRequestSearchTermString":{ "type":"string", "max":255, "min":0 }, "SearchCasesRequestSortsList":{ "type":"list", "member":{"shape":"Sort"}, "max":2, "min":0 }, "SearchCasesResponse":{ "type":"structure", "required":["cases"], "members":{ "cases":{ "shape":"SearchCasesResponseCasesList", "documentation":"

A list of case documents where each case contains the properties `CaseId` and `Fields` where each field is a complex union structure.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. This is null if there are no more results to return.

" } } }, "SearchCasesResponseCasesList":{ "type":"list", "member":{"shape":"SearchCasesResponseItem"}, "max":25, "min":0 }, "SearchCasesResponseItem":{ "type":"structure", "required":[ "caseId", "fields", "templateId" ], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

A unique identifier of the case.

" }, "fields":{ "shape":"SearchCasesResponseItemFieldsList", "documentation":"

List of case field values.

" }, "tags":{ "shape":"Tags", "documentation":"

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.

" }, "templateId":{ "shape":"TemplateId", "documentation":"

A unique identifier of a template.

" } }, "documentation":"

A list of items that represent cases.

" }, "SearchCasesResponseItemFieldsList":{ "type":"list", "member":{"shape":"FieldValue"}, "max":10, "min":0 }, "SearchRelatedItemsRequest":{ "type":"structure", "required":[ "caseId", "domainId" ], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

A unique identifier of the case.

", "location":"uri", "locationName":"caseId" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "filters":{ "shape":"SearchRelatedItemsRequestFiltersList", "documentation":"

The list of types of related items and their parameters to use for filtering.

" }, "maxResults":{ "shape":"SearchRelatedItemsRequestMaxResultsInteger", "documentation":"

The maximum number of results to return per page.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "SearchRelatedItemsRequestFiltersList":{ "type":"list", "member":{"shape":"RelatedItemTypeFilter"}, "max":10, "min":0 }, "SearchRelatedItemsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":25, "min":1 }, "SearchRelatedItemsResponse":{ "type":"structure", "required":["relatedItems"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results. This is null if there are no more results to return.

" }, "relatedItems":{ "shape":"SearchRelatedItemsResponseRelatedItemsList", "documentation":"

A list of items related to a case.

" } } }, "SearchRelatedItemsResponseItem":{ "type":"structure", "required":[ "associationTime", "content", "relatedItemId", "type" ], "members":{ "associationTime":{ "shape":"AssociationTime", "documentation":"

Time at which a related item was associated with a case.

" }, "content":{ "shape":"RelatedItemContent", "documentation":"

Represents the content of a particular type of related item.

" }, "performedBy":{ "shape":"UserUnion", "documentation":"

Represents the creator of the related item.

" }, "relatedItemId":{ "shape":"RelatedItemId", "documentation":"

Unique identifier of a related item.

" }, "tags":{ "shape":"Tags", "documentation":"

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":{ "shape":"RelatedItemType", "documentation":"

Type of a related item.

" } }, "documentation":"

A list of items that represent RelatedItems.

" }, "SearchRelatedItemsResponseRelatedItemsList":{ "type":"list", "member":{"shape":"SearchRelatedItemsResponseItem"}, "max":25, "min":0 }, "Section":{ "type":"structure", "members":{ "fieldGroup":{ "shape":"FieldGroup", "documentation":"

Consists of a group of fields and associated properties.

" } }, "documentation":"

This represents a sections within a panel or tab of the page layout.

", "union":true }, "SectionsList":{ "type":"list", "member":{"shape":"Section"}, "documentation":"

Ordered list containing different kinds of sections that can be added.

", "max":1, "min":0 }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "Sort":{ "type":"structure", "required":[ "fieldId", "sortOrder" ], "members":{ "fieldId":{ "shape":"FieldId", "documentation":"

Unique identifier of a field.

" }, "sortOrder":{ "shape":"Order", "documentation":"

A structured set of sort terms

" } }, "documentation":"

A structured set of sort terms.

" }, "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "arn", "tags" ], "members":{ "arn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN)

", "location":"uri", "locationName":"arn" }, "tags":{ "shape":"Tags", "documentation":"

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.

" } } }, "Tags":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "TemplateArn":{ "type":"string", "max":500, "min":1 }, "TemplateDescription":{ "type":"string", "max":255, "min":0 }, "TemplateId":{ "type":"string", "max":500, "min":1 }, "TemplateName":{ "type":"string", "max":100, "min":1, "pattern":"^.*[\\S]$" }, "TemplateStatus":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "TemplateStatusFilters":{ "type":"list", "member":{"shape":"TemplateStatus"}, "max":2, "min":1 }, "TemplateSummary":{ "type":"structure", "required":[ "name", "status", "templateArn", "templateId" ], "members":{ "name":{ "shape":"TemplateName", "documentation":"

The template name.

" }, "status":{ "shape":"TemplateStatus", "documentation":"

The status of the template.

" }, "templateArn":{ "shape":"TemplateArn", "documentation":"

The Amazon Resource Name (ARN) of the template.

" }, "templateId":{ "shape":"TemplateId", "documentation":"

The unique identifier for the template.

" } }, "documentation":"

Template summary information.

" }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The rate has been exceeded for this API. Please try again after a few minutes.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "UntagResourceRequest":{ "type":"structure", "required":[ "arn", "tagKeys" ], "members":{ "arn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN)

", "location":"uri", "locationName":"arn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

List of tag keys.

", "location":"querystring", "locationName":"tagKeys" } } }, "UpdateCaseRequest":{ "type":"structure", "required":[ "caseId", "domainId", "fields" ], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

A unique identifier of the case.

", "location":"uri", "locationName":"caseId" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "fields":{ "shape":"UpdateCaseRequestFieldsList", "documentation":"

An array of objects with `fieldId` (matching ListFields/DescribeField) and value union data, structured identical to `CreateCase`.

" } } }, "UpdateCaseRequestFieldsList":{ "type":"list", "member":{"shape":"FieldValue"}, "max":100, "min":0 }, "UpdateCaseResponse":{ "type":"structure", "members":{ } }, "UpdateFieldRequest":{ "type":"structure", "required":[ "domainId", "fieldId" ], "members":{ "description":{ "shape":"FieldDescription", "documentation":"

The description of a field.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "fieldId":{ "shape":"FieldId", "documentation":"

The unique identifier of a field.

", "location":"uri", "locationName":"fieldId" }, "name":{ "shape":"FieldName", "documentation":"

The name of the field.

" } } }, "UpdateFieldResponse":{ "type":"structure", "members":{ } }, "UpdateLayoutRequest":{ "type":"structure", "required":[ "domainId", "layoutId" ], "members":{ "content":{ "shape":"LayoutContent", "documentation":"

Information about which fields will be present in the layout, the order of the fields.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "layoutId":{ "shape":"LayoutId", "documentation":"

The unique identifier of the layout.

", "location":"uri", "locationName":"layoutId" }, "name":{ "shape":"LayoutName", "documentation":"

The name of the layout. It must be unique per domain.

" } } }, "UpdateLayoutResponse":{ "type":"structure", "members":{ } }, "UpdateTemplateRequest":{ "type":"structure", "required":[ "domainId", "templateId" ], "members":{ "description":{ "shape":"TemplateDescription", "documentation":"

A brief description of the template.

" }, "domainId":{ "shape":"DomainId", "documentation":"

The unique identifier of the Cases domain.

", "location":"uri", "locationName":"domainId" }, "layoutConfiguration":{ "shape":"LayoutConfiguration", "documentation":"

Configuration of layouts associated to the template.

" }, "name":{ "shape":"TemplateName", "documentation":"

The name of the template. It must be unique per domain.

" }, "requiredFields":{ "shape":"RequiredFieldList", "documentation":"

A list of fields that must contain a value for a case to be successfully created with this template.

" }, "status":{ "shape":"TemplateStatus", "documentation":"

The status of the template.

" }, "templateId":{ "shape":"TemplateId", "documentation":"

A unique identifier for the template.

", "location":"uri", "locationName":"templateId" } } }, "UpdateTemplateResponse":{ "type":"structure", "members":{ } }, "UserArn":{ "type":"string", "max":500, "min":1 }, "UserUnion":{ "type":"structure", "members":{ "userArn":{ "shape":"UserArn", "documentation":"

Represents the Amazon Connect ARN of the user.

" } }, "documentation":"

Represents the identity of the person who performed the action.

", "union":true }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The request isn't valid. Check the syntax and try again.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "Value":{ "type":"string", "max":100, "min":0 }, "ValuesList":{ "type":"list", "member":{"shape":"Value"}, "max":1, "min":0 } }, "documentation":"

With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Cases in the Amazon Connect Administrator Guide.

" }