Amazon Connect Service

2023/05/18 - Amazon Connect Service - 5 new api methods

Changes  You can programmatically create and manage prompts using APIs, for example, to extract prompts stored within Amazon Connect and add them to your Amazon S3 bucket. AWS CloudTrail, AWS CloudFormation and tagging are supported.

GetPromptFile (new) Link ¶

Gets the prompt file.

See also: AWS API Documentation

Request Syntax

client.get_prompt_file(
    InstanceId='string',
    PromptId='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type PromptId:

string

param PromptId:

[REQUIRED]

A unique identifier for the prompt.

rtype:

dict

returns:

Response Syntax

{
    'PromptPresignedUrl': 'string'
}

Response Structure

  • (dict) --

    • PromptPresignedUrl (string) --

      A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.

CreatePrompt (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.create_prompt(
    InstanceId='string',
    Name='string',
    Description='string',
    S3Uri='string',
    Tags={
        'string': 'string'
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type Name:

string

param Name:

[REQUIRED]

The name of the prompt.

type Description:

string

param Description:

The description of the prompt.

type S3Uri:

string

param S3Uri:

[REQUIRED]

The URI for the S3 bucket where the prompt is stored.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'PromptARN': 'string',
    'PromptId': 'string'
}

Response Structure

  • (dict) --

    • PromptARN (string) --

      The Amazon Resource Name (ARN) of the prompt.

    • PromptId (string) --

      A unique identifier for the prompt.

DeletePrompt (new) Link ¶

Deletes a prompt.

See also: AWS API Documentation

Request Syntax

client.delete_prompt(
    InstanceId='string',
    PromptId='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type PromptId:

string

param PromptId:

[REQUIRED]

A unique identifier for the prompt.

returns:

None

DescribePrompt (new) Link ¶

Describes the prompt.

See also: AWS API Documentation

Request Syntax

client.describe_prompt(
    InstanceId='string',
    PromptId='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type PromptId:

string

param PromptId:

[REQUIRED]

A unique identifier for the prompt.

rtype:

dict

returns:

Response Syntax

{
    'Prompt': {
        'PromptARN': 'string',
        'PromptId': 'string',
        'Name': 'string',
        'Description': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Prompt (dict) --

      Information about the prompt.

      • PromptARN (string) --

        The Amazon Resource Name (ARN) of the prompt.

      • PromptId (string) --

        A unique identifier for the prompt.

      • Name (string) --

        The name of the prompt.

      • Description (string) --

        A description for the prompt.

      • Tags (dict) --

        The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

        • (string) --

          • (string) --

UpdatePrompt (new) Link ¶

Updates a prompt.

See also: AWS API Documentation

Request Syntax

client.update_prompt(
    InstanceId='string',
    PromptId='string',
    Name='string',
    Description='string',
    S3Uri='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type PromptId:

string

param PromptId:

[REQUIRED]

A unique identifier for the prompt.

type Name:

string

param Name:

The name of the prompt.

type Description:

string

param Description:

A description of the prompt.

type S3Uri:

string

param S3Uri:

The URI for the S3 bucket where the prompt is stored.

rtype:

dict

returns:

Response Syntax

{
    'PromptARN': 'string',
    'PromptId': 'string'
}

Response Structure

  • (dict) --

    • PromptARN (string) --

      The Amazon Resource Name (ARN) of the prompt.

    • PromptId (string) --

      A unique identifier for the prompt.