AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing ConnectCases

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ConnectCases.AmazonConnectCasesClient

Namespace: Amazon.ConnectCases
Assembly: AWSSDK.ConnectCases.dll
Version: 3.x.y.z

Syntax

C# 
public class AmazonConnectCasesClient : AmazonServiceClient
         IAmazonConnectCases, IAmazonService, IDisposable

The AmazonConnectCasesClient type exposes the following members

Constructors

NameDescription
Public Method AmazonConnectCasesClient()

Constructs AmazonConnectCasesClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonConnectCasesClient(RegionEndpoint)

Constructs AmazonConnectCasesClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonConnectCasesClient(AmazonConnectCasesConfig)

Constructs AmazonConnectCasesClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonConnectCasesClient(AWSCredentials)

Constructs AmazonConnectCasesClient with AWS Credentials

Public Method AmazonConnectCasesClient(AWSCredentials, RegionEndpoint)

Constructs AmazonConnectCasesClient with AWS Credentials

Public Method AmazonConnectCasesClient(AWSCredentials, AmazonConnectCasesConfig)

Constructs AmazonConnectCasesClient with AWS Credentials and an AmazonConnectCasesClient Configuration object.

Public Method AmazonConnectCasesClient(string, string)

Constructs AmazonConnectCasesClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonConnectCasesClient(string, string, RegionEndpoint)

Constructs AmazonConnectCasesClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonConnectCasesClient(string, string, AmazonConnectCasesConfig)

Constructs AmazonConnectCasesClient with AWS Access Key ID, AWS Secret Key and an AmazonConnectCasesClient Configuration object.

Public Method AmazonConnectCasesClient(string, string, string)

Constructs AmazonConnectCasesClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonConnectCasesClient(string, string, string, RegionEndpoint)

Constructs AmazonConnectCasesClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonConnectCasesClient(string, string, string, AmazonConnectCasesConfig)

Constructs AmazonConnectCasesClient with AWS Access Key ID, AWS Secret Key and an AmazonConnectCasesClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.ConnectCases.Model.IConnectCasesPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchGetCaseRule(BatchGetCaseRuleRequest)

Gets a batch of case rules. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method BatchGetCaseRuleAsync(BatchGetCaseRuleRequest, CancellationToken)

Gets a batch of case rules. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method BatchGetField(BatchGetFieldRequest)

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

Public Method BatchGetFieldAsync(BatchGetFieldRequest, CancellationToken)

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

Public Method BatchPutFieldOptions(BatchPutFieldOptionsRequest)

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

Public Method BatchPutFieldOptionsAsync(BatchPutFieldOptionsRequest, CancellationToken)

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

Public Method CreateCase(CreateCaseRequest)

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

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

The following fields are required when creating a case: 

 
     
  •  
     customer_id - You
            must provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account
            ID:domains/your_profiles_domain_name/profiles/profile_ID 
     
    • 
            
  •  
     title 
     
    •

Public Method CreateCaseAsync(CreateCaseRequest, CancellationToken)

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

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

The following fields are required when creating a case: 

 
     
  •  
     customer_id - You
            must provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account
            ID:domains/your_profiles_domain_name/profiles/profile_ID 
     
    • 
            
  •  
     title 
     
    •

Public Method CreateCaseRule(CreateCaseRuleRequest)

Creates a new case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method CreateCaseRuleAsync(CreateCaseRuleRequest, CancellationToken)

Creates a new case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method CreateDomain(CreateDomainRequest)
Public Method CreateDomainAsync(CreateDomainRequest, CancellationToken)
Public Method CreateField(CreateFieldRequest)

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.

Public Method CreateFieldAsync(CreateFieldRequest, CancellationToken)

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.

Public Method CreateLayout(CreateLayoutRequest)

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.

Public Method CreateLayoutAsync(CreateLayoutRequest, CancellationToken)

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.

Public Method CreateRelatedItem(CreateRelatedItemRequest)

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

  • A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.

  • If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide.

  • The type field is reserved for internal use only.

Public Method CreateRelatedItemAsync(CreateRelatedItemRequest, CancellationToken)

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

  • A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.

  • If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide.

  • The type field is reserved for internal use only.

Public Method CreateTemplate(CreateTemplateRequest)

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:

Public Method CreateTemplateAsync(CreateTemplateRequest, CancellationToken)

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:

Public Method DeleteCaseRule(DeleteCaseRuleRequest)

Deletes a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method DeleteCaseRuleAsync(DeleteCaseRuleRequest, CancellationToken)

Deletes a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method DeleteDomain(DeleteDomainRequest)

Deletes a Cases domain. 

  
After deleting your domain you must disassociate the
            deleted domain from your Amazon Connect instance with another API call before being
            able to use Cases again with this Amazon Connect instance. See DeleteIntegrationAssociation.

Public Method DeleteDomainAsync(DeleteDomainRequest, CancellationToken)

Deletes a Cases domain. 

  
After deleting your domain you must disassociate the
            deleted domain from your Amazon Connect instance with another API call before being
            able to use Cases again with this Amazon Connect instance. See DeleteIntegrationAssociation.

Public Method DeleteField(DeleteFieldRequest)

Deletes a field from a cases template. You can delete up to 100 fields per domain.

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 IDs in the request have been deleted.

  • Calling GetCase with a deleted field ID 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.

Public Method DeleteFieldAsync(DeleteFieldRequest, CancellationToken)

Deletes a field from a cases template. You can delete up to 100 fields per domain.

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 IDs in the request have been deleted.

  • Calling GetCase with a deleted field ID 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.

Public Method DeleteLayout(DeleteLayoutRequest)

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

Public Method DeleteLayoutAsync(DeleteLayoutRequest, CancellationToken)

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

Public Method DeleteTemplate(DeleteTemplateRequest)

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

Public Method DeleteTemplateAsync(DeleteTemplateRequest, CancellationToken)

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

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetCase(GetCaseRequest)

Returns information about a specific case if it exists.

Public Method GetCaseAsync(GetCaseRequest, CancellationToken)

Returns information about a specific case if it exists.

Public Method GetCaseAuditEvents(GetCaseAuditEventsRequest)

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

Public Method GetCaseAuditEventsAsync(GetCaseAuditEventsRequest, CancellationToken)

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

Public Method GetCaseEventConfiguration(GetCaseEventConfigurationRequest)

Returns the case event publishing configuration.

Public Method GetCaseEventConfigurationAsync(GetCaseEventConfigurationRequest, CancellationToken)

Returns the case event publishing configuration.

Public Method GetDomain(GetDomainRequest)

Returns information about a specific domain if it exists.

Public Method GetDomainAsync(GetDomainRequest, CancellationToken)

Returns information about a specific domain if it exists.

Public Method GetLayout(GetLayoutRequest)

Returns the details for the requested layout.

Public Method GetLayoutAsync(GetLayoutRequest, CancellationToken)

Returns the details for the requested layout.

Public Method GetTemplate(GetTemplateRequest)

Returns the details for the requested template. Other template APIs are:

Public Method GetTemplateAsync(GetTemplateRequest, CancellationToken)

Returns the details for the requested template. Other template APIs are:

Public Method ListCaseRules(ListCaseRulesRequest)

Lists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method ListCaseRulesAsync(ListCaseRulesRequest, CancellationToken)

Lists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method ListCasesForContact(ListCasesForContactRequest)

Lists cases for a given contact.

Public Method ListCasesForContactAsync(ListCasesForContactRequest, CancellationToken)

Lists cases for a given contact.

Public Method ListDomains(ListDomainsRequest)

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

Public Method ListDomainsAsync(ListDomainsRequest, CancellationToken)

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

Public Method ListFieldOptions(ListFieldOptionsRequest)

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

Public Method ListFieldOptionsAsync(ListFieldOptionsRequest, CancellationToken)

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

Public Method ListFields(ListFieldsRequest)

Lists all fields in a Cases domain.

Public Method ListFieldsAsync(ListFieldsRequest, CancellationToken)

Lists all fields in a Cases domain.

Public Method ListLayouts(ListLayoutsRequest)

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

Public Method ListLayoutsAsync(ListLayoutsRequest, CancellationToken)

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

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists tags for a resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists tags for a resource.

Public Method ListTemplates(ListTemplatesRequest)

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

Other template APIs are:

Public Method ListTemplatesAsync(ListTemplatesRequest, CancellationToken)

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

Other template APIs are:

Public Method PutCaseEventConfiguration(PutCaseEventConfigurationRequest)

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

Public Method PutCaseEventConfigurationAsync(PutCaseEventConfigurationRequest, CancellationToken)

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

Public Method SearchCases(SearchCasesRequest)

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.

Public Method SearchCasesAsync(SearchCasesRequest, CancellationToken)

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.

Public Method SearchRelatedItems(SearchRelatedItemsRequest)

Searches for related items that are associated with a case.

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

Public Method SearchRelatedItemsAsync(SearchRelatedItemsRequest, CancellationToken)

Searches for related items that are associated with a case.

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

Public Method TagResource(TagResourceRequest)

Adds tags to a resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds tags to a resource.

Public Method UntagResource(UntagResourceRequest)

Untags a resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Untags a resource.

Public Method UpdateCase(UpdateCaseRequest)

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .

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

Public Method UpdateCaseAsync(UpdateCaseRequest, CancellationToken)

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .

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

Public Method UpdateCaseRule(UpdateCaseRuleRequest)

Updates a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method UpdateCaseRuleAsync(UpdateCaseRuleRequest, CancellationToken)

Updates a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Public Method UpdateField(UpdateFieldRequest)

Updates the properties of an existing field.

Public Method UpdateFieldAsync(UpdateFieldRequest, CancellationToken)

Updates the properties of an existing field.

Public Method UpdateLayout(UpdateLayoutRequest)

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.

Public Method UpdateLayoutAsync(UpdateLayoutRequest, CancellationToken)

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.

Public Method UpdateTemplate(UpdateTemplateRequest)

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:

Public Method UpdateTemplateAsync(UpdateTemplateRequest, CancellationToken)

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:

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5