prompts

Creates, updates, deletes or gets a prompt resource or lists prompts in a region

Overview

Name	prompts
Type	Resource
Description	Resource Type definition for AWS::Connect::Prompt
Id	aws.connect.prompts

Fields

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
name	string	The name of the prompt.
description	string	The description of the prompt.
s3_uri	string	S3 URI of the customer's audio file for creating prompts resource..
prompt_arn	string	The Amazon Resource Name (ARN) for the prompt.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all prompts in a region.

SELECT
region,
instance_arn,
name,
description,
s3_uri,
prompt_arn,
tags
FROM aws.connect.prompts
WHERE region = 'us-east-1';

Gets all properties from an individual prompt.

SELECT
region,
instance_arn,
name,
description,
s3_uri,
prompt_arn,
tags
FROM aws.connect.prompts
WHERE region = 'us-east-1' AND data__Identifier = '<PromptArn>';

INSERT example

Use the following StackQL query and manifest file to create a new prompt resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.connect.prompts (
 InstanceArn,
 Name,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.prompts (
 InstanceArn,
 Name,
 Description,
 S3Uri,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ Name }}',
 '{{ Description }}',
 '{{ S3Uri }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: prompt
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: S3Uri
        value: '{{ S3Uri }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.prompts
WHERE data__Identifier = '<PromptArn>'
AND region = 'us-east-1';

Permissions

To operate on the prompts resource, the following permissions are required:

Create

connect:CreatePrompt,
connect:TagResource,
s3:GetObject,
kms:Decrypt,
s3:GetObjectAcl

Read

connect:DescribePrompt

Update

connect:UpdatePrompt,
connect:TagResource,
connect:UntagResource

Delete

connect:DeletePrompt

List

connect:ListPrompts