Skip to content

list_prompts

Operation

list_prompts

list_prompts(request: ListPromptsInput | ListPromptsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPromptsInputDict]) -> 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
request ListPromptsInput | ListPromptsInputDict | 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[ListPromptsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPromptsOutput

An instance of ListPromptsOutput.

list_prompts async

list_prompts(request: ListPromptsInput | ListPromptsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPromptsInputDict]) -> 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
request ListPromptsInput | ListPromptsInputDict | 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[ListPromptsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPromptsOutput

An instance of ListPromptsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListPromptsInputDict

Bases: TypedDict

Dictionary form of ListPromptsInput.

Attributes

max_results instance-attribute
max_results: int | 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.

next_token instance-attribute
next_token: str | 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.

prompt_identifier instance-attribute
prompt_identifier: str | 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.

ListPromptsInput dataclass

Bases: _SerdeShape

Dataclass for ListPromptsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | 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.

next_token class-attribute instance-attribute
next_token: str | 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.

prompt_identifier class-attribute instance-attribute
prompt_identifier: str | 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

ListPromptsOutput dataclass

Bases: _SerdeShape

Dataclass for ListPromptsOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | 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.

prompt_summaries instance-attribute
prompt_summaries: list[PromptSummary]

A list, each member of which contains information about a prompt using Prompt management.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.