Skip to content
AWS for Query.Farm

aws.bedrock_agent.get_prompt

Example SQL Queries

SELECT * FROM
aws.bedrock_agent.get_prompt
WHERE
"prompt_identifier" = 'VALUE';

Description

Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.

Table Definition

Column NameColumn Data Type
prompt_identifier Required Input Column

The unique identifier of the prompt.

VARCHAR
prompt_version Input Column

The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

arn

The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

VARCHAR
created_at

The time at which the prompt was created.

TIMESTAMP_S
customer_encryption_key_arn

The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.

VARCHAR
default_variant

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

VARCHAR
description

The descriptino of the prompt.

VARCHAR
id

The unique identifier of the prompt.

VARCHAR
name

The name of the prompt.

VARCHAR
updated_at

The time at which the prompt was last updated.

TIMESTAMP_S
variants

A list of objects, each containing details about a variant of the prompt.

STRUCT(
    "inference_configuration" STRUCT(
        "text" STRUCT(
            "max_tokens" BIGINT,
            "stop_sequences" VARCHAR[],
            "temperature" DOUBLE,
            "top_k" BIGINT,
            "top_p" DOUBLE
        )
    ),
    "model_id" VARCHAR,
    "name" VARCHAR,
    "template_configuration" STRUCT(
        "text" STRUCT(
            "input_variables" STRUCT(
                "name" VARCHAR
            )[],
            "text" VARCHAR
        )
    ),
    "template_type" VARCHAR
)[]
Show child fields
variants[]
Show child fields
variants[].inference_configuration

Contains inference configurations for the prompt variant.

Show child fields
variants[].inference_configuration.text

Contains inference configurations for a text prompt.

Show child fields
variants[].inference_configuration.text.max_tokens

The maximum number of tokens to return in the response.

variants[].inference_configuration.text.stop_sequences[]
variants[].inference_configuration.text.temperature

Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

variants[].inference_configuration.text.top_k

The number of most-likely candidates that the model considers for the next token during generation.

variants[].inference_configuration.text.top_p

The percentage of most-likely candidates that the model considers for the next token.

variants[].model_id

The unique identifier of the model with which to run inference on the prompt.

variants[].name

The name of the prompt variant.

variants[].template_configuration

Contains configurations for the prompt template.

Show child fields
variants[].template_configuration.text

Contains configurations for the text in a message for a prompt.

Show child fields
variants[].template_configuration.text.input_variables[]
Show child fields
variants[].template_configuration.text.input_variables[].name

The name of the variable.

variants[].template_configuration.text.text

The message for the prompt.

variants[].template_type

The type of prompt template to use.

version

The version of the prompt.

VARCHAR