prompts

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

Overview

Name	prompts
Type	Resource
Id	aws.connect.prompts

Fields

The following fields are returned by SELECT queries:

describe_prompt

Name	Datatype	Description
description	string	The description of the prompt.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the prompt.
prompt_arn	string	The Amazon Resource Name (ARN) of the prompt.
prompt_id	string	A unique identifier for the prompt.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

list_prompts

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the prompt.
id	string	The identifier of the prompt.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the prompt.

search_prompts

Name	Datatype	Description
description	string	The description of the prompt.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the prompt.
prompt_arn	string	The Amazon Resource Name (ARN) of the prompt.
prompt_id	string	A unique identifier for the prompt.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_prompt	select	instance_id, prompt_id, region		Describes the prompt.
list_prompts	select	instance_id, region	nextToken, maxResults	Provides information about the prompts for the specified Connect Customer instance.
search_prompts	select	region		Searches prompts in an Connect Customer instance, with optional filtering.
create_prompt	insert	instance_id, region, S3Uri		Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Connect Customer Administrator Guide.
update_prompt	update	instance_id, prompt_id, region		Updates a prompt.
delete_prompt	delete	instance_id, prompt_id, region		Deletes a prompt.

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.
prompt_id	string	A unique identifier for the prompt.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page. The default MaxResult size is 100.
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

describe_prompt

Describes the prompt.

SELECT
description,
last_modified_region,
last_modified_time,
name,
prompt_arn,
prompt_id,
tags
FROM aws.connect.prompts
WHERE instance_id = '{{ instance_id }}' -- required
AND prompt_id = '{{ prompt_id }}' -- required
AND region = '{{ region }}' -- required
;

list_prompts

Provides information about the prompts for the specified Connect Customer instance.

SELECT
arn,
id,
last_modified_region,
last_modified_time,
name
FROM aws.connect.prompts
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

search_prompts

Searches prompts in an Connect Customer instance, with optional filtering.

SELECT
description,
last_modified_region,
last_modified_time,
name,
prompt_arn,
prompt_id,
tags
FROM aws.connect.prompts
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_prompt

Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Connect Customer Administrator Guide.

INSERT INTO aws.connect.prompts (
Name,
Description,
S3Uri,
Tags,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ S3Uri }}' /* required */,
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
prompt_arn,
prompt_id
;

Manifest

# Description fields are for documentation purposes
- name: prompts
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the prompts resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the prompts resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: S3Uri
    value: "{{ S3Uri }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_prompt

Updates a prompt.

UPDATE aws.connect.prompts
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
S3Uri = '{{ S3Uri }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND prompt_id = '{{ prompt_id }}' --required
AND region = '{{ region }}' --required
RETURNING
prompt_arn,
prompt_id;

DELETE examples

delete_prompt

Deletes a prompt.

DELETE FROM aws.connect.prompts
WHERE instance_id = '{{ instance_id }}' --required
AND prompt_id = '{{ prompt_id }}' --required
AND region = '{{ region }}' --required
;