{ "smithy": "2.0", "shapes": { "com.amazonaws.connectcases#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "
You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.connectcases#AmazonConnectCases": { "type": "service", "version": "2022-10-03", "operations": [ { "target": "com.amazonaws.connectcases#ListTagsForResource" }, { "target": "com.amazonaws.connectcases#TagResource" }, { "target": "com.amazonaws.connectcases#UntagResource" } ], "resources": [ { "target": "com.amazonaws.connectcases#Case" }, { "target": "com.amazonaws.connectcases#CaseRule" }, { "target": "com.amazonaws.connectcases#Domain" }, { "target": "com.amazonaws.connectcases#Field" }, { "target": "com.amazonaws.connectcases#Layout" }, { "target": "com.amazonaws.connectcases#Template" } ], "traits": { "aws.api#service": { "sdkId": "ConnectCases", "arnNamespace": "cases", "cloudTrailEventSource": "event-source-placeholder", "endpointPrefix": "cases" }, "aws.auth#sigv4": { "name": "cases" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "*", "Authorization", "Date", "X-Amz-Date", "X-Amz-Security-Token", "X-Amz-Target", "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id" ] }, "smithy.api#documentation": "With Connect Customer 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 Connect Customer Cases in the Connect Customer Administrator Guide.
", "smithy.api#title": "Amazon Connect Cases", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cases-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cases-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cases.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cases.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://cases-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://cases-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://cases.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://cases.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cases-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cases.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cases-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cases.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cases-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cases.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cases.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.connectcases#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#AssociationTime": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.connectcases#AuditEvent": { "type": "structure", "members": { "eventId": { "target": "com.amazonaws.connectcases#AuditEventId", "traits": { "smithy.api#documentation": "Unique identifier of a case audit history event.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcases#AuditEventType", "traits": { "smithy.api#documentation": "The type of audit history event.
Valid Values: Case.Created | Case.Updated | RelatedItem.Created | RelatedItem.Updated | RelatedItem.Deleted | Case.Merged
Case.Merged summarizes a merge on each of the two cases that took part in it.
The Type of the related item.
" } }, "performedTime": { "target": "com.amazonaws.connectcases#AuditEventDateTime", "traits": { "smithy.api#documentation": "Time at which an Audit History event took place.
", "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.connectcases#AuditEventFieldList", "traits": { "smithy.api#documentation": "A list of Case Audit History event fields.
", "smithy.api#required": {} } }, "performedBy": { "target": "com.amazonaws.connectcases#AuditEventPerformedBy", "traits": { "smithy.api#documentation": "Information of the user which performed the audit.
" } }, "mergeMetadata": { "target": "com.amazonaws.connectcases#AuditMergeMetadata", "traits": { "smithy.api#documentation": "Information about the merge that produced this audit event. Present only on audit events produced by a merge. For more information, see StartMergeCases.
" } } }, "traits": { "smithy.api#documentation": "Represents the content of a particular audit event.
" } }, "com.amazonaws.connectcases#AuditEventDateTime": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.connectcases#AuditEventField": { "type": "structure", "members": { "eventFieldId": { "target": "com.amazonaws.connectcases#AuditEventFieldId", "traits": { "smithy.api#documentation": "Unique identifier of field in an Audit History entry.
", "smithy.api#required": {} } }, "oldValue": { "target": "com.amazonaws.connectcases#AuditEventFieldValueUnion", "traits": { "smithy.api#documentation": "Union of potential field value types.
" } }, "newValue": { "target": "com.amazonaws.connectcases#AuditEventFieldValueUnion", "traits": { "smithy.api#documentation": "Union of potential field value types.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Fields for audit event.
" } }, "com.amazonaws.connectcases#AuditEventFieldId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#AuditEventFieldList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#AuditEventField" }, "traits": { "smithy.api#sparse": {} } }, "com.amazonaws.connectcases#AuditEventFieldValueUnion": { "type": "union", "members": { "stringValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Can be either null, or have a String value type. Only one value can be provided.
", "smithy.api#length": { "max": 4100 } } }, "doubleValue": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "Can be either null, or have a Double value type. Only one value can be provided.
" } }, "booleanValue": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Can be either null, or have a Boolean value type. Only one value can be provided.
" } }, "emptyValue": { "target": "com.amazonaws.connectcases#EmptyFieldValue" }, "userArnValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Can be either null, or have a String value type formatted as an ARN. Only one value can be provided.
" } } }, "traits": { "smithy.api#documentation": "Object to store union of Field values.
" } }, "com.amazonaws.connectcases#AuditEventId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#AuditEventPerformedBy": { "type": "structure", "members": { "user": { "target": "com.amazonaws.connectcases#UserUnion" }, "iamPrincipalArn": { "target": "com.amazonaws.connectcases#IamPrincipalArn", "traits": { "smithy.api#documentation": "Unique identifier of an IAM role.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information of the user which performed the audit.
" } }, "com.amazonaws.connectcases#AuditEventType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Case.Created", "name": "CASE_CREATED" }, { "value": "Case.Updated", "name": "CASE_UPDATED" }, { "value": "RelatedItem.Created", "name": "RELATED_ITEM_CREATED" }, { "value": "RelatedItem.Deleted", "name": "RELATED_ITEM_DELETED" }, { "value": "RelatedItem.Updated", "name": "RELATED_ITEM_UPDATED" }, { "value": "Case.Merged", "name": "CASE_MERGED" } ] } }, "com.amazonaws.connectcases#AuditEventsList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#AuditEvent" }, "traits": { "smithy.api#sparse": {} } }, "com.amazonaws.connectcases#AuditMergeMetadata": { "type": "structure", "members": { "mergeEventId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the merge. All audit events produced by the same merge, on both cases, have the same value. Use it to group the changes that a merge made.
", "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#required": {} } }, "primaryCaseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "The unique identifier of the primary case of the merge.
", "smithy.api#required": {} } }, "secondaryCaseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "The unique identifier of the secondary case of the merge.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the merge that produced an audit event.
" } }, "com.amazonaws.connectcases#AutoIncludeFields": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "All", "name": "ALL", "documentation": "All fields on the case" }, { "value": "System", "name": "SYSTEM", "documentation": "System fields only" }, { "value": "Custom", "name": "CUSTOM", "documentation": "Custom fields only" } ] } }, "com.amazonaws.connectcases#BasicLayout": { "type": "structure", "members": { "topPanel": { "target": "com.amazonaws.connectcases#LayoutSections", "traits": { "smithy.api#documentation": "This represents sections in a panel of the page layout.
" } }, "moreInfo": { "target": "com.amazonaws.connectcases#LayoutSections", "traits": { "smithy.api#documentation": "This represents sections in a tab of the page layout.
" } } }, "traits": { "smithy.api#documentation": "Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of agent application.
Creates a comment and associates it with multiple cases in a single request. All cases must belong to the same domain. This operation supports only the Comment related item type.
Each case is processed independently. If some cases fail, the remaining cases still receive the related item. To determine whether individual items failed, inspect the failedItems array in the response.
The entire request fails, and no related items are created, in the following cases:
The specified domain doesn't exist.
A reference ID doesn't match any case in the domain.
The request contains duplicate case IDs.
The content isn't comment content.
This operation uses the same IAM action as CreateRelatedItem (cases:CreateRelatedItem). You can use the cases:IsBatchAction condition key in IAM policies to allow or deny batch operations independently from single-case operations.
If you provide a value for performedBy.userArn, you must also have DescribeUser permission on the ARN of the user that you provide.
Endpoints: See Connect Customer endpoints and quotas.
", "smithy.api#http": { "uri": "/cases:batchCreateRelatedItem", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#BatchCreateRelatedItemErrorEntry": { "type": "structure", "members": { "caseIdentifier": { "target": "com.amazonaws.connectcases#CaseIdentifier", "traits": { "smithy.api#documentation": "The identifiers of the case that the related item wasn't created for.
", "smithy.api#required": {} } }, "errorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The error code. For possible values, see failedItems.
A message that describes the error.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about a related item that wasn't created.
" } }, "com.amazonaws.connectcases#BatchCreateRelatedItemErrorEntryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#BatchCreateRelatedItemErrorEntry" } }, "com.amazonaws.connectcases#BatchCreateRelatedItemIdentifier": { "type": "structure", "members": { "caseIdentifier": { "target": "com.amazonaws.connectcases#CaseIdentifierUnion", "traits": { "smithy.api#documentation": "The identifier of the case to associate the related item with. Specify either the case ID or the reference ID.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Identifies a case to associate the related item with in a BatchCreateRelatedItem request.
The unique identifier of the Cases domain.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.connectcases#RelatedItemInputContent", "traits": { "smithy.api#documentation": "The content of the related item to be created. The same content is applied to every case in the request. Only comment content is supported for batch creation.
", "smithy.api#required": {} } }, "cases": { "target": "com.amazonaws.connectcases#BatchCreateRelatedItemIdentifierList", "traits": { "smithy.api#documentation": "The list of cases to associate the related item with. All cases must belong to the same domain.
", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#required": {} } }, "performedBy": { "target": "com.amazonaws.connectcases#UserUnion", "traits": { "smithy.api#documentation": "The entity that created the related item.
" } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#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.
If you retry a request with the same client token, the service returns the original response instead of processing the request again. If you reuse a client token with different request parameters, the request fails with a ConflictException.
The list of related items that were successfully created and associated with their cases.
", "smithy.api#required": {} } }, "failedItems": { "target": "com.amazonaws.connectcases#BatchCreateRelatedItemErrorEntryList", "traits": { "smithy.api#documentation": "The list of related items that were not created. Each entry includes an error code and message. Possible error codes include:
CASE_NOT_FOUND - No case exists with the specified case ID.
VALIDATION_ERROR - The request contains invalid input.
CONFLICT - Another operation is in progress on the case, such as a concurrent update or a merge of the case into another case.
THROTTLED - The request rate exceeded the allowed limit.
ACCESS_DENIED - The caller lacks permission to perform the operation.
SERVICE_QUOTA_EXCEEDED - The request exceeded a service quota.
DOMAIN_NOT_FOUND - The case domain was deleted while the request was being processed.
INTERNAL_ERROR - An unexpected error occurred on the server.
The identifiers of the case that the related item is associated with.
", "smithy.api#required": {} } }, "relatedItemId": { "target": "com.amazonaws.connectcases#RelatedItemId", "traits": { "smithy.api#documentation": "The unique identifier of the related item.
", "smithy.api#required": {} } }, "relatedItemArn": { "target": "com.amazonaws.connectcases#RelatedItemArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the related item.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about a related item that was created.
" } }, "com.amazonaws.connectcases#BatchCreateRelatedItemSuccessEntryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#BatchCreateRelatedItemSuccessEntry" } }, "com.amazonaws.connectcases#BatchGetCaseRule": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#BatchGetCaseRuleRequest" }, "output": { "target": "com.amazonaws.connectcases#BatchGetCaseRuleResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets a batch of case rules. In the Connect Customer 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.
", "smithy.api#http": { "uri": "/domains/{domainId}/rules-batch", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#BatchGetCaseRuleErrorList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#CaseRuleError" } }, "com.amazonaws.connectcases#BatchGetCaseRuleList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#GetCaseRuleResponse" } }, "com.amazonaws.connectcases#BatchGetCaseRuleRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "Unique identifier of a Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseRules": { "target": "com.amazonaws.connectcases#CaseRuleIdentifierList", "traits": { "smithy.api#documentation": "A list of case rule identifiers.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#BatchGetCaseRuleResponse": { "type": "structure", "members": { "caseRules": { "target": "com.amazonaws.connectcases#BatchGetCaseRuleList", "traits": { "smithy.api#documentation": "A list of detailed case rule information.
", "smithy.api#length": { "max": 50 }, "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.connectcases#BatchGetCaseRuleErrorList", "traits": { "smithy.api#documentation": "A list of case rule errors.
", "smithy.api#length": { "max": 50 }, "smithy.api#required": {} } }, "unprocessedCaseRules": { "target": "com.amazonaws.connectcases#BatchGetCaseRuleUnprocessedList", "traits": { "smithy.api#documentation": "A list of unprocessed case rule identifiers.
", "smithy.api#length": { "max": 50 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#BatchGetCaseRuleUnprocessedList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#CaseRuleId" } }, "com.amazonaws.connectcases#BatchGetField": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#BatchGetFieldRequest" }, "output": { "target": "com.amazonaws.connectcases#BatchGetFieldResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the description for the list of fields in the request parameters.
", "smithy.api#http": { "uri": "/domains/{domainId}/fields-batch", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#BatchGetFieldErrorList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldError" } }, "com.amazonaws.connectcases#BatchGetFieldIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.connectcases#BatchGetFieldList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#GetFieldResponse" } }, "com.amazonaws.connectcases#BatchGetFieldRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.connectcases#BatchGetFieldIdentifierList", "traits": { "smithy.api#documentation": "A list of unique field identifiers.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#BatchGetFieldResponse": { "type": "structure", "members": { "fields": { "target": "com.amazonaws.connectcases#BatchGetFieldList", "traits": { "smithy.api#documentation": "A list of detailed field information.
", "smithy.api#length": { "max": 50 }, "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.connectcases#BatchGetFieldErrorList", "traits": { "smithy.api#documentation": "A list of field errors.
", "smithy.api#length": { "max": 50 }, "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#BatchPutFieldOptions": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#BatchPutFieldOptionsRequest" }, "output": { "target": "com.amazonaws.connectcases#BatchPutFieldOptionsResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates and updates a set of field options for a single select field in a Cases domain.
", "smithy.api#http": { "uri": "/domains/{domainId}/fields/{fieldId}/options", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#BatchPutFieldOptionsRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "The unique identifier of a field.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "options": { "target": "com.amazonaws.connectcases#FieldOptionsList", "traits": { "smithy.api#documentation": "A list of FieldOption objects.
A list of field errors.
", "smithy.api#length": { "max": 50 } } } } }, "com.amazonaws.connectcases#BatchUpdateCase": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#BatchUpdateCaseRequest" }, "output": { "target": "com.amazonaws.connectcases#BatchUpdateCaseResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "aws.iam#iamAction": { "name": "UpdateCase", "relativeDocumentation": "API_UpdateCase.html", "resources": { "required": { "Domain": {}, "Case": {}, "Field": {} } } }, "smithy.api#documentation": "Updates fields on multiple cases in a single request. All cases must belong to the same domain. Set the title, status, and customer ID through the top-level title, status, and customerId parameters, and set other fields through the fields array.
Each case is processed independently. If some cases fail, the remaining cases are still updated. To determine whether individual cases failed, inspect the failedCases array in the response.
The entire request fails, and no cases are updated, in the following cases:
The specified domain doesn't exist.
A reference ID doesn't match any case in the domain.
The request contains duplicate case IDs.
The request doesn't specify any update. Provide at least one entry in fields, or a title, status, or customerId.
A field identifier in fields doesn't resolve to a field in the domain, for example, an unknown field name.
A field name contains a pipe (|) or comma (,) character.
fields includes title, status, or customerId.
This operation uses the same IAM action as UpdateCase (cases:UpdateCase). You can use the cases:IsBatchAction condition key in IAM policies to allow or deny batch operations independently from single-case operations.
If you provide a value for performedBy.userArn, you must also have DescribeUser permission on the ARN of the user that you provide.
Endpoints: See Connect Customer endpoints and quotas.
", "smithy.api#http": { "uri": "/cases:batchUpdateCase", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#BatchUpdateCaseErrorEntry": { "type": "structure", "members": { "caseIdentifier": { "target": "com.amazonaws.connectcases#CaseIdentifier", "traits": { "smithy.api#documentation": "The identifiers of the case that wasn't updated.
", "smithy.api#required": {} } }, "errorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The error code. For possible values, see failedCases.
A message that describes the error.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about a case that wasn't updated.
" } }, "com.amazonaws.connectcases#BatchUpdateCaseErrorEntryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#BatchUpdateCaseErrorEntry" } }, "com.amazonaws.connectcases#BatchUpdateCaseIdentifier": { "type": "structure", "members": { "caseIdentifier": { "target": "com.amazonaws.connectcases#CaseIdentifierUnion", "traits": { "smithy.api#documentation": "The identifier of the case to update. Specify either the case ID or the reference ID.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Identifies a case to update in a BatchUpdateCase request.
The unique identifier of the Cases domain.
", "smithy.api#required": {} } }, "cases": { "target": "com.amazonaws.connectcases#BatchUpdateCaseIdentifierList", "traits": { "smithy.api#documentation": "The list of cases to update. All cases must belong to the same domain.
", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.connectcases#FieldValueInputList", "traits": { "smithy.api#documentation": "An array of objects, each with a fieldIdentifier and a value. You can identify each field by its ID or by its name; identifying a field by name is supported only in BatchUpdateCase. The same field values are applied to every case in the request. This field must be present, but can be an empty list when you provide the top-level title, status, or customerId parameters. Do not include title, status, or customerId in this list; set those values only through their top-level parameters. Duplicating them in fields results in a validation error.
The entity that performed the action.
" } }, "title": { "target": "com.amazonaws.connectcases#CaseTitle", "traits": { "smithy.api#documentation": "The title to apply to all cases in the request.
" } }, "status": { "target": "com.amazonaws.connectcases#CaseStatus", "traits": { "smithy.api#documentation": "The status to apply to all cases in the request.
" } }, "customerId": { "target": "com.amazonaws.connectcases#CustomerProfileArn", "traits": { "smithy.api#documentation": "The ARN of the customer profile to associate with all cases in the request.
" } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#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.
If you retry a request with the same client token, the service returns the original response instead of processing the request again. If you reuse a client token with different request parameters, the request fails with a ConflictException.
The list of cases that were successfully updated.
", "smithy.api#required": {} } }, "failedCases": { "target": "com.amazonaws.connectcases#BatchUpdateCaseErrorEntryList", "traits": { "smithy.api#documentation": "The list of cases that were not updated. Each entry includes an error code and message. Possible error codes include:
CASE_NOT_FOUND - No case exists with the specified case ID.
VALIDATION_ERROR - The request contains invalid input.
CONFLICT - Another operation is in progress on the case, such as a concurrent update or a merge of the case into another case.
THROTTLED - The request rate exceeded the allowed limit.
ACCESS_DENIED - The caller lacks permission to perform the operation.
SERVICE_QUOTA_EXCEEDED - The request exceeded a service quota.
DOMAIN_NOT_FOUND - The case domain was deleted while the request was being processed.
INTERNAL_ERROR - An unexpected error occurred on the server.
The identifiers of the updated case.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about a case that was updated.
" } }, "com.amazonaws.connectcases#BatchUpdateCaseSuccessEntryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#BatchUpdateCaseSuccessEntry" } }, "com.amazonaws.connectcases#BooleanCondition": { "type": "union", "members": { "equalTo": { "target": "com.amazonaws.connectcases#BooleanOperands", "traits": { "smithy.api#documentation": "Tests that operandOne is equal to operandTwo.
" } }, "notEqualTo": { "target": "com.amazonaws.connectcases#BooleanOperands", "traits": { "smithy.api#documentation": "Tests that operandOne is not equal to operandTwo.
" } }, "andAll": { "target": "com.amazonaws.connectcases#CompoundCondition", "traits": { "smithy.api#documentation": "Combines multiple conditions with AND operator. All conditions must be true for the compound condition to be true.
" } }, "orAll": { "target": "com.amazonaws.connectcases#CompoundCondition", "traits": { "smithy.api#documentation": "Combines multiple conditions with OR operator. At least one condition must be true for the compound condition to be true.
" } } }, "traits": { "smithy.api#documentation": "Boolean condition for a rule. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#BooleanConditionList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#BooleanCondition" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.connectcases#BooleanOperands": { "type": "structure", "members": { "operandOne": { "target": "com.amazonaws.connectcases#OperandOne", "traits": { "smithy.api#documentation": "Represents the left hand operand in the condition.
", "smithy.api#required": {} } }, "operandTwo": { "target": "com.amazonaws.connectcases#OperandTwo", "traits": { "smithy.api#documentation": "Represents the right hand operand in the condition.
", "smithy.api#required": {} } }, "result": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "The value of the outer rule if the condition evaluates to true.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Boolean operands for a condition. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#Case": { "type": "resource", "identifiers": { "domainId": { "target": "com.amazonaws.connectcases#DomainId" }, "caseId": { "target": "com.amazonaws.connectcases#CaseId" } }, "create": { "target": "com.amazonaws.connectcases#CreateCase" }, "read": { "target": "com.amazonaws.connectcases#GetCase" }, "update": { "target": "com.amazonaws.connectcases#UpdateCase" }, "delete": { "target": "com.amazonaws.connectcases#DeleteCase" }, "operations": [ { "target": "com.amazonaws.connectcases#GetCaseAuditEvents" }, { "target": "com.amazonaws.connectcases#GetMergeCasesStatus" }, { "target": "com.amazonaws.connectcases#StartMergeCases" } ], "collectionOperations": [ { "target": "com.amazonaws.connectcases#BatchCreateRelatedItem" }, { "target": "com.amazonaws.connectcases#BatchUpdateCase" }, { "target": "com.amazonaws.connectcases#ListCasesForContact" }, { "target": "com.amazonaws.connectcases#SearchCases" } ], "resources": [ { "target": "com.amazonaws.connectcases#RelatedItem" } ], "traits": { "aws.api#arn": { "template": "domain/{domainId}/case/{caseId}" } } }, "com.amazonaws.connectcases#CaseArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#CaseEventIncludedData": { "type": "structure", "members": { "fields": { "target": "com.amazonaws.connectcases#FieldIdentifierList", "traits": { "smithy.api#documentation": "List of field identifiers to include in case event data.
", "smithy.api#length": { "max": 400 }, "smithy.api#required": {} } }, "autoIncludeFields": { "target": "com.amazonaws.connectcases#AutoIncludeFields", "traits": { "smithy.api#documentation": "Automatically include a category of fields in case event data, combined as a union with any fields specified in fields. Valid values are All (include all fields on the case), System (include all system fields), and Custom (include all custom fields). When this attribute is set, new fields added to the domain are picked up automatically without another call to PutCaseEventConfiguration. For the full behavior matrix and IAM requirements, see Case event streams in Connect Customer Cases in the Connect Customer Administrator Guide.
Details of what case data is published through the case event stream. Use fields to include a specific list of fields, and use autoIncludeFields to automatically include a category of fields. When both are set, the effective field set is the union of the two.
A list of fields to filter on.
" } }, "not": { "target": "com.amazonaws.connectcases#CaseFilter" }, "tag": { "target": "com.amazonaws.connectcases#TagFilter", "traits": { "smithy.api#documentation": "A list of tags to filter on.
" } }, "andAll": { "target": "com.amazonaws.connectcases#CaseFilterList", "traits": { "smithy.api#documentation": "Provides \"and all\" filtering.
", "smithy.api#length": { "max": 10 } } }, "orAll": { "target": "com.amazonaws.connectcases#CaseFilterList", "traits": { "smithy.api#documentation": "Provides \"or all\" filtering.
", "smithy.api#length": { "max": 10 } } } }, "traits": { "smithy.api#documentation": "A filter for cases. Only one value can be provided.
" } }, "com.amazonaws.connectcases#CaseFilterList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#CaseFilter" } }, "com.amazonaws.connectcases#CaseId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#pattern": "^[A-Za-z0-9\\-._/:#=+-]*$" } }, "com.amazonaws.connectcases#CaseIdList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#CaseId" } }, "com.amazonaws.connectcases#CaseIdentifier": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "The unique identifier of the case.
" } }, "referenceNumber": { "target": "com.amazonaws.connectcases#ReferenceNumber", "traits": { "smithy.api#documentation": "The reference number of the case. Reference numbers aren't guaranteed to be unique. BatchUpdateCase and BatchCreateRelatedItem don't return this value.
The reference ID of the case. Cases created before reference IDs were available don't have one.
" } } }, "traits": { "smithy.api#documentation": "The identifiers of a case that a batch operation returns.
" } }, "com.amazonaws.connectcases#CaseIdentifierUnion": { "type": "union", "members": { "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "The unique identifier of the case.
" } }, "referenceId": { "target": "com.amazonaws.connectcases#ReferenceId", "traits": { "smithy.api#documentation": "The reference ID of the case. Reference IDs are unique within a domain, and uniqueness isn't case sensitive.
" } } }, "traits": { "smithy.api#documentation": "Identifies a case by its case ID or its reference ID. Specify only one member.
" } }, "com.amazonaws.connectcases#CaseRule": { "type": "resource", "identifiers": { "domainId": { "target": "com.amazonaws.connectcases#DomainId" }, "caseRuleId": { "target": "com.amazonaws.connectcases#CaseRuleId" } }, "create": { "target": "com.amazonaws.connectcases#CreateCaseRule" }, "update": { "target": "com.amazonaws.connectcases#UpdateCaseRule" }, "delete": { "target": "com.amazonaws.connectcases#DeleteCaseRule" }, "list": { "target": "com.amazonaws.connectcases#ListCaseRules" }, "collectionOperations": [ { "target": "com.amazonaws.connectcases#BatchGetCaseRule" } ], "traits": { "aws.api#arn": { "template": "domain/{domainId}/case-rule/{caseRuleId}" } } }, "com.amazonaws.connectcases#CaseRuleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#CaseRuleDescription": { "type": "string", "traits": { "smithy.api#length": { "max": 255 } } }, "com.amazonaws.connectcases#CaseRuleDetails": { "type": "union", "members": { "required": { "target": "com.amazonaws.connectcases#RequiredCaseRule", "traits": { "smithy.api#documentation": "Required rule type, used to indicate whether a field is required.
" } }, "fieldOptions": { "target": "com.amazonaws.connectcases#FieldOptionsCaseRule", "traits": { "smithy.api#documentation": "Which options are available in a child field based on the selected value in a parent field.
" } }, "hidden": { "target": "com.amazonaws.connectcases#HiddenCaseRule", "traits": { "smithy.api#documentation": "Whether a field is visible, based on values in other fields.
" } } }, "traits": { "smithy.api#documentation": "Represents what rule type should take place, under what conditions. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#CaseRuleError": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcases#CaseRuleId", "traits": { "smithy.api#documentation": "The case rule identifier that caused the error.
", "smithy.api#required": {} } }, "errorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Error code from getting a case rule.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Error message from getting a case rule.
" } } }, "traits": { "smithy.api#documentation": "Error for batch describe case rules API failure. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#CaseRuleId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#CaseRuleIdentifier": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcases#CaseRuleId", "traits": { "smithy.api#documentation": "Unique identifier of a case rule.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object containing case rule identifier information.
" } }, "com.amazonaws.connectcases#CaseRuleIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#CaseRuleIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.connectcases#CaseRuleName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^.*[\\S]$" } }, "com.amazonaws.connectcases#CaseRuleSummary": { "type": "structure", "members": { "caseRuleId": { "target": "com.amazonaws.connectcases#CaseRuleId", "traits": { "smithy.api#documentation": "Unique identifier of a case rule.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#CaseRuleName", "traits": { "smithy.api#documentation": "Name of the case rule.
", "smithy.api#required": {} } }, "caseRuleArn": { "target": "com.amazonaws.connectcases#CaseRuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the case rule.
", "smithy.api#required": {} } }, "ruleType": { "target": "com.amazonaws.connectcases#RuleType", "traits": { "smithy.api#documentation": "Possible types for a rule.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.connectcases#CaseRuleDescription", "traits": { "smithy.api#documentation": "Description of a case rule.
" } } }, "traits": { "smithy.api#documentation": "Summary information of this case rule. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#CaseRuleSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#CaseRuleSummary" } }, "com.amazonaws.connectcases#CaseStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\s]+$" } }, "com.amazonaws.connectcases#CaseSummary": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#required": {} } }, "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "A unique identifier of a template.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Case summary information.
" } }, "com.amazonaws.connectcases#CaseSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#CaseSummary" } }, "com.amazonaws.connectcases#CaseTitle": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#pattern": "^[\\s\\S]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.connectcases#Channel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.connectcases#ChannelList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#Channel" } }, "com.amazonaws.connectcases#CommentBody": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 15000 } } }, "com.amazonaws.connectcases#CommentBodyTextType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Text/Plain", "name": "PLAINTEXT" } ] } }, "com.amazonaws.connectcases#CommentContent": { "type": "structure", "members": { "body": { "target": "com.amazonaws.connectcases#CommentBody", "traits": { "smithy.api#documentation": "Text in the body of a Comment on a case.
Type of the text in the box of a Comment on a case.
Represents the content of a Comment to be returned to agents.
A filter for related items of type Comment.
Updated text in the body of a Comment on a case.
Type of the text in the box of a Comment on a case.
Represents the updated content of a Comment related item.
The list of conditions to combine using the logical operator.
For API users: A case rule can have a maximum of 5 conditions, spread across a maximum of 2 levels of nesting.
A compound condition that combines multiple boolean conditions using logical operators. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.connectcases#ConnectCaseContent": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the content of a ConnectCase type related item.
A unique identifier of the case.
" } } }, "traits": { "smithy.api#documentation": "A filter for related items of type ConnectCase.
A unique identifier of the case.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the content of a ConnectCase related item.
A unique identifier of a contact in Connect Customer.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that represents an Connect Customer contact object.
" } }, "com.amazonaws.connectcases#ContactArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#ContactContent": { "type": "structure", "members": { "contactArn": { "target": "com.amazonaws.connectcases#ContactArn", "traits": { "smithy.api#documentation": "A unique identifier of a contact in Connect Customer.
", "smithy.api#required": {} } }, "channel": { "target": "com.amazonaws.connectcases#Channel", "traits": { "smithy.api#documentation": "A list of channels to filter on for related items of type Contact.
The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.
An object that represents a content of an Connect Customer contact object.
" } }, "com.amazonaws.connectcases#ContactFilter": { "type": "structure", "members": { "channel": { "target": "com.amazonaws.connectcases#ChannelList", "traits": { "smithy.api#documentation": "A list of channels to filter on for related items of type Contact.
A unique identifier of a contact in Connect Customer.
" } } }, "traits": { "smithy.api#documentation": "A filter for related items of type Contact.
If you provide a value for PerformedBy.UserArn, you must also have the connect:DescribeUser permission on the user ARN 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 field is always required when creating a case:
title
The following field may be required depending on the template configuration:
customer_id - Required only if the template's requiredFields list includes customer_id. When required, 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. When not required, the field is optional and can be omitted, added, changed, or removed after case creation.
The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "A unique identifier of a template.
", "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.connectcases#FieldValueList", "traits": { "smithy.api#documentation": "An array of objects with field ID (matching ListFields/DescribeField) and value union data.
", "smithy.api#length": { "max": 220 }, "smithy.api#required": {} } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#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.
", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "max": 64 } } }, "performedBy": { "target": "com.amazonaws.connectcases#UserUnion" }, "tags": { "target": "com.amazonaws.connectcases#MutableTags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } } } }, "com.amazonaws.connectcases#CreateCaseResponse": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#required": {} } }, "caseArn": { "target": "com.amazonaws.connectcases#CaseArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the case.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#CreateCaseRule": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#CreateCaseRuleRequest" }, "output": { "target": "com.amazonaws.connectcases#CreateCaseRuleResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a new case rule. In the Connect Customer 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.
", "smithy.api#http": { "uri": "/domains/{domainId}/case-rules", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#CreateCaseRuleRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "Unique identifier of a Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#CaseRuleName", "traits": { "smithy.api#documentation": "Name of the case rule.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.connectcases#CaseRuleDescription", "traits": { "smithy.api#documentation": "The description of a case rule.
" } }, "rule": { "target": "com.amazonaws.connectcases#CaseRuleDetails", "traits": { "smithy.api#documentation": "Represents what rule type should take place, under what conditions.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#CreateCaseRuleResponse": { "type": "structure", "members": { "caseRuleId": { "target": "com.amazonaws.connectcases#CaseRuleId", "traits": { "smithy.api#documentation": "Unique identifier of a case rule.
", "smithy.api#required": {} } }, "caseRuleArn": { "target": "com.amazonaws.connectcases#CaseRuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a case rule.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#CreateDomain": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#CreateDomainRequest" }, "output": { "target": "com.amazonaws.connectcases#CreateDomainResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Connect Customer instance can be associated with only one Cases domain.
This will not associate your connect instance to Cases domain. Instead, use the Connect Customer CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.
The name for your Cases domain. It must be unique for your Amazon Web Services account.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#CreateDomainResponse": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#required": {} } }, "domainArn": { "target": "com.amazonaws.connectcases#DomainArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Cases domain.
", "smithy.api#required": {} } }, "domainStatus": { "target": "com.amazonaws.connectcases#DomainStatus", "traits": { "smithy.api#documentation": "The status of the domain.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#CreateField": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#CreateFieldRequest" }, "output": { "target": "com.amazonaws.connectcases#CreateFieldResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#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.
", "smithy.api#http": { "uri": "/domains/{domainId}/fields", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#CreateFieldRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#FieldName", "traits": { "smithy.api#documentation": "The name of the field.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcases#FieldType", "traits": { "smithy.api#documentation": "Defines the data type, some system constraints, and default display of the field.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.connectcases#FieldDescription", "traits": { "smithy.api#documentation": "The description of the field.
" } }, "attributes": { "target": "com.amazonaws.connectcases#FieldAttributes", "traits": { "smithy.api#documentation": "Union of field attributes.
" } } } }, "com.amazonaws.connectcases#CreateFieldResponse": { "type": "structure", "members": { "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "The unique identifier of a field.
", "smithy.api#required": {} } }, "fieldArn": { "target": "com.amazonaws.connectcases#FieldArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the field.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#CreateLayout": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#CreateLayoutRequest" }, "output": { "target": "com.amazonaws.connectcases#CreateLayoutResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#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.
The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#LayoutName", "traits": { "smithy.api#documentation": "The name of the layout. It must be unique for the Cases domain.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.connectcases#LayoutContent", "traits": { "smithy.api#documentation": "Information about which fields will be present in the layout, and information about the order of the fields.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#CreateLayoutResponse": { "type": "structure", "members": { "layoutId": { "target": "com.amazonaws.connectcases#LayoutId", "traits": { "smithy.api#documentation": "The unique identifier of the layout.
", "smithy.api#required": {} } }, "layoutArn": { "target": "com.amazonaws.connectcases#LayoutArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the newly created layout.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#CreateRelatedItem": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#CreateRelatedItemRequest" }, "output": { "target": "com.amazonaws.connectcases#CreateRelatedItemResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "aws.iam#iamAction": { "name": "CreateRelatedItem", "relativeDocumentation": "API_CreateRelatedItem.html", "resources": { "required": { "Domain": {}, "Case": {}, "RelatedItem": {} } }, "createsResources": [ "RelatedItem" ] }, "smithy.api#documentation": "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 Connect Customer Cases quotas.
There's a quota for the number of SLAs that can be attached to a case. See Connect Customer 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 Connect Customer 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 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 permission on the ARN of the user that you provide.
If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.
Endpoints: See Connect Customer endpoints and quotas.
", "smithy.api#http": { "uri": "/domains/{domainId}/cases/{caseId}/related-items/", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#CreateRelatedItemRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcases#RelatedItemType", "traits": { "smithy.api#documentation": "The type of a related item.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.connectcases#RelatedItemInputContent", "traits": { "smithy.api#documentation": "The content of a related item to be created.
", "smithy.api#required": {} } }, "performedBy": { "target": "com.amazonaws.connectcases#UserUnion", "traits": { "smithy.api#documentation": "Represents the creator of the related item.
" } } } }, "com.amazonaws.connectcases#CreateRelatedItemResponse": { "type": "structure", "members": { "relatedItemId": { "target": "com.amazonaws.connectcases#RelatedItemId", "traits": { "smithy.api#documentation": "The unique identifier of the related item.
", "smithy.api#required": {} } }, "relatedItemArn": { "target": "com.amazonaws.connectcases#RelatedItemArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the related item.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#CreateTemplate": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#CreateTemplateRequest" }, "output": { "target": "com.amazonaws.connectcases#CreateTemplateResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#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.
Other template APIs are:
", "smithy.api#http": { "uri": "/domains/{domainId}/templates", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#CreateTemplateRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#TemplateName", "traits": { "smithy.api#documentation": "A name for the template. It must be unique per domain.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.connectcases#TemplateDescription", "traits": { "smithy.api#documentation": "A brief description of the template.
" } }, "layoutConfiguration": { "target": "com.amazonaws.connectcases#LayoutConfiguration", "traits": { "smithy.api#documentation": "Configuration of layouts associated to the template.
" } }, "requiredFields": { "target": "com.amazonaws.connectcases#RequiredFieldList", "traits": { "smithy.api#documentation": "A list of fields that must contain a value for a case to be successfully created with this template.
To require a Customer Profile when creating cases, include customer_id in this list. If customer_id is omitted, the Customer Profile field is optional and can be added, changed, or removed after case creation.
The status of the template.
" } }, "rules": { "target": "com.amazonaws.connectcases#TemplateCaseRuleList", "traits": { "smithy.api#documentation": "A list of case rules (also known as case field conditions) on a template.
" } }, "tagPropagationConfigurations": { "target": "com.amazonaws.connectcases#TagPropagationConfigurationList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.connectcases#CreateTemplateResponse": { "type": "structure", "members": { "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "A unique identifier of a template.
", "smithy.api#required": {} } }, "templateArn": { "target": "com.amazonaws.connectcases#TemplateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the newly created template.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#CreatedTime": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.connectcases#CustomContent": { "type": "structure", "members": { "fields": { "target": "com.amazonaws.connectcases#FieldValueList", "traits": { "smithy.api#documentation": "List of field values for the Custom related item.
Represents the content of a Custom type related item.
Excludes items matching the filter.
" } }, "andAll": { "target": "com.amazonaws.connectcases#CustomFieldsFilterList", "traits": { "smithy.api#documentation": "Provides \"and all\" filtering.
", "smithy.api#length": { "max": 10 } } }, "orAll": { "target": "com.amazonaws.connectcases#CustomFieldsFilterList", "traits": { "smithy.api#documentation": "Provides \"or all\" filtering.
", "smithy.api#length": { "max": 10 } } } }, "traits": { "smithy.api#documentation": "A filter for fields in Custom type related items. Only one value can be provided.
Filter conditions for custom fields.
" } } }, "traits": { "smithy.api#documentation": "A filter for related items of type Custom.
List of field values for the Custom related item.
Represents the content of a Custom related item.
List of updated field values for the Custom related item. All existing and new fields, and their associated values should be included. Fields not included as part of this request will be removed.
Represents the updated content of a Custom related item.
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
You can't delete a case while it's part of a merge that is running, as either the primary or the secondary case. The request fails with a ConflictException. For more information, see StartMergeCases.
This action is irreversible. After you delete a case, you cannot recover its data.
A unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#DeleteCaseResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#DeleteCaseRule": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#DeleteCaseRuleRequest" }, "output": { "target": "com.amazonaws.connectcases#DeleteCaseRuleResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Deletes a case rule. In the Connect Customer 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.
", "smithy.api#http": { "uri": "/domains/{domainId}/case-rules/{caseRuleId}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#DeleteCaseRuleRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "Unique identifier of a Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseRuleId": { "target": "com.amazonaws.connectcases#CaseRuleId", "traits": { "smithy.api#documentation": "Unique identifier of a case rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#DeleteCaseRuleResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#DeleteDomain": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#DeleteDomainRequest" }, "output": { "target": "com.amazonaws.connectcases#DeleteDomainResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a Cases domain.
After deleting your domain you must disassociate the deleted domain from your Connect Customer instance with another API call before being able to use Cases again with this Connect Customer instance. See DeleteIntegrationAssociation.
The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#DeleteDomainResponse": { "type": "structure", "members": {} }, "com.amazonaws.connectcases#DeleteField": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#DeleteFieldRequest" }, "output": { "target": "com.amazonaws.connectcases#DeleteFieldResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "Unique identifier of the field.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#DeleteFieldResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#DeleteLayout": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#DeleteLayoutRequest" }, "output": { "target": "com.amazonaws.connectcases#DeleteLayoutResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "layoutId": { "target": "com.amazonaws.connectcases#LayoutId", "traits": { "smithy.api#documentation": "The unique identifier of the layout.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#DeleteLayoutResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#DeleteRelatedItem": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#DeleteRelatedItemRequest" }, "output": { "target": "com.amazonaws.connectcases#DeleteRelatedItemResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the related item resource under a case.
This API cannot be used on a FILE type related attachment. To delete this type of file, use the DeleteAttachedFile API
If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.
A unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "relatedItemId": { "target": "com.amazonaws.connectcases#RelatedItemId", "traits": { "smithy.api#documentation": "A unique identifier of a related item.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#DeleteRelatedItemResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#DeleteTemplate": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#DeleteTemplateRequest" }, "output": { "target": "com.amazonaws.connectcases#DeleteTemplateResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "A unique identifier of a template.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#DeleteTemplateResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#Deleted": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.connectcases#Domain": { "type": "resource", "identifiers": { "domainId": { "target": "com.amazonaws.connectcases#DomainId" } }, "create": { "target": "com.amazonaws.connectcases#CreateDomain" }, "read": { "target": "com.amazonaws.connectcases#GetDomain" }, "delete": { "target": "com.amazonaws.connectcases#DeleteDomain" }, "list": { "target": "com.amazonaws.connectcases#ListDomains" }, "operations": [ { "target": "com.amazonaws.connectcases#GetCaseEventConfiguration" }, { "target": "com.amazonaws.connectcases#PutCaseEventConfiguration" }, { "target": "com.amazonaws.connectcases#SearchAllRelatedItems" } ], "traits": { "aws.api#arn": { "template": "domain/{domainId}" } } }, "com.amazonaws.connectcases#DomainArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#DomainId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#DomainName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^.*[\\S]$" } }, "com.amazonaws.connectcases#DomainStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Active", "name": "ACTIVE" }, { "value": "CreationInProgress", "name": "CREATION_IN_PROGRESS" }, { "value": "CreationFailed", "name": "CREATION_FAILED" } ] } }, "com.amazonaws.connectcases#DomainSummary": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the domain.
", "smithy.api#required": {} } }, "domainArn": { "target": "com.amazonaws.connectcases#DomainArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the domain.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#DomainName", "traits": { "smithy.api#documentation": "The name of the domain.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object for the summarized details of the domain.
" } }, "com.amazonaws.connectcases#DomainSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#DomainSummary" } }, "com.amazonaws.connectcases#EmptyFieldValue": { "type": "structure", "members": {}, "traits": { "smithy.api#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.
" } }, "com.amazonaws.connectcases#EmptyOperandValue": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents an empty operand value. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#EventBridgeConfiguration": { "type": "structure", "members": { "enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the to broadcast case event data to the customer.
", "smithy.api#required": {} } }, "includedData": { "target": "com.amazonaws.connectcases#EventIncludedData", "traits": { "smithy.api#documentation": "Details of what case and related item data is published through the case event stream.
" } } }, "traits": { "smithy.api#documentation": "Configuration to enable EventBridge case event delivery and determine what data is delivered.
" } }, "com.amazonaws.connectcases#EventIncludedData": { "type": "structure", "members": { "caseData": { "target": "com.amazonaws.connectcases#CaseEventIncludedData", "traits": { "smithy.api#documentation": "Details of what case data is published through the case event stream.
" } }, "relatedItemData": { "target": "com.amazonaws.connectcases#RelatedItemEventIncludedData", "traits": { "smithy.api#documentation": "Details of what related item data is published through the case event stream.
" } } }, "traits": { "smithy.api#documentation": "Details of what case and related item data is published through the case event stream.
" } }, "com.amazonaws.connectcases#Field": { "type": "resource", "identifiers": { "domainId": { "target": "com.amazonaws.connectcases#DomainId" }, "fieldId": { "target": "com.amazonaws.connectcases#FieldId" } }, "create": { "target": "com.amazonaws.connectcases#CreateField" }, "update": { "target": "com.amazonaws.connectcases#UpdateField" }, "delete": { "target": "com.amazonaws.connectcases#DeleteField" }, "list": { "target": "com.amazonaws.connectcases#ListFields" }, "operations": [ { "target": "com.amazonaws.connectcases#BatchPutFieldOptions" }, { "target": "com.amazonaws.connectcases#ListFieldOptions" } ], "collectionOperations": [ { "target": "com.amazonaws.connectcases#BatchGetField" } ], "traits": { "aws.api#arn": { "template": "domain/{domainId}/field/{fieldId}" } } }, "com.amazonaws.connectcases#FieldArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#FieldAttributes": { "type": "union", "members": { "text": { "target": "com.amazonaws.connectcases#TextAttributes", "traits": { "smithy.api#documentation": "Field attributes for Text field type.
" } } }, "traits": { "smithy.api#documentation": "Union of field attributes.
" } }, "com.amazonaws.connectcases#FieldDescription": { "type": "string", "traits": { "smithy.api#length": { "max": 255 } } }, "com.amazonaws.connectcases#FieldError": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "The field identifier that caused the error.
", "smithy.api#required": {} } }, "errorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The error code from getting a field.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The error message from getting a field.
" } } }, "traits": { "smithy.api#documentation": "Object for errors on fields.
" } }, "com.amazonaws.connectcases#FieldFilter": { "type": "union", "members": { "equalTo": { "target": "com.amazonaws.connectcases#FieldValue", "traits": { "smithy.api#documentation": "Object containing field identifier and value information.
" } }, "contains": { "target": "com.amazonaws.connectcases#FieldValue", "traits": { "smithy.api#documentation": "Object containing field identifier and value information.
" } }, "greaterThan": { "target": "com.amazonaws.connectcases#FieldValue", "traits": { "smithy.api#documentation": "Object containing field identifier and value information.
" } }, "greaterThanOrEqualTo": { "target": "com.amazonaws.connectcases#FieldValue", "traits": { "smithy.api#documentation": "Object containing field identifier and value information.
" } }, "lessThan": { "target": "com.amazonaws.connectcases#FieldValue", "traits": { "smithy.api#documentation": "Object containing field identifier and value information.
" } }, "lessThanOrEqualTo": { "target": "com.amazonaws.connectcases#FieldValue", "traits": { "smithy.api#documentation": "Object containing field identifier and value information.
" } } }, "traits": { "smithy.api#documentation": "A filter for fields. Only one value can be provided.
" } }, "com.amazonaws.connectcases#FieldGroup": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of the field group.
", "smithy.api#length": { "max": 100 } } }, "fields": { "target": "com.amazonaws.connectcases#FieldList", "traits": { "smithy.api#documentation": "Represents an ordered list containing field related information.
", "smithy.api#length": { "max": 220 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object for a group of fields and associated properties.
" } }, "com.amazonaws.connectcases#FieldId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#FieldIdentifier": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "Unique identifier of a field.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object for unique identifier of a field.
" } }, "com.amazonaws.connectcases#FieldIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldIdentifier" } }, "com.amazonaws.connectcases#FieldIdentifierUnion": { "type": "union", "members": { "id": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "The unique identifier of the field.
" } }, "name": { "target": "com.amazonaws.connectcases#FieldName", "traits": { "smithy.api#documentation": "The name of the field.
" } } }, "traits": { "smithy.api#documentation": "Identifies a field by its ID or by its name. Specify only one member. Identifying a field by name is supported only in BatchUpdateCase.
Unique identifier of a field.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object for field related information.
" } }, "com.amazonaws.connectcases#FieldList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldItem" } }, "com.amazonaws.connectcases#FieldName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^.*[\\S]$" } }, "com.amazonaws.connectcases#FieldNamespace": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "System", "name": "SYSTEM" }, { "value": "Custom", "name": "CUSTOM" } ] } }, "com.amazonaws.connectcases#FieldOption": { "type": "structure", "members": { "name": { "target": "com.amazonaws.connectcases#FieldOptionName", "traits": { "smithy.api#documentation": " FieldOptionName has max length 100 and disallows trailing spaces.
FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.
Describes whether the FieldOption is active (displayed) or inactive.
Object for field Options information.
" } }, "com.amazonaws.connectcases#FieldOptionError": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Error message from creating or updating field option.
", "smithy.api#required": {} } }, "errorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Error code from creating or updating field option.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.connectcases#FieldOptionValue", "traits": { "smithy.api#documentation": "The field option value that caused the error.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object for field Options errors.
" } }, "com.amazonaws.connectcases#FieldOptionErrorList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldOptionError" } }, "com.amazonaws.connectcases#FieldOptionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^.*[\\S]$" } }, "com.amazonaws.connectcases#FieldOptionValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^.*[\\S]$" } }, "com.amazonaws.connectcases#FieldOptionsCaseRule": { "type": "structure", "members": { "parentFieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "The identifier of the parent field that controls options.
" } }, "childFieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "The identifier of the child field whose options are controlled.
" } }, "parentChildFieldOptionsMappings": { "target": "com.amazonaws.connectcases#ParentChildFieldOptionsMappingList", "traits": { "smithy.api#documentation": "A mapping between a parent field option value and child field option values.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Rules that control which options are available in a child field based on the selected value in a parent field.
" } }, "com.amazonaws.connectcases#FieldOptionsList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldOption" } }, "com.amazonaws.connectcases#FieldSummary": { "type": "structure", "members": { "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "The unique identifier of a field.
", "smithy.api#required": {} } }, "fieldArn": { "target": "com.amazonaws.connectcases#FieldArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the field.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#FieldName", "traits": { "smithy.api#documentation": "Name of the field.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcases#FieldType", "traits": { "smithy.api#documentation": "The type of a field.
", "smithy.api#required": {} } }, "namespace": { "target": "com.amazonaws.connectcases#FieldNamespace", "traits": { "smithy.api#documentation": "The namespace of a field.
", "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.connectcases#FieldAttributes", "traits": { "smithy.api#documentation": "Union of field attributes.
" } } }, "traits": { "smithy.api#documentation": "Object for the summarized details of the field.
" } }, "com.amazonaws.connectcases#FieldSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldSummary" } }, "com.amazonaws.connectcases#FieldType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Text", "name": "TEXT" }, { "value": "Number", "name": "NUMBER" }, { "value": "Boolean", "name": "BOOLEAN" }, { "value": "DateTime", "name": "DATE_TIME" }, { "value": "SingleSelect", "name": "SINGLE_SELECT" }, { "value": "Url", "name": "URL" }, { "value": "User", "name": "USER" } ] } }, "com.amazonaws.connectcases#FieldValue": { "type": "structure", "members": { "id": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "Unique identifier of a field.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.connectcases#FieldValueUnion", "traits": { "smithy.api#documentation": "Union of potential field value types.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object for case field values.
" } }, "com.amazonaws.connectcases#FieldValueInput": { "type": "structure", "members": { "fieldIdentifier": { "target": "com.amazonaws.connectcases#FieldIdentifierUnion", "traits": { "smithy.api#documentation": "The field to update, identified by field ID or field name.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.connectcases#FieldValueUnion", "traits": { "smithy.api#documentation": "The value to set for the field.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A field and the value to set for it.
" } }, "com.amazonaws.connectcases#FieldValueInputList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldValueInput" } }, "com.amazonaws.connectcases#FieldValueList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldValue" } }, "com.amazonaws.connectcases#FieldValueUnion": { "type": "union", "members": { "stringValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "String value type.
", "smithy.api#length": { "max": 4100 } } }, "doubleValue": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "Can be either null, or have a Double number value type. Only one value can be provided.
" } }, "booleanValue": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Can be either null, or have a Boolean value type. Only one value can be provided.
" } }, "emptyValue": { "target": "com.amazonaws.connectcases#EmptyFieldValue", "traits": { "smithy.api#documentation": "An empty value.
" } }, "userArnValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Represents the user that performed the audit.
" } } }, "traits": { "smithy.api#documentation": "Object to store union of Field values.
The Summary system field accepts up to 3000 characters, while all other fields accept up to 4100 characters. If you use multi-byte characters, the effective character limit may be lower.
The fields whose values to take from the source case. Each field must exist on the source case and must be a field that can be merged. Don't list the same field more than once.
", "smithy.api#required": {} } }, "sourceCaseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "The unique identifier of the case to take the field values from. This must be the secondary case.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the fields whose values to take from the secondary case when you merge cases.
" } }, "com.amazonaws.connectcases#FieldsConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldsConfiguration" } }, "com.amazonaws.connectcases#FileArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#FileContent": { "type": "structure", "members": { "fileArn": { "target": "com.amazonaws.connectcases#FileArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a File in Connect Customer.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that represents a content of an Connect Customer file object.
" } }, "com.amazonaws.connectcases#FileFilter": { "type": "structure", "members": { "fileArn": { "target": "com.amazonaws.connectcases#FileArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file.
" } } }, "traits": { "smithy.api#documentation": "A filter for related items of type File.
Returns information about a specific case if it exists.
", "smithy.api#http": { "uri": "/domains/{domainId}/cases/{caseId}", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#GetCaseAuditEvents": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#GetCaseAuditEventsRequest" }, "output": { "target": "com.amazonaws.connectcases#GetCaseAuditEventsResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the audit history about a specific case if it exists.
", "smithy.api#http": { "uri": "/domains/{domainId}/cases/{caseId}/audit-history", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#GetCaseAuditEventsRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of audit events to return. When no value is provided, 25 is the default.
", "smithy.api#range": { "min": 1, "max": 25 } } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#GetCaseAuditEventsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } }, "auditEvents": { "target": "com.amazonaws.connectcases#AuditEventsList", "traits": { "smithy.api#documentation": "A list of case audits where each represents a particular edit of the case.
", "smithy.api#length": { "max": 25 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#GetCaseEventConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#GetCaseEventConfigurationRequest" }, "output": { "target": "com.amazonaws.connectcases#GetCaseEventConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the case event publishing configuration.
", "smithy.api#http": { "uri": "/domains/{domainId}/case-event-configuration", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#GetCaseEventConfigurationRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#GetCaseEventConfigurationResponse": { "type": "structure", "members": { "eventBridge": { "target": "com.amazonaws.connectcases#EventBridgeConfiguration", "traits": { "smithy.api#documentation": "Configuration to enable EventBridge case event delivery and determine what data is delivered.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#GetCaseRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.connectcases#FieldIdentifierList", "traits": { "smithy.api#documentation": "A list of unique field identifiers.
", "smithy.api#length": { "min": 1, "max": 220 }, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
" } } } }, "com.amazonaws.connectcases#GetCaseResponse": { "type": "structure", "members": { "fields": { "target": "com.amazonaws.connectcases#FieldValueList", "traits": { "smithy.api#documentation": "A list of detailed field information.
", "smithy.api#length": { "max": 220 }, "smithy.api#required": {} } }, "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "A unique identifier of a template.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } } } }, "com.amazonaws.connectcases#GetCaseRuleResponse": { "type": "structure", "members": { "caseRuleId": { "target": "com.amazonaws.connectcases#CaseRuleId", "traits": { "smithy.api#documentation": "Unique identifier of a case rule.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#CaseRuleName", "traits": { "smithy.api#documentation": "Name of the case rule.
", "smithy.api#required": {} } }, "caseRuleArn": { "target": "com.amazonaws.connectcases#CaseRuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the case rule.
", "smithy.api#required": {} } }, "rule": { "target": "com.amazonaws.connectcases#CaseRuleDetails", "traits": { "smithy.api#documentation": "Represents what rule type should take place, under what conditions.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.connectcases#CaseRuleDescription", "traits": { "smithy.api#documentation": "Description of a case rule.
" } }, "deleted": { "target": "com.amazonaws.connectcases#Deleted", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the resource has been deleted.
" } }, "createdTime": { "target": "com.amazonaws.connectcases#CreatedTime", "traits": { "smithy.api#documentation": "Timestamp when the resource was created.
" } }, "lastModifiedTime": { "target": "com.amazonaws.connectcases#LastModifiedTime", "traits": { "smithy.api#documentation": "Timestamp when the resource was created or last modified.
" } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } } }, "traits": { "smithy.api#documentation": "Detailed case rule information. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#GetDomain": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#GetDomainRequest" }, "output": { "target": "com.amazonaws.connectcases#GetDomainResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a specific domain if it exists.
", "smithy.api#http": { "uri": "/domains/{domainId}", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#GetDomainRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#GetDomainResponse": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#required": {} } }, "domainArn": { "target": "com.amazonaws.connectcases#DomainArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Cases domain.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#DomainName", "traits": { "smithy.api#documentation": "The name of the Cases domain.
", "smithy.api#required": {} } }, "createdTime": { "target": "com.amazonaws.connectcases#CreatedTime", "traits": { "smithy.api#documentation": "The timestamp when the Cases domain was created.
", "smithy.api#required": {} } }, "domainStatus": { "target": "com.amazonaws.connectcases#DomainStatus", "traits": { "smithy.api#documentation": "The status of the Cases domain.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } } } }, "com.amazonaws.connectcases#GetFieldResponse": { "type": "structure", "members": { "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "Unique identifier of the field.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#FieldName", "traits": { "smithy.api#documentation": "Name of the field.
", "smithy.api#required": {} } }, "fieldArn": { "target": "com.amazonaws.connectcases#FieldArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the field.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.connectcases#FieldDescription", "traits": { "smithy.api#documentation": "Description of the field.
" } }, "type": { "target": "com.amazonaws.connectcases#FieldType", "traits": { "smithy.api#documentation": "Type of the field.
", "smithy.api#required": {} } }, "namespace": { "target": "com.amazonaws.connectcases#FieldNamespace", "traits": { "smithy.api#documentation": "Namespace of the field.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } }, "deleted": { "target": "com.amazonaws.connectcases#Deleted", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Denotes whether or not the resource has been deleted.
" } }, "createdTime": { "target": "com.amazonaws.connectcases#CreatedTime", "traits": { "smithy.api#documentation": "Timestamp at which the resource was created.
" } }, "lastModifiedTime": { "target": "com.amazonaws.connectcases#LastModifiedTime", "traits": { "smithy.api#documentation": "Timestamp at which the resource was created or last modified.
" } }, "attributes": { "target": "com.amazonaws.connectcases#FieldAttributes", "traits": { "smithy.api#documentation": "Union of field attributes.
" } } }, "traits": { "smithy.api#documentation": "Object to store detailed field information.
" } }, "com.amazonaws.connectcases#GetLayout": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#GetLayoutRequest" }, "output": { "target": "com.amazonaws.connectcases#GetLayoutResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the details for the requested layout.
", "smithy.api#http": { "uri": "/domains/{domainId}/layouts/{layoutId}", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#GetLayoutRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "layoutId": { "target": "com.amazonaws.connectcases#LayoutId", "traits": { "smithy.api#documentation": "The unique identifier of the layout.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#GetLayoutResponse": { "type": "structure", "members": { "layoutId": { "target": "com.amazonaws.connectcases#LayoutId", "traits": { "smithy.api#documentation": "The unique identifier of the layout.
", "smithy.api#required": {} } }, "layoutArn": { "target": "com.amazonaws.connectcases#LayoutArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the newly created layout.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#LayoutName", "traits": { "smithy.api#documentation": "The name of the layout. It must be unique.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.connectcases#LayoutContent", "traits": { "smithy.api#documentation": "Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } }, "deleted": { "target": "com.amazonaws.connectcases#Deleted", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Denotes whether or not the resource has been deleted.
" } }, "createdTime": { "target": "com.amazonaws.connectcases#CreatedTime", "traits": { "smithy.api#documentation": "Timestamp at which the resource was created.
" } }, "lastModifiedTime": { "target": "com.amazonaws.connectcases#LastModifiedTime", "traits": { "smithy.api#documentation": "Timestamp at which the resource was created or last modified.
" } } } }, "com.amazonaws.connectcases#GetMergeCasesStatus": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#GetMergeCasesStatusRequest" }, "output": { "target": "com.amazonaws.connectcases#GetMergeCasesStatusResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the merge status of a case. Use this operation to track a merge that you started with StartMergeCases, or to check whether a case is part of a merge before you modify it.
The operation returns the following, depending on the case:
For the primary case or the secondary case of a merge that is running, it returns IN_PROGRESS.
For a case that was merged into another case as the secondary case, it returns COMPLETED.
For any other case, it returns a ResourceNotFoundException. This includes the primary case after its merge finishes.
Endpoints: See Connect Customer endpoints and quotas.
", "smithy.api#http": { "uri": "/domains/{domainId}/cases/{caseId}/merge-status", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#GetMergeCasesStatusRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "The unique identifier of the case. This can be the primary case or the secondary case of a merge.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#GetMergeCasesStatusResponse": { "type": "structure", "members": { "status": { "target": "com.amazonaws.connectcases#MergeStatus", "traits": { "smithy.api#documentation": "The merge status of the case.
", "smithy.api#required": {} } }, "primaryCaseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "The unique identifier of the primary case of the merge.
" } }, "secondaryCaseIds": { "target": "com.amazonaws.connectcases#CaseIdList", "traits": { "smithy.api#documentation": "The unique identifiers of the secondary cases of the merge.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#GetTemplate": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#GetTemplateRequest" }, "output": { "target": "com.amazonaws.connectcases#GetTemplateResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the details for the requested template. Other template APIs are:
", "smithy.api#http": { "uri": "/domains/{domainId}/templates/{templateId}", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#GetTemplateRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "A unique identifier of a template.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#GetTemplateResponse": { "type": "structure", "members": { "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "A unique identifier of a template.
", "smithy.api#required": {} } }, "templateArn": { "target": "com.amazonaws.connectcases#TemplateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#TemplateName", "traits": { "smithy.api#documentation": "The name of the template.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.connectcases#TemplateDescription", "traits": { "smithy.api#documentation": "A brief description of the template.
" } }, "layoutConfiguration": { "target": "com.amazonaws.connectcases#LayoutConfiguration", "traits": { "smithy.api#documentation": "Configuration of layouts associated to the template.
" } }, "requiredFields": { "target": "com.amazonaws.connectcases#RequiredFieldList", "traits": { "smithy.api#documentation": "A list of fields that must contain a value for a case to be successfully created with this template.
" } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } }, "status": { "target": "com.amazonaws.connectcases#TemplateStatus", "traits": { "smithy.api#documentation": "The status of the template.
", "smithy.api#required": {} } }, "deleted": { "target": "com.amazonaws.connectcases#Deleted", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Denotes whether or not the resource has been deleted.
" } }, "createdTime": { "target": "com.amazonaws.connectcases#CreatedTime", "traits": { "smithy.api#documentation": "Timestamp at which the resource was created.
" } }, "lastModifiedTime": { "target": "com.amazonaws.connectcases#LastModifiedTime", "traits": { "smithy.api#documentation": "Timestamp at which the resource was created or last modified.
" } }, "rules": { "target": "com.amazonaws.connectcases#TemplateCaseRuleList", "traits": { "smithy.api#documentation": "A list of case rules (also known as case field conditions) on a template.
" } }, "tagPropagationConfigurations": { "target": "com.amazonaws.connectcases#TagPropagationConfigurationList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.connectcases#HiddenCaseRule": { "type": "structure", "members": { "defaultValue": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the field is hidden when no conditions match.
", "smithy.api#required": {} } }, "conditions": { "target": "com.amazonaws.connectcases#BooleanConditionList", "traits": { "smithy.api#documentation": "A list of conditions that determine field visibility.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A rule that controls field visibility based on conditions. Fields can be shown or hidden dynamically based on values in other fields.
" } }, "com.amazonaws.connectcases#IamPrincipalArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Advice to clients on when the call can be safely retried.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "We couldn't process your request because of an issue with the server. Try again later.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.connectcases#LastModifiedTime": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.connectcases#Layout": { "type": "resource", "identifiers": { "domainId": { "target": "com.amazonaws.connectcases#DomainId" }, "layoutId": { "target": "com.amazonaws.connectcases#LayoutId" } }, "create": { "target": "com.amazonaws.connectcases#CreateLayout" }, "read": { "target": "com.amazonaws.connectcases#GetLayout" }, "update": { "target": "com.amazonaws.connectcases#UpdateLayout" }, "delete": { "target": "com.amazonaws.connectcases#DeleteLayout" }, "list": { "target": "com.amazonaws.connectcases#ListLayouts" }, "traits": { "aws.api#arn": { "template": "domain/{domainId}/layout/{layoutId}" } } }, "com.amazonaws.connectcases#LayoutArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#LayoutConfiguration": { "type": "structure", "members": { "defaultLayout": { "target": "com.amazonaws.connectcases#LayoutId", "traits": { "smithy.api#documentation": "Unique identifier of a layout.
" } } }, "traits": { "smithy.api#documentation": "Object to store configuration of layouts associated to the template.
" } }, "com.amazonaws.connectcases#LayoutContent": { "type": "union", "members": { "basic": { "target": "com.amazonaws.connectcases#BasicLayout", "traits": { "smithy.api#documentation": "Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.
Object to store union of different versions of layout content.
" } }, "com.amazonaws.connectcases#LayoutId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#LayoutName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^.*[\\S]$" } }, "com.amazonaws.connectcases#LayoutSections": { "type": "structure", "members": { "sections": { "target": "com.amazonaws.connectcases#SectionsList" } }, "traits": { "smithy.api#documentation": "Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.
" } }, "com.amazonaws.connectcases#LayoutSummary": { "type": "structure", "members": { "layoutId": { "target": "com.amazonaws.connectcases#LayoutId", "traits": { "smithy.api#documentation": "The unique identifier for of the layout.
", "smithy.api#required": {} } }, "layoutArn": { "target": "com.amazonaws.connectcases#LayoutArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the layout.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#LayoutName", "traits": { "smithy.api#documentation": "The name of the layout.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object for the summarized details of the layout.
" } }, "com.amazonaws.connectcases#LayoutSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#LayoutSummary" } }, "com.amazonaws.connectcases#ListCaseRules": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#ListCaseRulesRequest" }, "output": { "target": "com.amazonaws.connectcases#ListCaseRulesResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all case rules in a Cases domain. In the Connect Customer 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.
", "smithy.api#http": { "uri": "/domains/{domainId}/rules-list/", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "caseRules" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#ListCaseRulesRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "Unique identifier of a Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.connectcases#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#ListCaseRulesResponse": { "type": "structure", "members": { "caseRules": { "target": "com.amazonaws.connectcases#CaseRuleSummaryList", "traits": { "smithy.api#documentation": "A list of field summary objects.
", "smithy.api#length": { "max": 100 }, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#ListCasesForContact": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#ListCasesForContactRequest" }, "output": { "target": "com.amazonaws.connectcases#ListCasesForContactResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists cases for a given contact.
", "smithy.api#http": { "uri": "/domains/{domainId}/list-cases-for-contact", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#ListCasesForContactRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "contactArn": { "target": "com.amazonaws.connectcases#ContactArn", "traits": { "smithy.api#documentation": "A unique identifier of a contact in Connect Customer.
", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#range": { "min": 1, "max": 10 } } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
" } } } }, "com.amazonaws.connectcases#ListCasesForContactResponse": { "type": "structure", "members": { "cases": { "target": "com.amazonaws.connectcases#CaseSummaryList", "traits": { "smithy.api#documentation": "A list of Case summary information.
", "smithy.api#length": { "max": 10 }, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } } } }, "com.amazonaws.connectcases#ListDomains": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#ListDomainsRequest" }, "output": { "target": "com.amazonaws.connectcases#ListDomainsResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
", "smithy.api#http": { "uri": "/domains-list", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#ListDomainsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.connectcases#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 10 } } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.connectcases#ListDomainsResponse": { "type": "structure", "members": { "domains": { "target": "com.amazonaws.connectcases#DomainSummaryList", "traits": { "smithy.api#documentation": "The Cases domain.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } } } }, "com.amazonaws.connectcases#ListFieldOptions": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#ListFieldOptionsRequest" }, "output": { "target": "com.amazonaws.connectcases#ListFieldOptionsResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all of the field options for a field identifier in the domain.
", "smithy.api#http": { "uri": "/domains/{domainId}/fields/{fieldId}/options-list", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#ListFieldOptionsRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "The unique identifier of a field.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.connectcases#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
", "smithy.api#httpQuery": "nextToken" } }, "values": { "target": "com.amazonaws.connectcases#ValuesList", "traits": { "smithy.api#documentation": "A list of FieldOption values to filter on for ListFieldOptions.
A list of FieldOption objects.
The token for the next set of results. This is null if there are no more results to return.
" } } } }, "com.amazonaws.connectcases#ListFields": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#ListFieldsRequest" }, "output": { "target": "com.amazonaws.connectcases#ListFieldsResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all fields in a Cases domain.
", "smithy.api#http": { "uri": "/domains/{domainId}/fields-list", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#ListFieldsRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.connectcases#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.connectcases#ListFieldsResponse": { "type": "structure", "members": { "fields": { "target": "com.amazonaws.connectcases#FieldSummaryList", "traits": { "smithy.api#documentation": "List of detailed field information.
", "smithy.api#length": { "max": 100 }, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } } } }, "com.amazonaws.connectcases#ListLayouts": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#ListLayoutsRequest" }, "output": { "target": "com.amazonaws.connectcases#ListLayoutsResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
", "smithy.api#http": { "uri": "/domains/{domainId}/layouts-list", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#ListLayoutsRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.connectcases#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.connectcases#ListLayoutsResponse": { "type": "structure", "members": { "layouts": { "target": "com.amazonaws.connectcases#LayoutSummaryList", "traits": { "smithy.api#documentation": "The layouts for the domain.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } } } }, "com.amazonaws.connectcases#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.connectcases#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists tags for a resource.
", "smithy.api#http": { "uri": "/tags/{arn}", "method": "GET" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#ListTagsForResourceRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connectcases#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN)
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } } } }, "com.amazonaws.connectcases#ListTemplates": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#ListTemplatesRequest" }, "output": { "target": "com.amazonaws.connectcases#ListTemplatesResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
Other template APIs are:
", "smithy.api#http": { "uri": "/domains/{domainId}/templates-list", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#ListTemplatesRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.connectcases#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
", "smithy.api#httpQuery": "nextToken" } }, "status": { "target": "com.amazonaws.connectcases#TemplateStatusFilters", "traits": { "smithy.api#documentation": "A list of status values to filter on.
", "smithy.api#httpQuery": "status" } } } }, "com.amazonaws.connectcases#ListTemplatesResponse": { "type": "structure", "members": { "templates": { "target": "com.amazonaws.connectcases#TemplateSummaryList", "traits": { "smithy.api#documentation": "List of template summary objects.
", "smithy.api#length": { "max": 100 }, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } } } }, "com.amazonaws.connectcases#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.connectcases#MergeStatus": { "type": "string", "traits": { "smithy.api#documentation": "The merge status of a case.
IN_PROGRESS - The merge is running. You can't modify the secondary case or its related items. You can modify the primary case, but you can't delete it.
COMPLETED - The merge finished, and this case was the secondary case. The case was closed by the merge. You can reopen, update, and delete it, but you can't include it in another merge.
The field ID that this operand should take the value of.
" } } }, "traits": { "smithy.api#documentation": "Represents the left hand operand in the condition. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#OperandTwo": { "type": "union", "members": { "stringValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "String value type.
", "smithy.api#length": { "min": 1, "max": 1500 } } }, "booleanValue": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Boolean value type.
" } }, "doubleValue": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "Double value type.
" } }, "emptyValue": { "target": "com.amazonaws.connectcases#EmptyOperandValue", "traits": { "smithy.api#documentation": "Empty value type.
" } } }, "traits": { "smithy.api#documentation": "Represents the right hand operand in the condition. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#Order": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Asc", "name": "ASCENDING" }, { "value": "Desc", "name": "DESCENDING" } ] } }, "com.amazonaws.connectcases#ParentChildFieldOptionValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 100 }, "smithy.api#pattern": "^$|^.*[\\S]$" } }, "com.amazonaws.connectcases#ParentChildFieldOptionValueList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#ParentChildFieldOptionValue" } }, "com.amazonaws.connectcases#ParentChildFieldOptionsMapping": { "type": "structure", "members": { "parentFieldOptionValue": { "target": "com.amazonaws.connectcases#ParentChildFieldOptionValue", "traits": { "smithy.api#documentation": "The value in the parent field.
", "smithy.api#required": {} } }, "childFieldOptionValues": { "target": "com.amazonaws.connectcases#ParentChildFieldOptionValueList", "traits": { "smithy.api#documentation": "A list of allowed values in the child field.
", "smithy.api#length": { "max": 1500 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A mapping between a parent field option value and child field option values.
" } }, "com.amazonaws.connectcases#ParentChildFieldOptionsMappingList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#ParentChildFieldOptionsMapping" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.connectcases#PutCaseEventConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#PutCaseEventConfigurationRequest" }, "output": { "target": "com.amazonaws.connectcases#PutCaseEventConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#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 Connect Customer Administrator Guide.
", "smithy.api#http": { "uri": "/domains/{domainId}/case-event-configuration", "method": "PUT" } } }, "com.amazonaws.connectcases#PutCaseEventConfigurationRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "eventBridge": { "target": "com.amazonaws.connectcases#EventBridgeConfiguration", "traits": { "smithy.api#documentation": "Configuration to enable EventBridge case event delivery and determine what data is delivered.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#PutCaseEventConfigurationResponse": { "type": "structure", "members": {} }, "com.amazonaws.connectcases#ReferenceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^[A-Za-z0-9\\-._/:#=+-]*$" } }, "com.amazonaws.connectcases#ReferenceNumber": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^[A-Za-z0-9\\-._/:#=+-]*$" } }, "com.amazonaws.connectcases#RelatedItem": { "type": "resource", "identifiers": { "domainId": { "target": "com.amazonaws.connectcases#DomainId" }, "caseId": { "target": "com.amazonaws.connectcases#CaseId" }, "relatedItemId": { "target": "com.amazonaws.connectcases#RelatedItemId" } }, "create": { "target": "com.amazonaws.connectcases#CreateRelatedItem" }, "update": { "target": "com.amazonaws.connectcases#UpdateRelatedItem" }, "delete": { "target": "com.amazonaws.connectcases#DeleteRelatedItem" }, "list": { "target": "com.amazonaws.connectcases#SearchRelatedItems" }, "traits": { "aws.api#arn": { "template": "domain/{domainId}/case/{caseId}/related-item/{relatedItemId}" } } }, "com.amazonaws.connectcases#RelatedItemArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#RelatedItemContent": { "type": "union", "members": { "contact": { "target": "com.amazonaws.connectcases#ContactContent", "traits": { "smithy.api#documentation": "Represents the content of a contact to be returned to agents.
" } }, "comment": { "target": "com.amazonaws.connectcases#CommentContent", "traits": { "smithy.api#documentation": "Represents the content of a comment to be returned to agents.
" } }, "file": { "target": "com.amazonaws.connectcases#FileContent", "traits": { "smithy.api#documentation": "Represents the content of a File to be returned to agents.
" } }, "sla": { "target": "com.amazonaws.connectcases#SlaContent", "traits": { "smithy.api#documentation": "Represents the content of an SLA to be returned to agents.
" } }, "connectCase": { "target": "com.amazonaws.connectcases#ConnectCaseContent", "traits": { "smithy.api#documentation": "Represents the Connect Customer case to be created as a related item.
" } }, "custom": { "target": "com.amazonaws.connectcases#CustomContent", "traits": { "smithy.api#documentation": "Represents the content of a Custom type related item.
Represents the content of a particular type of related item.
" } }, "com.amazonaws.connectcases#RelatedItemEventIncludedData": { "type": "structure", "members": { "includeContent": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Details of what related item data is published through the case event stream.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Details of what related item data is published through the case event stream.
" } }, "com.amazonaws.connectcases#RelatedItemFilterList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#RelatedItemTypeFilter" } }, "com.amazonaws.connectcases#RelatedItemId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#RelatedItemInputContent": { "type": "union", "members": { "contact": { "target": "com.amazonaws.connectcases#Contact", "traits": { "smithy.api#documentation": "Object representing a contact in Connect Customer as an API request field.
" } }, "comment": { "target": "com.amazonaws.connectcases#CommentContent", "traits": { "smithy.api#documentation": "Represents the content of a comment to be returned to agents.
" } }, "file": { "target": "com.amazonaws.connectcases#FileContent", "traits": { "smithy.api#documentation": "A file of related items.
" } }, "sla": { "target": "com.amazonaws.connectcases#SlaInputContent", "traits": { "smithy.api#documentation": "Represents the content of an SLA to be created.
" } }, "connectCase": { "target": "com.amazonaws.connectcases#ConnectCaseInputContent", "traits": { "smithy.api#documentation": "Represents the Connect Customer case to be created as a related item.
" } }, "custom": { "target": "com.amazonaws.connectcases#CustomInputContent", "traits": { "smithy.api#documentation": "Represents the content of a Custom type related item.
Represents the content of a related item to be created.
" } }, "com.amazonaws.connectcases#RelatedItemType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Contact", "name": "CONTACT" }, { "value": "Comment", "name": "COMMENT" }, { "value": "File", "name": "FILE" }, { "value": "Sla", "name": "SLA" }, { "value": "ConnectCase", "name": "CONNECT_CASE" }, { "value": "Custom", "name": "CUSTOM" } ] } }, "com.amazonaws.connectcases#RelatedItemTypeFilter": { "type": "union", "members": { "contact": { "target": "com.amazonaws.connectcases#ContactFilter", "traits": { "smithy.api#documentation": "A filter for related items of type Contact.
A filter for related items of type Comment.
A filter for related items of this type of File.
Filter for related items of type SLA.
Represents the Connect Customer case to be created as a related item.
" } }, "custom": { "target": "com.amazonaws.connectcases#CustomFilter", "traits": { "smithy.api#documentation": "Represents the content of a Custom type related item.
The list of types of related items and their parameters to use for filtering.
" } }, "com.amazonaws.connectcases#RelatedItemUpdateContent": { "type": "union", "members": { "comment": { "target": "com.amazonaws.connectcases#CommentUpdateContent" }, "custom": { "target": "com.amazonaws.connectcases#CustomUpdateContent" }, "sla": { "target": "com.amazonaws.connectcases#SlaUpdateContent", "traits": { "smithy.api#documentation": "Represents the content of an SLA to be updated.
" } } }, "traits": { "smithy.api#documentation": "Represents the content of a related item to be updated. This is a union type that can contain comment content, custom content, or SLA content.
" } }, "com.amazonaws.connectcases#RelatedItemsConfiguration": { "type": "structure", "members": { "comment": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether to move Comment related items to the primary case.
" } }, "connectCase": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether to move Case related items to the primary case. If the primary case already links to the same case, the secondary case's link is removed instead of moved.
" } }, "contact": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether to move Contact related items to the primary case. If the same contact is related to both cases, the primary case keeps its related item and gets any tag keys that only the secondary case's related item has.
" } }, "custom": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether to move Custom related items to the primary case.
" } } }, "traits": { "smithy.api#documentation": "Specifies which types of related items to move from the secondary case to the primary case when you merge cases. Moved related items keep their related item ID, creator, association time, and tags.
" } }, "com.amazonaws.connectcases#RequiredCaseRule": { "type": "structure", "members": { "defaultValue": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "The value of the rule (that is, whether the field is required) should none of the conditions evaluate to true.
", "smithy.api#required": {} } }, "conditions": { "target": "com.amazonaws.connectcases#BooleanConditionList", "traits": { "smithy.api#documentation": "List of conditions for the required rule; the first condition to evaluate to true dictates the value of the rule.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Required rule type, used to indicate whether a field is required. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#RequiredField": { "type": "structure", "members": { "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "Unique identifier of a field.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "List of fields that must have a value provided to create a case.
" } }, "com.amazonaws.connectcases#RequiredFieldList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#RequiredField" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.connectcases#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Unique identifier of the resource affected.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Type of the resource affected.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.connectcases#RuleType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "REQUIRED", "value": "Required" }, { "name": "HIDDEN", "value": "Hidden" }, { "name": "FIELD_OPTIONS", "value": "FieldOptions" } ] } }, "com.amazonaws.connectcases#SearchAllRelatedItems": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#SearchAllRelatedItemsRequest" }, "output": { "target": "com.amazonaws.connectcases#SearchAllRelatedItemsResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "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 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 API for each returned case ID.
This API searches across related items content, not case fields. Use the SearchCases API to search within case field values.
Endpoints: See Connect Customer endpoints and quotas.
", "smithy.api#http": { "uri": "/domains/{domainId}/related-items-search", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "relatedItems" }, "smithy.api#readonly": {} } }, "com.amazonaws.connectcases#SearchAllRelatedItemsRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#range": { "min": 1, "max": 25 } } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
" } }, "filters": { "target": "com.amazonaws.connectcases#RelatedItemFilterList", "traits": { "smithy.api#documentation": "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.
", "smithy.api#length": { "min": 0, "max": 10 } } }, "sorts": { "target": "com.amazonaws.connectcases#SearchAllRelatedItemsSortList", "traits": { "smithy.api#documentation": "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.
", "smithy.api#length": { "min": 0, "max": 2 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#SearchAllRelatedItemsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } }, "relatedItems": { "target": "com.amazonaws.connectcases#SearchAllRelatedItemsResponseItemList", "traits": { "smithy.api#documentation": "A list of items related to a case.
", "smithy.api#length": { "max": 25 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#SearchAllRelatedItemsResponseItem": { "type": "structure", "members": { "relatedItemId": { "target": "com.amazonaws.connectcases#RelatedItemId", "traits": { "smithy.api#documentation": "Unique identifier of a related item.
", "smithy.api#required": {} } }, "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcases#RelatedItemType", "traits": { "smithy.api#documentation": "Type of a related item.
", "smithy.api#required": {} } }, "associationTime": { "target": "com.amazonaws.connectcases#AssociationTime", "traits": { "smithy.api#documentation": "Time at which a related item was associated with a case.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.connectcases#RelatedItemContent", "traits": { "smithy.api#required": {} } }, "performedBy": { "target": "com.amazonaws.connectcases#UserUnion" }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } } }, "traits": { "smithy.api#documentation": "A list of items that represent RelatedItems. This data type is similar to SearchRelatedItemsResponseItem except SearchAllRelatedItemsResponseItem has a caseId field.
" } }, "com.amazonaws.connectcases#SearchAllRelatedItemsResponseItemList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#SearchAllRelatedItemsResponseItem" }, "traits": { "smithy.api#sparse": {} } }, "com.amazonaws.connectcases#SearchAllRelatedItemsSort": { "type": "structure", "members": { "sortProperty": { "target": "com.amazonaws.connectcases#SearchAllRelatedItemsSortProperty", "traits": { "smithy.api#documentation": "Whether related items should be sorted in ascending or descending order.
", "smithy.api#required": {} } }, "sortOrder": { "target": "com.amazonaws.connectcases#Order", "traits": { "smithy.api#documentation": "Whether related items should be sorted by association time or case ID.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The order in which all returned related items should be sorted.
" } }, "com.amazonaws.connectcases#SearchAllRelatedItemsSortList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#SearchAllRelatedItemsSort" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "com.amazonaws.connectcases#SearchAllRelatedItemsSortProperty": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AssociationTime", "name": "ASSOCIATION_TIME" }, { "value": "CaseId", "name": "CASE_ID" } ] } }, "com.amazonaws.connectcases#SearchCases": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#SearchCasesRequest" }, "output": { "target": "com.amazonaws.connectcases#SearchCasesResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#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.
The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of cases to return. When no value is provided, 25 is the default.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A word or phrase used to perform a quick search.
", "smithy.api#length": { "min": 0, "max": 255 } } }, "filter": { "target": "com.amazonaws.connectcases#CaseFilter", "traits": { "smithy.api#documentation": "A list of filter objects.
" } }, "sorts": { "target": "com.amazonaws.connectcases#SortList", "traits": { "smithy.api#documentation": "A list of sorts where each sort specifies a field and their sort order to be applied to the results.
", "smithy.api#length": { "min": 0, "max": 2 } } }, "fields": { "target": "com.amazonaws.connectcases#FieldIdentifierList", "traits": { "smithy.api#documentation": "The list of field identifiers to be returned as part of the response.
", "smithy.api#length": { "min": 0, "max": 25 } } } } }, "com.amazonaws.connectcases#SearchCasesResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } }, "cases": { "target": "com.amazonaws.connectcases#SearchCasesResponseItemList", "traits": { "smithy.api#documentation": "A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.
The total number of cases that matched the search criteria.
" } } } }, "com.amazonaws.connectcases#SearchCasesResponseItem": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#required": {} } }, "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "A unique identifier of a template.
", "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.connectcases#FieldValueList", "traits": { "smithy.api#documentation": "List of case field values.
", "smithy.api#length": { "max": 25 }, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } } }, "traits": { "smithy.api#documentation": "A list of items that represent cases.
" } }, "com.amazonaws.connectcases#SearchCasesResponseItemList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#SearchCasesResponseItem" }, "traits": { "smithy.api#sparse": {} } }, "com.amazonaws.connectcases#SearchRelatedItems": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#SearchRelatedItemsRequest" }, "output": { "target": "com.amazonaws.connectcases#SearchRelatedItemsResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#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.
The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#range": { "min": 1, "max": 25 } } }, "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#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.
" } }, "filters": { "target": "com.amazonaws.connectcases#RelatedItemFilterList", "traits": { "smithy.api#documentation": "The list of types of related items and their parameters to use for filtering.
", "smithy.api#length": { "min": 0, "max": 10 } } } } }, "com.amazonaws.connectcases#SearchRelatedItemsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.connectcases#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. This is null if there are no more results to return.
" } }, "relatedItems": { "target": "com.amazonaws.connectcases#SearchRelatedItemsResponseItemList", "traits": { "smithy.api#documentation": "A list of items related to a case.
", "smithy.api#length": { "max": 25 }, "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#SearchRelatedItemsResponseItem": { "type": "structure", "members": { "relatedItemId": { "target": "com.amazonaws.connectcases#RelatedItemId", "traits": { "smithy.api#documentation": "Unique identifier of a related item.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcases#RelatedItemType", "traits": { "smithy.api#documentation": "Type of a related item.
", "smithy.api#required": {} } }, "associationTime": { "target": "com.amazonaws.connectcases#AssociationTime", "traits": { "smithy.api#documentation": "Time at which a related item was associated with a case.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.connectcases#RelatedItemContent", "traits": { "smithy.api#documentation": "Represents the content of a particular type of related item.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } }, "performedBy": { "target": "com.amazonaws.connectcases#UserUnion", "traits": { "smithy.api#documentation": "Represents the creator of the related item.
" } } }, "traits": { "smithy.api#documentation": "A list of items that represent RelatedItems.
" } }, "com.amazonaws.connectcases#SearchRelatedItemsResponseItemList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#SearchRelatedItemsResponseItem" }, "traits": { "smithy.api#sparse": {} } }, "com.amazonaws.connectcases#SearchTagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:/=+\\-@]+$" } }, "com.amazonaws.connectcases#Section": { "type": "union", "members": { "fieldGroup": { "target": "com.amazonaws.connectcases#FieldGroup", "traits": { "smithy.api#documentation": "Consists of a group of fields and associated properties.
" } } }, "traits": { "smithy.api#documentation": "This represents a sections within a panel or tab of the page layout.
" } }, "com.amazonaws.connectcases#SectionsList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#Section" }, "traits": { "smithy.api#documentation": "Ordered list containing different kinds of sections that can be added.
", "smithy.api#length": { "max": 1 } } }, "com.amazonaws.connectcases#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The service quota has been exceeded. For a list of service quotas, see Connect Customer Service Quotas in the Connect Customer Administrator Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.connectcases#SlaCompletionTime": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.connectcases#SlaConfiguration": { "type": "structure", "members": { "name": { "target": "com.amazonaws.connectcases#SlaName", "traits": { "smithy.api#documentation": "Name of an SLA.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcases#SlaType", "traits": { "smithy.api#documentation": "Type of SLA.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connectcases#SlaStatus", "traits": { "smithy.api#documentation": "Status of an SLA.
", "smithy.api#required": {} } }, "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "Unique identifier of a field.
" } }, "targetFieldValues": { "target": "com.amazonaws.connectcases#SlaFieldValueUnionList", "traits": { "smithy.api#documentation": "Represents a list of target field values for the fieldId specified in SlaConfiguration.
" } }, "targetTime": { "target": "com.amazonaws.connectcases#SlaTargetTime", "traits": { "smithy.api#documentation": "Target time by which an SLA should be completed.
", "smithy.api#required": {} } }, "completionTime": { "target": "com.amazonaws.connectcases#SlaCompletionTime", "traits": { "smithy.api#documentation": "Time at which an SLA was completed.
" } } }, "traits": { "smithy.api#documentation": "Represents an SLA configuration.
" } }, "com.amazonaws.connectcases#SlaContent": { "type": "structure", "members": { "slaConfiguration": { "target": "com.amazonaws.connectcases#SlaConfiguration", "traits": { "smithy.api#documentation": "Represents an SLA configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the content of an SLA to be returned to agents.
" } }, "com.amazonaws.connectcases#SlaFieldValueUnionList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#FieldValueUnion" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.connectcases#SlaFilter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.connectcases#SlaName", "traits": { "smithy.api#documentation": "Name of an SLA.
" } }, "status": { "target": "com.amazonaws.connectcases#SlaStatus", "traits": { "smithy.api#documentation": "Status of an SLA.
" } } }, "traits": { "smithy.api#documentation": "A filter for related items of type SLA.
Name of an SLA.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcases#SlaType", "traits": { "smithy.api#documentation": "Type of SLA.
", "smithy.api#required": {} } }, "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "Unique identifier of the case field that the SLA tracks. The field must be a single-select field, such as the system status field or a custom single-select field.
Represents a list of target field values for the fieldId specified in SlaInputConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.
" } }, "targetSlaMinutes": { "target": "com.amazonaws.connectcases#TargetSlaMinutes", "traits": { "smithy.api#documentation": "Target duration in minutes within which an SLA should be completed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input configuration of an SLA being created.
" } }, "com.amazonaws.connectcases#SlaInputContent": { "type": "union", "members": { "slaInputConfiguration": { "target": "com.amazonaws.connectcases#SlaInputConfiguration", "traits": { "smithy.api#documentation": "Represents an input SLA configuration.
" } } }, "traits": { "smithy.api#documentation": "Represents the content of an SLA.
" } }, "com.amazonaws.connectcases#SlaName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#pattern": "^.*[\\S]$", "smithy.api#sensitive": {} } }, "com.amazonaws.connectcases#SlaStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Active", "name": "ACTIVE" }, { "value": "Overdue", "name": "OVERDUE" }, { "value": "Met", "name": "MET" }, { "value": "NotMet", "name": "NOT_MET" } ] } }, "com.amazonaws.connectcases#SlaTargetTime": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.connectcases#SlaType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CaseField", "name": "CASE_FIELD" } ] } }, "com.amazonaws.connectcases#SlaUpdateConfiguration": { "type": "structure", "members": { "targetSlaMinutes": { "target": "com.amazonaws.connectcases#TargetSlaMinutes", "traits": { "smithy.api#documentation": "New target duration in minutes within which an SLA should be completed. The new deadline is counted from when the SLA was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the SLA configuration to update.
" } }, "com.amazonaws.connectcases#SlaUpdateContent": { "type": "union", "members": { "slaUpdateConfiguration": { "target": "com.amazonaws.connectcases#SlaUpdateConfiguration", "traits": { "smithy.api#documentation": "Represents the SLA configuration to update.
" } } }, "traits": { "smithy.api#documentation": "Represents the updated content of an SLA related item.
" } }, "com.amazonaws.connectcases#Sort": { "type": "structure", "members": { "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "Unique identifier of a field.
", "smithy.api#required": {} } }, "sortOrder": { "target": "com.amazonaws.connectcases#Order", "traits": { "smithy.api#documentation": "Whether results should be sorted in ascending or descending order.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A structured set of sort terms.
" } }, "com.amazonaws.connectcases#SortList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#Sort" } }, "com.amazonaws.connectcases#StartMergeCases": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#StartMergeCasesRequest" }, "output": { "target": "com.amazonaws.connectcases#StartMergeCasesResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Merges a secondary case into a primary case. The primary case, which you specify in the request URI, remains active. Both cases must belong to the same domain.
The merge runs asynchronously. To track its progress, call GetMergeCasesStatus. When the merge finishes, the selected field values and related items from the secondary case are on the primary case, the two cases are linked, and the secondary case is closed. Both cases record the merge in their audit history. For more information, see GetCaseAuditEvents.
Important things to know
Both cases must have the same customer, or at least one of them must have no customer.
While the merge runs, you can't modify the secondary case or its related items, and you can't delete the primary case. These requests return a ConflictException.
After the merge, the secondary case can be reopened, updated, and deleted, but it can't be merged again.
The request fails with a ValidationException, and no merge starts, if:
The primary case and the secondary case are the same case.
Either case is closed.
Both cases have a customer, and the customers are different.
fieldsConfiguration selects a field that can't be merged, or a field that the secondary case doesn't have.
After the merge, the primary case would have more than 500 field values, or would exceed the maximum case size.
The request fails with a ServiceQuotaExceededException if, after the merge, either case would exceed the quota for related items per case. For the primary case, the count is its existing related items, plus the related items moved from the secondary case, plus the new case link. See Connect Customer Cases quotas.
The request fails with a ConflictException if either case is already part of a merge that is running, or was previously merged into another case as the secondary case.
Endpoints: See Connect Customer endpoints and quotas.
", "smithy.api#http": { "uri": "/domains/{domainId}/cases/{caseId}/merge", "method": "POST" } } }, "com.amazonaws.connectcases#StartMergeCasesRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "The unique identifier of the primary case. The primary case remains active and receives the merged field values and related items. The cases can use different templates, and the primary case keeps its template.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "caseId" } }, "secondaryCaseIds": { "target": "com.amazonaws.connectcases#CaseIdList", "traits": { "smithy.api#documentation": "The unique identifier of the secondary case to merge into the primary case. The secondary case is closed when the merge finishes. Specify exactly one case ID.
", "smithy.api#length": { "min": 1, "max": 1 }, "smithy.api#required": {} } }, "fieldsConfiguration": { "target": "com.amazonaws.connectcases#FieldsConfigurationList", "traits": { "smithy.api#documentation": "The fields whose values to take from the secondary case. You can only merge custom fields and the following system fields: assigned_queue, assigned_user, summary, and case_reason. If you select any other system field, the request fails with a ValidationException.
For each field that can be merged, the merge works as follows:
If you select the field, the primary case gets the secondary case's value. If the secondary case's value is empty, the primary case's value is cleared.
If you don't select the field and the primary case has a value for it, the primary case keeps its value.
If you don't select the field and the primary case doesn't have the field, or its value is empty, the primary case gets the secondary case's value. This applies even when the field isn't on the primary case's template.
Field values are read from both cases when the merge runs, so changes that you make to the primary case after you start the merge are taken into account.
Specify at most one entry, and set its sourceCaseId to the secondary case ID.
The types of related items to move from the secondary case to the primary case. Related items of a type that you don't select, or set to false, stay on the closed secondary case. If you omit this parameter, no related items are moved.
File, SLA, and work plan related items are never moved. They stay on the secondary case.
" } }, "performedBy": { "target": "com.amazonaws.connectcases#UserUnion", "traits": { "smithy.api#documentation": "The user who performed the merge. If you provide userArn, you must also have DescribeUser permission on the ARN of that user.
Object containing tag key and value information.
" } } }, "traits": { "smithy.api#documentation": "A filter for tags. Only one value can be provided.
" } }, "com.amazonaws.connectcases#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.connectcases#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.connectcases#TagPropagationConfiguration": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.connectcases#TagPropagationResourceType", "traits": { "smithy.api#documentation": "Supported resource types for tag propagation. Determines which resources will receive automatically propagated tags.
", "smithy.api#required": {} } }, "tagMap": { "target": "com.amazonaws.connectcases#MutableTags", "traits": { "smithy.api#documentation": "The tags that will be applied to the created resource.
", "smithy.api#length": { "max": 10 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.connectcases#TagPropagationConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#TagPropagationConfiguration" }, "traits": { "smithy.api#length": { "max": 1 } } }, "com.amazonaws.connectcases#TagPropagationResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Cases", "name": "CASES", "documentation": "Cases resources created within the domain" } ] } }, "com.amazonaws.connectcases#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Adds tags to a resource.
", "smithy.api#http": { "uri": "/tags/{arn}", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#TagResourceRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connectcases#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN)
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#TagValue": { "type": "structure", "members": { "key": { "target": "com.amazonaws.connectcases#SearchTagKey", "traits": { "smithy.api#documentation": "The tag key in the tag filter value.
" } }, "value": { "target": "com.amazonaws.connectcases#TagValueString", "traits": { "smithy.api#documentation": "The tag value in the tag filter value.
" } } }, "traits": { "smithy.api#documentation": "Object for case tag filter values.
" } }, "com.amazonaws.connectcases#TagValueString": { "type": "string", "traits": { "smithy.api#length": { "max": 256 }, "smithy.api#pattern": "^([a-zA-Z0-9 _.:/=+\\-@]*)$" } }, "com.amazonaws.connectcases#Tags": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" }, "traits": { "smithy.api#sparse": {} } }, "com.amazonaws.connectcases#TargetSlaMinutes": { "type": "long", "traits": { "smithy.api#range": { "min": 1, "max": 1051200 } } }, "com.amazonaws.connectcases#Template": { "type": "resource", "identifiers": { "domainId": { "target": "com.amazonaws.connectcases#DomainId" }, "templateId": { "target": "com.amazonaws.connectcases#TemplateId" } }, "create": { "target": "com.amazonaws.connectcases#CreateTemplate" }, "read": { "target": "com.amazonaws.connectcases#GetTemplate" }, "update": { "target": "com.amazonaws.connectcases#UpdateTemplate" }, "delete": { "target": "com.amazonaws.connectcases#DeleteTemplate" }, "list": { "target": "com.amazonaws.connectcases#ListTemplates" }, "traits": { "aws.api#arn": { "template": "domain/{domainId}/template/{templateId}" } } }, "com.amazonaws.connectcases#TemplateArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#TemplateCaseRuleList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#TemplateRule" }, "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.connectcases#TemplateDescription": { "type": "string", "traits": { "smithy.api#length": { "max": 255 } } }, "com.amazonaws.connectcases#TemplateId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#TemplateName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^.*[\\S]$" } }, "com.amazonaws.connectcases#TemplateRule": { "type": "structure", "members": { "caseRuleId": { "target": "com.amazonaws.connectcases#CaseRuleId", "traits": { "smithy.api#documentation": "Unique identifier of a case rule.
", "smithy.api#required": {} } }, "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "NULL", "smithy.api#documentation": "Unique identifier of a field.
" } } }, "traits": { "smithy.api#documentation": "An association representing a case rule acting upon a field. In the Connect Customer 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.
" } }, "com.amazonaws.connectcases#TemplateStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ACTIVE", "value": "Active" }, { "name": "INACTIVE", "value": "Inactive" } ] } }, "com.amazonaws.connectcases#TemplateStatusFilters": { "type": "list", "member": { "target": "com.amazonaws.connectcases#TemplateStatus" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.connectcases#TemplateSummary": { "type": "structure", "members": { "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "The unique identifier for the template.
", "smithy.api#required": {} } }, "templateArn": { "target": "com.amazonaws.connectcases#TemplateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#TemplateName", "traits": { "smithy.api#documentation": "The template name.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connectcases#TemplateStatus", "traits": { "smithy.api#documentation": "The status of the template.
", "smithy.api#required": {} } }, "tagPropagationConfigurations": { "target": "com.amazonaws.connectcases#TagPropagationConfigurationList", "traits": { "smithy.api#documentation": "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.
" } } }, "traits": { "smithy.api#documentation": "Template summary information.
" } }, "com.amazonaws.connectcases#TemplateSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#TemplateSummary" } }, "com.amazonaws.connectcases#TextAttributes": { "type": "structure", "members": { "isMultiline": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Attribute that defines rendering component and validation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Field attributes for Text field type.
" } }, "com.amazonaws.connectcases#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The rate has been exceeded for this API. Please try again after a few minutes.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} } }, "com.amazonaws.connectcases#TotalCount": { "type": "long", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.connectcases#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Untags a resource.
", "smithy.api#http": { "uri": "/tags/{arn}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#UntagResourceRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connectcases#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN)
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.connectcases#TagKeyList", "traits": { "smithy.api#documentation": "List of tag keys.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.connectcases#UpdateCase": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#UpdateCaseRequest" }, "output": { "target": "com.amazonaws.connectcases#UpdateCaseResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "aws.iam#iamAction": { "name": "UpdateCase", "relativeDocumentation": "API_UpdateCase.html", "resources": { "required": { "Domain": {}, "Case": {}, "Field": {} } } }, "smithy.api#documentation": "If you provide a value for PerformedBy.UserArn, you must also have the connect:DescribeUser permission on the user ARN 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 case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
", "smithy.api#http": { "uri": "/domains/{domainId}/cases/{caseId}", "method": "PUT" } } }, "com.amazonaws.connectcases#UpdateCaseRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.connectcases#FieldValueList", "traits": { "smithy.api#documentation": "An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase.
Updates a case rule. In the Connect Customer 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.
", "smithy.api#http": { "uri": "/domains/{domainId}/case-rules/{caseRuleId}", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#UpdateCaseRuleRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "Unique identifier of a Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseRuleId": { "target": "com.amazonaws.connectcases#CaseRuleId", "traits": { "smithy.api#documentation": "Unique identifier of a case rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#CaseRuleName", "traits": { "smithy.api#documentation": "Name of the case rule.
" } }, "description": { "target": "com.amazonaws.connectcases#CaseRuleDescription", "traits": { "smithy.api#documentation": "Description of a case rule.
" } }, "rule": { "target": "com.amazonaws.connectcases#CaseRuleDetails", "traits": { "smithy.api#documentation": "Represents what rule type should take place, under what conditions.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#UpdateCaseRuleResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#UpdateField": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#UpdateFieldRequest" }, "output": { "target": "com.amazonaws.connectcases#UpdateFieldResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the properties of an existing field.
", "smithy.api#http": { "uri": "/domains/{domainId}/fields/{fieldId}", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#UpdateFieldRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fieldId": { "target": "com.amazonaws.connectcases#FieldId", "traits": { "smithy.api#documentation": "The unique identifier of a field.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#FieldName", "traits": { "smithy.api#documentation": "The name of the field.
" } }, "description": { "target": "com.amazonaws.connectcases#FieldDescription", "traits": { "smithy.api#documentation": "The description of a field.
" } }, "attributes": { "target": "com.amazonaws.connectcases#FieldAttributes", "traits": { "smithy.api#documentation": "Union of field attributes.
" } } } }, "com.amazonaws.connectcases#UpdateFieldResponse": { "type": "structure", "members": {} }, "com.amazonaws.connectcases#UpdateLayout": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#UpdateLayoutRequest" }, "output": { "target": "com.amazonaws.connectcases#UpdateLayoutResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#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.
The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "layoutId": { "target": "com.amazonaws.connectcases#LayoutId", "traits": { "smithy.api#documentation": "The unique identifier of the layout.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#LayoutName", "traits": { "smithy.api#documentation": "The name of the layout. It must be unique per domain.
" } }, "content": { "target": "com.amazonaws.connectcases#LayoutContent", "traits": { "smithy.api#documentation": "Information about which fields will be present in the layout, the order of the fields.
" } } } }, "com.amazonaws.connectcases#UpdateLayoutResponse": { "type": "structure", "members": {} }, "com.amazonaws.connectcases#UpdateRelatedItem": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#UpdateRelatedItemRequest" }, "output": { "target": "com.amazonaws.connectcases#UpdateRelatedItemResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#documentation": "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 Connect Customer Cases quotas.
Sla - Update the target duration (targetSlaMinutes) of an SLA. The new deadline is counted from when the SLA was created. The SLA status is recalculated against the new deadline: an open SLA becomes Active or Overdue, and a completed SLA becomes Met or NotMet.
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 permission on the ARN of the user that you provide.
System case fields cannot be used in a custom related item.
If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.
Endpoints: See Connect Customer endpoints and quotas.
", "smithy.api#http": { "uri": "/domains/{domainId}/cases/{caseId}/related-items/{relatedItemId}", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#UpdateRelatedItemRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseId": { "target": "com.amazonaws.connectcases#CaseId", "traits": { "smithy.api#documentation": "A unique identifier of the case.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "relatedItemId": { "target": "com.amazonaws.connectcases#RelatedItemId", "traits": { "smithy.api#documentation": "Unique identifier of a related item.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.connectcases#RelatedItemUpdateContent", "traits": { "smithy.api#documentation": "The content of a related item to be updated.
", "smithy.api#required": {} } }, "performedBy": { "target": "com.amazonaws.connectcases#UserUnion", "traits": { "smithy.api#documentation": "Represents the user who performed the update of the related item.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcases#UpdateRelatedItemResponse": { "type": "structure", "members": { "relatedItemId": { "target": "com.amazonaws.connectcases#RelatedItemId", "traits": { "smithy.api#documentation": "The unique identifier of the updated related item.
", "smithy.api#required": {} } }, "relatedItemArn": { "target": "com.amazonaws.connectcases#RelatedItemArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated related item.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connectcases#RelatedItemType", "traits": { "smithy.api#documentation": "Type of the updated related item.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.connectcases#RelatedItemContent", "traits": { "smithy.api#documentation": "Represents the content of the updated related item.
", "smithy.api#required": {} } }, "associationTime": { "target": "com.amazonaws.connectcases#AssociationTime", "traits": { "smithy.api#documentation": "Time at which the related item was associated with the case.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connectcases#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } }, "lastUpdatedUser": { "target": "com.amazonaws.connectcases#UserUnion", "traits": { "smithy.api#documentation": "Represents the last user that updated the related item.
" } }, "createdBy": { "target": "com.amazonaws.connectcases#UserUnion", "traits": { "smithy.api#documentation": "Represents the creator of the related item.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcases#UpdateTemplate": { "type": "operation", "input": { "target": "com.amazonaws.connectcases#UpdateTemplateRequest" }, "output": { "target": "com.amazonaws.connectcases#UpdateTemplateResponse" }, "errors": [ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, { "target": "com.amazonaws.connectcases#ConflictException" }, { "target": "com.amazonaws.connectcases#InternalServerException" }, { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, { "target": "com.amazonaws.connectcases#ValidationException" } ], "traits": { "smithy.api#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.
Other template APIs are:
", "smithy.api#http": { "uri": "/domains/{domainId}/templates/{templateId}", "method": "PUT" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectcases#UpdateTemplateRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connectcases#DomainId", "traits": { "smithy.api#documentation": "The unique identifier of the Cases domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "templateId": { "target": "com.amazonaws.connectcases#TemplateId", "traits": { "smithy.api#documentation": "A unique identifier for the template.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connectcases#TemplateName", "traits": { "smithy.api#documentation": "The name of the template. It must be unique per domain.
" } }, "description": { "target": "com.amazonaws.connectcases#TemplateDescription", "traits": { "smithy.api#documentation": "A brief description of the template.
" } }, "layoutConfiguration": { "target": "com.amazonaws.connectcases#LayoutConfiguration", "traits": { "smithy.api#documentation": "Configuration of layouts associated to the template.
" } }, "requiredFields": { "target": "com.amazonaws.connectcases#RequiredFieldList", "traits": { "smithy.api#documentation": "A list of fields that must contain a value for a case to be successfully created with this template.
To require a Customer Profile when creating cases, include customer_id in this list. If customer_id is omitted, the Customer Profile field is optional and can be added, changed, or removed after case creation.
The status of the template.
" } }, "rules": { "target": "com.amazonaws.connectcases#TemplateCaseRuleList", "traits": { "smithy.api#documentation": "A list of case rules (also known as case field conditions) on a template.
" } }, "tagPropagationConfigurations": { "target": "com.amazonaws.connectcases#TagPropagationConfigurationList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.connectcases#UpdateTemplateResponse": { "type": "structure", "members": {} }, "com.amazonaws.connectcases#UserArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectcases#UserUnion": { "type": "union", "members": { "userArn": { "target": "com.amazonaws.connectcases#UserArn", "traits": { "smithy.api#documentation": "Represents the Connect Customer ARN of the user.
" } }, "customEntity": { "target": "com.amazonaws.connectcases#CustomEntity", "traits": { "smithy.api#documentation": "Any provided entity.
" } } }, "traits": { "smithy.api#documentation": "Represents the entity that performed the action.
" } }, "com.amazonaws.connectcases#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request isn't valid. Check the syntax and try again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.connectcases#Value": { "type": "string", "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.connectcases#ValuesList": { "type": "list", "member": { "target": "com.amazonaws.connectcases#Value" }, "traits": { "smithy.api#length": { "max": 1 } } } } }