Client

connectcases

R Documentation

Amazon Connect Cases¶

Description¶

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.

Usage¶

connectcases(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- connectcases(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

batch_get_field: Returns the description for the list of fields in the request parameters
batch_put_field_options: Creates and updates a set of field options for a single select field in a Cases domain
create_case: If you provide a value for PerformedBy
create_domain: Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts
create_field: Creates a field in the Cases domain
create_layout: Creates a layout in the Cases domain
create_related_item: Creates a related item (comments, tasks, and contacts) and associates it with a case
create_template: Creates a template in the Cases domain
delete_domain: Deletes a Cases domain
delete_field: Deletes a field from a cases template
delete_layout: Deletes a layout from a cases template
delete_template: Deletes a cases template
get_case: Returns information about a specific case if it exists
get_case_audit_events: Returns the audit history about a specific case if it exists
get_case_event_configuration: Returns the case event publishing configuration
get_domain: Returns information about a specific domain if it exists
get_layout: Returns the details for the requested layout
get_template: Returns the details for the requested template
list_cases_for_contact: Lists cases for a given contact
list_domains: Lists all cases domains in the Amazon Web Services account
list_field_options: Lists all of the field options for a field identifier in the domain
list_fields: Lists all fields in a Cases domain
list_layouts: Lists all layouts in the given cases domain
list_tags_for_resource: Lists tags for a resource
list_templates: Lists all of the templates in a Cases domain
put_case_event_configuration: Adds case event publishing configuration
search_cases: Searches for cases within their associated Cases domain
search_related_items: Searches for related items that are associated with a case
tag_resource: Adds tags to a resource
untag_resource: Untags a resource
update_case: If you provide a value for PerformedBy
update_field: Updates the properties of an existing field
update_layout: Updates the attributes of an existing layout
update_template: Updates the attributes of an existing template

Examples¶

## Not run: 
svc <- connectcases()
svc$batch_get_field(
  Foo = 123
)

## End(Not run)