Skip to content

UpdatePromptRequest

Source code in docs_src/capo_bedrock_agent/types/update_prompt_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class UpdatePromptRequest(TypedDict, closed=True):
    name: "capo_bedrock_agent.types.prompt_name.PromptName"
    """<p>A name for the prompt.</p>"""
    description: NotRequired[
        "capo_bedrock_agent.types.prompt_description.PromptDescription"
    ]
    """<p>A description for the prompt.</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 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>"""
    prompt_identifier: "capo_bedrock_agent.types.prompt_identifier.PromptIdentifier"
    """<p>The unique identifier of the prompt.</p>"""

customer_encryption_key_arn instance-attribute 

customer_encryption_key_arn: NotRequired[KmsKeyArn]

The Amazon Resource Name (ARN) of the KMS key to encrypt 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 prompt.

name instance-attribute 

name: PromptName

A name for the prompt.

prompt_identifier instance-attribute 

prompt_identifier: PromptIdentifier

The unique identifier of the prompt.

variants instance-attribute 

variants: NotRequired[PromptVariantList]

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