create_prompt¶
Operation¶
create_prompt
¶
create_prompt(request: CreatePromptInput | CreatePromptInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePromptInputDict]) -> CreatePromptOutput
Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreatePromptInput | CreatePromptInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreatePromptInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreatePromptOutput
|
An instance of |
create_prompt
async
¶
create_prompt(request: CreatePromptInput | CreatePromptInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePromptInputDict]) -> CreatePromptOutput
Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreatePromptInput | CreatePromptInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreatePromptInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreatePromptOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreatePromptInputDict
¶
Bases: TypedDict
Dictionary form of CreatePromptInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
customer_encryption_key_arn
instance-attribute
¶
customer_encryption_key_arn: str | None
The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
default_variant
instance-attribute
¶
default_variant: str | None
The name of the default variant for the prompt. This value must match
the name field in the relevant
PromptVariant
object.
tags
instance-attribute
¶
Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.
variants
instance-attribute
¶
variants: Sequence[PromptVariant | PromptVariantDict] | None
A list of objects, each containing details about a variant of the prompt.
CreatePromptInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreatePromptInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
customer_encryption_key_arn
class-attribute
instance-attribute
¶
customer_encryption_key_arn: str | None = ...
The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
default_variant
class-attribute
instance-attribute
¶
default_variant: str | None = ...
The name of the default variant for the prompt. This value must match
the name field in the relevant
PromptVariant
object.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the prompt.
tags
class-attribute
instance-attribute
¶
Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.
variants
class-attribute
instance-attribute
¶
variants: list[PromptVariant] | None = ...
A list of objects, each containing details about a variant of the prompt.
Output¶
CreatePromptOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreatePromptOutput structure.
Attributes¶
customer_encryption_key_arn
class-attribute
instance-attribute
¶
customer_encryption_key_arn: str | None = ...
The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
default_variant
class-attribute
instance-attribute
¶
default_variant: str | None = ...
The name of the default variant for your prompt.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the prompt.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
variants
class-attribute
instance-attribute
¶
variants: list[PromptVariant] | None = ...
A list of objects, each containing details about a variant of the prompt.