Skip to content

CreatePromptVersionResponse

Source code in docs_src/capo_bedrock_agent/types/create_prompt_version_response.py
class CreatePromptVersionResponse(TypedDict, closed=True):
    name: "capo_bedrock_agent.types.prompt_name.PromptName"
    """<p>The name of the prompt.</p>"""
    description: NotRequired[
        "capo_bedrock_agent.types.prompt_description.PromptDescription"
    ]
    """<p>A description for the version.</p>"""
    customer_encryption_key_arn: NotRequired[
        "capo_bedrock_agent.types.kms_key_arn.KmsKeyArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.</p>"""
    default_variant: NotRequired[
        "capo_bedrock_agent.types.prompt_variant_name.PromptVariantName"
    ]
    """<p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>"""
    variants: NotRequired[
        "capo_bedrock_agent.types.prompt_variant_list.PromptVariantList"
    ]
    """<p>A list of objects, each containing details about a variant of the prompt.</p>"""
    id: "capo_bedrock_agent.types.prompt_id.PromptId"
    """<p>The unique identifier of the prompt.</p>"""
    arn: "capo_bedrock_agent.types.prompt_arn.PromptArn"
    """<p>The Amazon Resource Name (ARN) of the version of the prompt.</p>"""
    version: "capo_bedrock_agent.types.version.Version"
    """<p>The version of the prompt that was created. Versions are numbered incrementally, starting from 1.</p>"""
    created_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time at which the prompt was created.</p>"""
    updated_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time at which the prompt was last updated.</p>"""

arn instance-attribute

arn: PromptArn

The Amazon Resource Name (ARN) of the version of the prompt.

created_at instance-attribute

created_at: DateTimestamp

The time at which the prompt was created.

customer_encryption_key_arn instance-attribute

customer_encryption_key_arn: NotRequired[KmsKeyArn]

The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.

default_variant instance-attribute

default_variant: NotRequired[PromptVariantName]

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

description instance-attribute

description: NotRequired[PromptDescription]

A description for the version.

id instance-attribute

The unique identifier of the prompt.

name instance-attribute

name: PromptName

The name of the prompt.

updated_at instance-attribute

updated_at: DateTimestamp

The time at which the prompt was last updated.

variants instance-attribute

variants: NotRequired[PromptVariantList]

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

version instance-attribute

version: Version

The version of the prompt that was created. Versions are numbered incrementally, starting from 1.