list_prompts¶
Operation¶
async
¶
list_prompts(input: ListPromptsInput, plugins: list[Plugin] | None = None) -> ListPromptsOutput
Returns either information about the working draft (DRAFT version) of
each prompt in an account, or information about of all versions of a
prompt, depending on whether you include the promptIdentifier field or
not. For more information, see View information about prompts using
Prompt
management
in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListPromptsInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
ListPromptsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListPromptsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of results to return in the response. If the total
number of results is greater than this value, use the token returned in
the response in the nextToken field when making another request to
return the next batch of results.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxResults value
provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
class-attribute
instance-attribute
¶
prompt_identifier: str | None = None
The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
Output¶
dataclass
¶
Dataclass for ListPromptsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxResults value
provided in the request, use this token when making another request in
the nextToken field to return the next batch of results.
instance-attribute
¶
prompt_summaries: list[PromptSummary]
A list, each member of which contains information about a prompt using Prompt management.