Amazon Q Connect

2026/01/15 - Amazon Q Connect - 4 updated api methods

Changes  Fix inference configuration shapes for the CreateAIPrompt and UpdateAIPrompt APIs, Modify Text Length Limit for SendMessage API

CreateAIPrompt (updated) Link ¶
Changes (request, response)
Request 
{'inferenceConfiguration': {'maxTokensToSample': 'integer',
                            'temperature': 'float',
                            'topK': 'integer',
                            'topP': 'float'}}
Response 
{'aiPrompt': {'inferenceConfiguration': {'maxTokensToSample': 'integer',
                                         'temperature': 'float',
                                         'topK': 'integer',
                                         'topP': 'float'}}}

Creates an Amazon Q in Connect AI Prompt.

See also: AWS API Documentation

Request Syntax

client.create_ai_prompt(
    clientToken='string',
    assistantId='string',
    name='string',
    type='ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'EMAIL_QUERY_REFORMULATION'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
    templateConfiguration={
        'textFullAIPromptEditTemplateConfiguration': {
            'text': 'string'
        }
    },
    visibilityStatus='SAVED'|'PUBLISHED',
    templateType='TEXT',
    modelId='string',
    apiFormat='ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
    tags={
        'string': 'string'
    },
    description='string',
    inferenceConfiguration={
        'temperature': ...,
        'topP': ...,
        'topK': 123,
        'maxTokensToSample': 123
    }
)
type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

This field is autopopulated if not provided.

type assistantId:

string

param assistantId:

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type name:

string

param name:

[REQUIRED]

The name of the AI Prompt.

type type:

string

param type:

[REQUIRED]

The type of this AI Prompt.

type templateConfiguration:

dict

param templateConfiguration:

[REQUIRED]

The configuration of the prompt template for this AI Prompt.

  • textFullAIPromptEditTemplateConfiguration (dict) --

    The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

    • text (string) -- [REQUIRED]

      The YAML text for the AI Prompt template.

type visibilityStatus:

string

param visibilityStatus:

[REQUIRED]

The visibility status of the AI Prompt.

type templateType:

string

param templateType:

[REQUIRED]

The type of the prompt template for this AI Prompt.

type modelId:

string

param modelId:

[REQUIRED]

The identifier of the model used for this AI Prompt.

type apiFormat:

string

param apiFormat:

[REQUIRED]

The API Format of the AI Prompt.

Recommended values: MESSAGES | TEXT_COMPLETIONS

type tags:

dict

param tags:

The tags used to organize, track, or control access for this resource.

  • (string) --

    • (string) --

type description:

string

param description:

The description of the AI Prompt.

type inferenceConfiguration:

dict

param inferenceConfiguration:

The inference configuration for the AI Prompt being created.

  • temperature (float) --

    The temperature setting for controlling randomness in the generated response.

  • topP (float) --

    The top-P sampling parameter for nucleus sampling.

  • topK (integer) --

    The top-K sampling parameter for token selection.

  • maxTokensToSample (integer) --

    The maximum number of tokens to generate in the response.

rtype:

dict

returns:

Response Syntax

{
    'aiPrompt': {
        'assistantId': 'string',
        'assistantArn': 'string',
        'aiPromptId': 'string',
        'aiPromptArn': 'string',
        'name': 'string',
        'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'EMAIL_QUERY_REFORMULATION'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
        'templateType': 'TEXT',
        'modelId': 'string',
        'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
        'templateConfiguration': {
            'textFullAIPromptEditTemplateConfiguration': {
                'text': 'string'
            }
        },
        'inferenceConfiguration': {
            'temperature': ...,
            'topP': ...,
            'topK': 123,
            'maxTokensToSample': 123
        },
        'modifiedTime': datetime(2015, 1, 1),
        'description': 'string',
        'visibilityStatus': 'SAVED'|'PUBLISHED',
        'tags': {
            'string': 'string'
        },
        'origin': 'SYSTEM'|'CUSTOMER',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • aiPrompt (dict) --

      The data of the AI Prompt.

      • assistantId (string) --

        The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • assistantArn (string) --

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      • aiPromptId (string) --

        The identifier of the Amazon Q in Connect AI prompt.

      • aiPromptArn (string) --

        The Amazon Resource Name (ARN) of the AI Prompt.

      • name (string) --

        The name of the AI Prompt

      • type (string) --

        The type of this AI Prompt.

      • templateType (string) --

        The type of the prompt template for this AI Prompt.

      • modelId (string) --

        The identifier of the model used for this AI Prompt. The following model Ids are supported:

        • anthropic.claude-3-haiku--v1:0

        • apac.amazon.nova-lite-v1:0

        • apac.amazon.nova-micro-v1:0

        • apac.amazon.nova-pro-v1:0

        • apac.anthropic.claude-3-5-sonnet--v2:0

        • apac.anthropic.claude-3-haiku-20240307-v1:0

        • eu.amazon.nova-lite-v1:0

        • eu.amazon.nova-micro-v1:0

        • eu.amazon.nova-pro-v1:0

        • eu.anthropic.claude-3-7-sonnet-20250219-v1:0

        • eu.anthropic.claude-3-haiku-20240307-v1:0

        • us.amazon.nova-lite-v1:0

        • us.amazon.nova-micro-v1:0

        • us.amazon.nova-pro-v1:0

        • us.anthropic.claude-3-5-haiku-20241022-v1:0

        • us.anthropic.claude-3-7-sonnet-20250219-v1:0

        • us.anthropic.claude-3-haiku-20240307-v1:0

      • apiFormat (string) --

        The API format used for this AI Prompt.

      • templateConfiguration (dict) --

        The configuration of the prompt template for this AI Prompt.

        • textFullAIPromptEditTemplateConfiguration (dict) --

          The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

          • text (string) --

            The YAML text for the AI Prompt template.

      • inferenceConfiguration (dict) --

        The configuration for inference parameters when using the AI Prompt.

        • temperature (float) --

          The temperature setting for controlling randomness in the generated response.

        • topP (float) --

          The top-P sampling parameter for nucleus sampling.

        • topK (integer) --

          The top-K sampling parameter for token selection.

        • maxTokensToSample (integer) --

          The maximum number of tokens to generate in the response.

      • modifiedTime (datetime) --

        The time the AI Prompt was last modified.

      • description (string) --

        The description of the AI Prompt.

      • visibilityStatus (string) --

        The visibility status of the AI Prompt.

      • tags (dict) --

        The tags used to organize, track, or control access for this resource.

        • (string) --

          • (string) --

      • origin (string) --

        The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

      • status (string) --

        The status of the AI Prompt.

CreateAIPromptVersion (updated) Link ¶
Changes (response) 
{'aiPrompt': {'inferenceConfiguration': {'maxTokensToSample': 'integer',
                                         'temperature': 'float',
                                         'topK': 'integer',
                                         'topP': 'float'}}}

Creates an Amazon Q in Connect AI Prompt version.

See also: AWS API Documentation

Request Syntax

client.create_ai_prompt_version(
    assistantId='string',
    aiPromptId='string',
    modifiedTime=datetime(2015, 1, 1),
    clientToken='string'
)
type assistantId:

string

param assistantId:

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type aiPromptId:

string

param aiPromptId:

[REQUIRED]

The identifier of the Amazon Q in Connect AI prompt.

type modifiedTime:

datetime

param modifiedTime:

The time the AI Prompt was last modified.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'aiPrompt': {
        'assistantId': 'string',
        'assistantArn': 'string',
        'aiPromptId': 'string',
        'aiPromptArn': 'string',
        'name': 'string',
        'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'EMAIL_QUERY_REFORMULATION'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
        'templateType': 'TEXT',
        'modelId': 'string',
        'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
        'templateConfiguration': {
            'textFullAIPromptEditTemplateConfiguration': {
                'text': 'string'
            }
        },
        'inferenceConfiguration': {
            'temperature': ...,
            'topP': ...,
            'topK': 123,
            'maxTokensToSample': 123
        },
        'modifiedTime': datetime(2015, 1, 1),
        'description': 'string',
        'visibilityStatus': 'SAVED'|'PUBLISHED',
        'tags': {
            'string': 'string'
        },
        'origin': 'SYSTEM'|'CUSTOMER',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'
    },
    'versionNumber': 123
}

Response Structure

  • (dict) --

    • aiPrompt (dict) --

      The data of the AI Prompt version.

      • assistantId (string) --

        The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • assistantArn (string) --

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      • aiPromptId (string) --

        The identifier of the Amazon Q in Connect AI prompt.

      • aiPromptArn (string) --

        The Amazon Resource Name (ARN) of the AI Prompt.

      • name (string) --

        The name of the AI Prompt

      • type (string) --

        The type of this AI Prompt.

      • templateType (string) --

        The type of the prompt template for this AI Prompt.

      • modelId (string) --

        The identifier of the model used for this AI Prompt. The following model Ids are supported:

        • anthropic.claude-3-haiku--v1:0

        • apac.amazon.nova-lite-v1:0

        • apac.amazon.nova-micro-v1:0

        • apac.amazon.nova-pro-v1:0

        • apac.anthropic.claude-3-5-sonnet--v2:0

        • apac.anthropic.claude-3-haiku-20240307-v1:0

        • eu.amazon.nova-lite-v1:0

        • eu.amazon.nova-micro-v1:0

        • eu.amazon.nova-pro-v1:0

        • eu.anthropic.claude-3-7-sonnet-20250219-v1:0

        • eu.anthropic.claude-3-haiku-20240307-v1:0

        • us.amazon.nova-lite-v1:0

        • us.amazon.nova-micro-v1:0

        • us.amazon.nova-pro-v1:0

        • us.anthropic.claude-3-5-haiku-20241022-v1:0

        • us.anthropic.claude-3-7-sonnet-20250219-v1:0

        • us.anthropic.claude-3-haiku-20240307-v1:0

      • apiFormat (string) --

        The API format used for this AI Prompt.

      • templateConfiguration (dict) --

        The configuration of the prompt template for this AI Prompt.

        • textFullAIPromptEditTemplateConfiguration (dict) --

          The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

          • text (string) --

            The YAML text for the AI Prompt template.

      • inferenceConfiguration (dict) --

        The configuration for inference parameters when using the AI Prompt.

        • temperature (float) --

          The temperature setting for controlling randomness in the generated response.

        • topP (float) --

          The top-P sampling parameter for nucleus sampling.

        • topK (integer) --

          The top-K sampling parameter for token selection.

        • maxTokensToSample (integer) --

          The maximum number of tokens to generate in the response.

      • modifiedTime (datetime) --

        The time the AI Prompt was last modified.

      • description (string) --

        The description of the AI Prompt.

      • visibilityStatus (string) --

        The visibility status of the AI Prompt.

      • tags (dict) --

        The tags used to organize, track, or control access for this resource.

        • (string) --

          • (string) --

      • origin (string) --

        The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

      • status (string) --

        The status of the AI Prompt.

    • versionNumber (integer) --

      The version number of the AI Prompt version.

GetAIPrompt (updated) Link ¶
Changes (response) 
{'aiPrompt': {'inferenceConfiguration': {'maxTokensToSample': 'integer',
                                         'temperature': 'float',
                                         'topK': 'integer',
                                         'topP': 'float'}}}

Gets and Amazon Q in Connect AI Prompt.

See also: AWS API Documentation

Request Syntax

client.get_ai_prompt(
    assistantId='string',
    aiPromptId='string'
)
type assistantId:

string

param assistantId:

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type aiPromptId:

string

param aiPromptId:

[REQUIRED]

The identifier of the Amazon Q in Connect AI prompt.

rtype:

dict

returns:

Response Syntax

{
    'aiPrompt': {
        'assistantId': 'string',
        'assistantArn': 'string',
        'aiPromptId': 'string',
        'aiPromptArn': 'string',
        'name': 'string',
        'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'EMAIL_QUERY_REFORMULATION'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
        'templateType': 'TEXT',
        'modelId': 'string',
        'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
        'templateConfiguration': {
            'textFullAIPromptEditTemplateConfiguration': {
                'text': 'string'
            }
        },
        'inferenceConfiguration': {
            'temperature': ...,
            'topP': ...,
            'topK': 123,
            'maxTokensToSample': 123
        },
        'modifiedTime': datetime(2015, 1, 1),
        'description': 'string',
        'visibilityStatus': 'SAVED'|'PUBLISHED',
        'tags': {
            'string': 'string'
        },
        'origin': 'SYSTEM'|'CUSTOMER',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'
    },
    'versionNumber': 123
}

Response Structure

  • (dict) --

    • aiPrompt (dict) --

      The data of the AI Prompt.

      • assistantId (string) --

        The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • assistantArn (string) --

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      • aiPromptId (string) --

        The identifier of the Amazon Q in Connect AI prompt.

      • aiPromptArn (string) --

        The Amazon Resource Name (ARN) of the AI Prompt.

      • name (string) --

        The name of the AI Prompt

      • type (string) --

        The type of this AI Prompt.

      • templateType (string) --

        The type of the prompt template for this AI Prompt.

      • modelId (string) --

        The identifier of the model used for this AI Prompt. The following model Ids are supported:

        • anthropic.claude-3-haiku--v1:0

        • apac.amazon.nova-lite-v1:0

        • apac.amazon.nova-micro-v1:0

        • apac.amazon.nova-pro-v1:0

        • apac.anthropic.claude-3-5-sonnet--v2:0

        • apac.anthropic.claude-3-haiku-20240307-v1:0

        • eu.amazon.nova-lite-v1:0

        • eu.amazon.nova-micro-v1:0

        • eu.amazon.nova-pro-v1:0

        • eu.anthropic.claude-3-7-sonnet-20250219-v1:0

        • eu.anthropic.claude-3-haiku-20240307-v1:0

        • us.amazon.nova-lite-v1:0

        • us.amazon.nova-micro-v1:0

        • us.amazon.nova-pro-v1:0

        • us.anthropic.claude-3-5-haiku-20241022-v1:0

        • us.anthropic.claude-3-7-sonnet-20250219-v1:0

        • us.anthropic.claude-3-haiku-20240307-v1:0

      • apiFormat (string) --

        The API format used for this AI Prompt.

      • templateConfiguration (dict) --

        The configuration of the prompt template for this AI Prompt.

        • textFullAIPromptEditTemplateConfiguration (dict) --

          The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

          • text (string) --

            The YAML text for the AI Prompt template.

      • inferenceConfiguration (dict) --

        The configuration for inference parameters when using the AI Prompt.

        • temperature (float) --

          The temperature setting for controlling randomness in the generated response.

        • topP (float) --

          The top-P sampling parameter for nucleus sampling.

        • topK (integer) --

          The top-K sampling parameter for token selection.

        • maxTokensToSample (integer) --

          The maximum number of tokens to generate in the response.

      • modifiedTime (datetime) --

        The time the AI Prompt was last modified.

      • description (string) --

        The description of the AI Prompt.

      • visibilityStatus (string) --

        The visibility status of the AI Prompt.

      • tags (dict) --

        The tags used to organize, track, or control access for this resource.

        • (string) --

          • (string) --

      • origin (string) --

        The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

      • status (string) --

        The status of the AI Prompt.

    • versionNumber (integer) --

      The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the aiPromptId on the request).

UpdateAIPrompt (updated) Link ¶
Changes (request, response)
Request 
{'inferenceConfiguration': {'maxTokensToSample': 'integer',
                            'temperature': 'float',
                            'topK': 'integer',
                            'topP': 'float'}}
Response 
{'aiPrompt': {'inferenceConfiguration': {'maxTokensToSample': 'integer',
                                         'temperature': 'float',
                                         'topK': 'integer',
                                         'topP': 'float'}}}

Updates an AI Prompt.

See also: AWS API Documentation

Request Syntax

client.update_ai_prompt(
    clientToken='string',
    assistantId='string',
    aiPromptId='string',
    visibilityStatus='SAVED'|'PUBLISHED',
    templateConfiguration={
        'textFullAIPromptEditTemplateConfiguration': {
            'text': 'string'
        }
    },
    description='string',
    modelId='string',
    inferenceConfiguration={
        'temperature': ...,
        'topP': ...,
        'topK': 123,
        'maxTokensToSample': 123
    }
)
type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

This field is autopopulated if not provided.

type assistantId:

string

param assistantId:

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type aiPromptId:

string

param aiPromptId:

[REQUIRED]

The identifier of the Amazon Q in Connect AI Prompt.

type visibilityStatus:

string

param visibilityStatus:

[REQUIRED]

The visibility status of the Amazon Q in Connect AI prompt.

type templateConfiguration:

dict

param templateConfiguration:

The configuration of the prompt template for this AI Prompt.

  • textFullAIPromptEditTemplateConfiguration (dict) --

    The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

    • text (string) -- [REQUIRED]

      The YAML text for the AI Prompt template.

type description:

string

param description:

The description of the Amazon Q in Connect AI Prompt.

type modelId:

string

param modelId:

The identifier of the model used for this AI Prompt.

type inferenceConfiguration:

dict

param inferenceConfiguration:

The updated inference configuration for the AI Prompt.

  • temperature (float) --

    The temperature setting for controlling randomness in the generated response.

  • topP (float) --

    The top-P sampling parameter for nucleus sampling.

  • topK (integer) --

    The top-K sampling parameter for token selection.

  • maxTokensToSample (integer) --

    The maximum number of tokens to generate in the response.

rtype:

dict

returns:

Response Syntax

{
    'aiPrompt': {
        'assistantId': 'string',
        'assistantArn': 'string',
        'aiPromptId': 'string',
        'aiPromptArn': 'string',
        'name': 'string',
        'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'EMAIL_QUERY_REFORMULATION'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
        'templateType': 'TEXT',
        'modelId': 'string',
        'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
        'templateConfiguration': {
            'textFullAIPromptEditTemplateConfiguration': {
                'text': 'string'
            }
        },
        'inferenceConfiguration': {
            'temperature': ...,
            'topP': ...,
            'topK': 123,
            'maxTokensToSample': 123
        },
        'modifiedTime': datetime(2015, 1, 1),
        'description': 'string',
        'visibilityStatus': 'SAVED'|'PUBLISHED',
        'tags': {
            'string': 'string'
        },
        'origin': 'SYSTEM'|'CUSTOMER',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • aiPrompt (dict) --

      The data of the updated Amazon Q in Connect AI Prompt.

      • assistantId (string) --

        The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • assistantArn (string) --

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      • aiPromptId (string) --

        The identifier of the Amazon Q in Connect AI prompt.

      • aiPromptArn (string) --

        The Amazon Resource Name (ARN) of the AI Prompt.

      • name (string) --

        The name of the AI Prompt

      • type (string) --

        The type of this AI Prompt.

      • templateType (string) --

        The type of the prompt template for this AI Prompt.

      • modelId (string) --

        The identifier of the model used for this AI Prompt. The following model Ids are supported:

        • anthropic.claude-3-haiku--v1:0

        • apac.amazon.nova-lite-v1:0

        • apac.amazon.nova-micro-v1:0

        • apac.amazon.nova-pro-v1:0

        • apac.anthropic.claude-3-5-sonnet--v2:0

        • apac.anthropic.claude-3-haiku-20240307-v1:0

        • eu.amazon.nova-lite-v1:0

        • eu.amazon.nova-micro-v1:0

        • eu.amazon.nova-pro-v1:0

        • eu.anthropic.claude-3-7-sonnet-20250219-v1:0

        • eu.anthropic.claude-3-haiku-20240307-v1:0

        • us.amazon.nova-lite-v1:0

        • us.amazon.nova-micro-v1:0

        • us.amazon.nova-pro-v1:0

        • us.anthropic.claude-3-5-haiku-20241022-v1:0

        • us.anthropic.claude-3-7-sonnet-20250219-v1:0

        • us.anthropic.claude-3-haiku-20240307-v1:0

      • apiFormat (string) --

        The API format used for this AI Prompt.

      • templateConfiguration (dict) --

        The configuration of the prompt template for this AI Prompt.

        • textFullAIPromptEditTemplateConfiguration (dict) --

          The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

          • text (string) --

            The YAML text for the AI Prompt template.

      • inferenceConfiguration (dict) --

        The configuration for inference parameters when using the AI Prompt.

        • temperature (float) --

          The temperature setting for controlling randomness in the generated response.

        • topP (float) --

          The top-P sampling parameter for nucleus sampling.

        • topK (integer) --

          The top-K sampling parameter for token selection.

        • maxTokensToSample (integer) --

          The maximum number of tokens to generate in the response.

      • modifiedTime (datetime) --

        The time the AI Prompt was last modified.

      • description (string) --

        The description of the AI Prompt.

      • visibilityStatus (string) --

        The visibility status of the AI Prompt.

      • tags (dict) --

        The tags used to organize, track, or control access for this resource.

        • (string) --

          • (string) --

      • origin (string) --

        The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

      • status (string) --

        The status of the AI Prompt.