Edit on GitHub

Connectcases

This page documents function available when using the Connectcases module, created with @service Connectcases.

Index

Documentation

Main.Connectcases.batch_get_field — Method
batch_get_field(domain_id, fields)
batch_get_field(domain_id, fields, params::Dict{String,<:Any})

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

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • fields: A list of unique field identifiers.
source
Main.Connectcases.batch_put_field_options — Method
batch_put_field_options(domain_id, field_id, options)
batch_put_field_options(domain_id, field_id, options, params::Dict{String,<:Any})

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

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • field_id: The unique identifier of a field.
  • options: A list of FieldOption objects.
source
Main.Connectcases.create_case — Method
create_case(domain_id, fields, template_id)
create_case(domain_id, fields, template_id, params::Dict{String,<:Any})

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide &lt;p&gt;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.&lt;/p&gt; &lt;p&gt;The following fields are required when creating a case:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;customerid&lt;/code&gt; - You must provide the full customer profile ARN in this format: &lt;code&gt;arn:aws:profile:yourAWSRegion:yourAWSaccount ID:domains/yourprofilesdomainname/profiles/profile_ID&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;title&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;/ul&gt;

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • fields: An array of objects with field ID (matching ListFields/DescribeField) and value union data.
  • template_id: A unique identifier of a template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": 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.
  • "performedBy":
source
Main.Connectcases.create_domain — Method
create_domain(name)
create_domain(name, params::Dict{String,<:Any})

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain. This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases. &lt;/important&gt;

Arguments

  • name: The name for your Cases domain. It must be unique for your Amazon Web Services account.
source
Main.Connectcases.create_field — Method
create_field(domain_id, name, type)
create_field(domain_id, name, type, params::Dict{String,<:Any})

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.

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • name: The name of the field.
  • type: Defines the data type, some system constraints, and default display of the field.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the field.
source
Main.Connectcases.create_layout — Method
create_layout(content, domain_id, name)
create_layout(content, domain_id, name, params::Dict{String,<:Any})

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.

Arguments

  • content: Information about which fields will be present in the layout, and information about the order of the fields.
  • domain_id: The unique identifier of the Cases domain.
  • name: The name of the layout. It must be unique for the Cases domain.
source
Main.Connectcases.create_related_item — Method
create_related_item(case_id, content, domain_id, type)
create_related_item(case_id, content, domain_id, type, params::Dict{String,<:Any})

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. &lt;/note&gt;

Arguments

  • case_id: A unique identifier of the case.
  • content: The content of a related item to be created.
  • domain_id: The unique identifier of the Cases domain.
  • type: The type of a related item.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "performedBy": Represents the creator of the related item.
source
Main.Connectcases.create_template — Method
create_template(domain_id, name)
create_template(domain_id, name, params::Dict{String,<:Any})

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.

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • name: A name for the template. It must be unique per domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the template.
  • "layoutConfiguration": Configuration of layouts associated to the template.
  • "requiredFields": A list of fields that must contain a value for a case to be successfully created with this template.
  • "status": The status of the template.
source
Main.Connectcases.delete_domain — Method
delete_domain(domain_id)
delete_domain(domain_id, params::Dict{String,<:Any})

Deletes a Cases domain. &lt;note&gt; &lt;p&gt;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 &lt;a href=&quot;https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAsso ciation.html&quot;&gt;DeleteIntegrationAssociation&lt;/a&gt;.&lt;/p&gt; &lt;/note&gt;

Arguments

  • domain_id: The unique identifier of the Cases domain.
source
Main.Connectcases.delete_field — Method
delete_field(domain_id, field_id)
delete_field(domain_id, field_id, params::Dict{String,<:Any})

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.

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • field_id: Unique identifier of the field.
source
Main.Connectcases.delete_layout — Method
delete_layout(domain_id, layout_id)
delete_layout(domain_id, layout_id, params::Dict{String,<:Any})

Deletes a layout from a cases template. You can delete up to 100 layouts per domain. &lt;p&gt;After a layout is deleted:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt;You can still retrieve the layout by calling &lt;code&gt;GetLayout&lt;/code&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;You cannot update a deleted layout by calling &lt;code&gt;UpdateLayout&lt;/code&gt;; it throws a &lt;code&gt;ValidationException&lt;/code&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;Deleted layouts are not included in the &lt;code&gt;ListLayouts&lt;/code&gt; response.&lt;/p&gt; &lt;/li&gt; &lt;/ul&gt;

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • layout_id: The unique identifier of the layout.
source
Main.Connectcases.delete_template — Method
delete_template(domain_id, template_id)
delete_template(domain_id, template_id, params::Dict{String,<:Any})

Deletes a cases template. You can delete up to 100 templates per domain. &lt;p&gt;After a cases template is deleted:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt;You can still retrieve the template by calling &lt;code&gt;GetTemplate&lt;/code&gt;.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;You cannot update the template. &lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;You cannot create a case by using the deleted template.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;Deleted templates are not included in the &lt;code&gt;ListTemplates&lt;/code&gt; response.&lt;/p&gt; &lt;/li&gt; &lt;/ul&gt;

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • template_id: A unique identifier of a template.
source
Main.Connectcases.get_case — Method
get_case(case_id, domain_id, fields)
get_case(case_id, domain_id, fields, params::Dict{String,<:Any})

Returns information about a specific case if it exists.

Arguments

  • case_id: A unique identifier of the case.
  • domain_id: The unique identifier of the Cases domain.
  • fields: A list of unique field identifiers.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": 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.
source
Main.Connectcases.get_case_audit_events — Method
get_case_audit_events(case_id, domain_id)
get_case_audit_events(case_id, domain_id, params::Dict{String,<:Any})

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

Arguments

  • case_id: A unique identifier of the case.
  • domain_id: The unique identifier of the Cases domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided.
  • "nextToken": 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.
source
Main.Connectcases.get_case_event_configuration — Method
get_case_event_configuration(domain_id)
get_case_event_configuration(domain_id, params::Dict{String,<:Any})

Returns the case event publishing configuration.

Arguments

  • domain_id: The unique identifier of the Cases domain.
source
Main.Connectcases.get_domain — Method
get_domain(domain_id)
get_domain(domain_id, params::Dict{String,<:Any})

Returns information about a specific domain if it exists.

Arguments

  • domain_id: The unique identifier of the Cases domain.
source
Main.Connectcases.get_layout — Method
get_layout(domain_id, layout_id)
get_layout(domain_id, layout_id, params::Dict{String,<:Any})

Returns the details for the requested layout.

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • layout_id: The unique identifier of the layout.
source
Main.Connectcases.get_template — Method
get_template(domain_id, template_id)
get_template(domain_id, template_id, params::Dict{String,<:Any})

Returns the details for the requested template.

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • template_id: A unique identifier of a template.
source
Main.Connectcases.list_cases_for_contact — Method
list_cases_for_contact(contact_arn, domain_id)
list_cases_for_contact(contact_arn, domain_id, params::Dict{String,<:Any})

Lists cases for a given contact.

Arguments

  • contact_arn: A unique identifier of a contact in Amazon Connect.
  • domain_id: The unique identifier of the Cases domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connectcases.list_domains — Method
list_domains()
list_domains(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connectcases.list_field_options — Method
list_field_options(domain_id, field_id)
list_field_options(domain_id, field_id, params::Dict{String,<:Any})

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

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • field_id: The unique identifier of a field.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
  • "values": A list of FieldOption values to filter on for ListFieldOptions.
source
Main.Connectcases.list_fields — Method
list_fields(domain_id)
list_fields(domain_id, params::Dict{String,<:Any})

Lists all fields in a Cases domain.

Arguments

  • domain_id: The unique identifier of the Cases domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connectcases.list_layouts — Method
list_layouts(domain_id)
list_layouts(domain_id, params::Dict{String,<:Any})

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

Arguments

  • domain_id: The unique identifier of the Cases domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connectcases.list_templates — Method
list_templates(domain_id)
list_templates(domain_id, params::Dict{String,<:Any})

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

Arguments

  • domain_id: The unique identifier of the Cases domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
  • "status": A list of status values to filter on.
source
Main.Connectcases.put_case_event_configuration — Method
put_case_event_configuration(domain_id, event_bridge)
put_case_event_configuration(domain_id, event_bridge, params::Dict{String,<:Any})

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

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • event_bridge: Configuration to enable EventBridge case event delivery and determine what data is delivered.
source
Main.Connectcases.search_cases — Method
search_cases(domain_id)
search_cases(domain_id, params::Dict{String,<:Any})

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.

Arguments

  • domain_id: The unique identifier of the Cases domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "fields": The list of field identifiers to be returned as part of the response.
  • "filter": A list of filter objects.
  • "maxResults": The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
  • "nextToken": 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": A word or phrase used to perform a quick search.
  • "sorts": A list of sorts where each sort specifies a field and their sort order to be applied to the results.
source
Main.Connectcases.search_related_items — Method
search_related_items(case_id, domain_id)
search_related_items(case_id, domain_id, params::Dict{String,<:Any})

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

Arguments

  • case_id: A unique identifier of the case.
  • domain_id: The unique identifier of the Cases domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": The list of types of related items and their parameters to use for filtering.
  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connectcases.tag_resource — Method
tag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})

Adds tags to a resource.

Arguments

  • arn: The Amazon Resource Name (ARN)
  • tags: A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
source
Main.Connectcases.untag_resource — Method
untag_resource(arn, tag_keys)
untag_resource(arn, tag_keys, params::Dict{String,<:Any})

Untags a resource.

Arguments

  • arn: The Amazon Resource Name (ARN)
  • tag_keys: List of tag keys.
source
Main.Connectcases.update_case — Method
update_case(case_id, domain_id, fields)
update_case(case_id, domain_id, fields, params::Dict{String,<:Any})

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide &lt;p&gt;Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the &lt;code&gt;CreateCase&lt;/code&gt; input .&lt;/p&gt; &lt;p&gt;If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.&lt;/p&gt;

Arguments

  • case_id: A unique identifier of the case.
  • domain_id: The unique identifier of the Cases domain.
  • fields: An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "performedBy":
source
Main.Connectcases.update_field — Method
update_field(domain_id, field_id)
update_field(domain_id, field_id, params::Dict{String,<:Any})

Updates the properties of an existing field.

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • field_id: The unique identifier of a field.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of a field.
  • "name": The name of the field.
source
Main.Connectcases.update_layout — Method
update_layout(domain_id, layout_id)
update_layout(domain_id, layout_id, params::Dict{String,<:Any})

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.

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • layout_id: The unique identifier of the layout.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "content": Information about which fields will be present in the layout, the order of the fields.
  • "name": The name of the layout. It must be unique per domain.
source
Main.Connectcases.update_template — Method
update_template(domain_id, template_id)
update_template(domain_id, template_id, params::Dict{String,<:Any})

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.

Arguments

  • domain_id: The unique identifier of the Cases domain.
  • template_id: A unique identifier for the template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the template.
  • "layoutConfiguration": Configuration of layouts associated to the template.
  • "name": The name of the template. It must be unique per domain.
  • "requiredFields": A list of fields that must contain a value for a case to be successfully created with this template.
  • "status": The status of the template.
source