use_cases

Creates, updates, deletes, gets or lists a use_cases resource.

Overview

Name	use_cases
Type	Resource
Id	aws.connect.use_cases

Fields

The following fields are returned by SELECT queries:

list_use_cases

Name	Datatype	Description
use_case_arn	string	The Amazon Resource Name (ARN) for the use case.
use_case_id	string	The identifier for the use case.
use_case_type	string	The type of use case to associate to the integration association. Each integration association can have only one of each use case type. (RULES_EVALUATION, CONNECT_CAMPAIGNS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_use_cases	select	instance_id, integration_association_id, region	nextToken, maxResults	Lists the use cases for the integration association.
create_use_case	insert	instance_id, integration_association_id, region, UseCaseType		Creates a use case for an integration association.
delete_use_case	delete	instance_id, integration_association_id, use_case_id, region		Deletes a use case from an integration association.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
integration_association_id	string	The identifier for the integration association.
region	string	AWS region (default: us-east-1)
use_case_id	string	The identifier for the use case.
maxResults	integer	The maximum number of results to return per page.
nextToken	string	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.

SELECT examples

list_use_cases

Lists the use cases for the integration association.

SELECT
use_case_arn,
use_case_id,
use_case_type
FROM aws.connect.use_cases
WHERE instance_id = '{{ instance_id }}' -- required
AND integration_association_id = '{{ integration_association_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_use_case

Creates a use case for an integration association.

INSERT INTO aws.connect.use_cases (
UseCaseType,
Tags,
instance_id,
integration_association_id,
region
)
SELECT 
'{{ UseCaseType }}' /* required */,
'{{ Tags }}',
'{{ instance_id }}',
'{{ integration_association_id }}',
'{{ region }}'
RETURNING
use_case_arn,
use_case_id
;

Manifest

# Description fields are for documentation purposes
- name: use_cases
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the use_cases resource.
  - name: integration_association_id
    value: "{{ integration_association_id }}"
    description: Required parameter for the use_cases resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the use_cases resource.
  - name: UseCaseType
    value: "{{ UseCaseType }}"
    valid_values: ['RULES_EVALUATION', 'CONNECT_CAMPAIGNS']
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_use_case

Deletes a use case from an integration association.

DELETE FROM aws.connect.use_cases
WHERE instance_id = '{{ instance_id }}' --required
AND integration_association_id = '{{ integration_association_id }}' --required
AND use_case_id = '{{ use_case_id }}' --required
AND region = '{{ region }}' --required
;