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:
-
prompt_identifier
(Optional[PromptIdentifier], default:
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.
-
max_results
(Optional[MaxResults], default:
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
(Optional[NextToken], default:
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.
Raises:
Source code in docs_src/capo_bedrock_agent/_services/async_bedrock_agent.py
| async def list_prompts(
self,
*,
config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
prompt_identifier: Optional[
"capo_bedrock_agent.types.prompt_identifier.PromptIdentifier"
] = None,
max_results: Optional["capo_bedrock_agent.types.max_results.MaxResults"] = None,
next_token: Optional["capo_bedrock_agent.types.next_token.NextToken"] = None,
) -> "capo_bedrock_agent.types.list_prompts_response.ListPromptsResponse":
"""<p>Returns either information about the working draft (<code>DRAFT</code> version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the <code>promptIdentifier</code> field or not. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html">View information about prompts using Prompt management</a> in the Amazon Bedrock User Guide.</p>
Args:
prompt_identifier: <p>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.</p>
max_results: <p>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 <code>nextToken</code> field when making another request to return the next batch of results.</p>
next_token: <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
Raises:
capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
capo_bedrock_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_bedrock_agent.types.list_prompts_request.ListPromptsRequest]",
) -> AsyncOperationResponse[
"capo_bedrock_agent.types.list_prompts_response.ListPromptsResponse"
]:
import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.list_prompts
(
output,
http_response,
) = await capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.list_prompts.async_list_prompts(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListPrompts")
)
input_: capo_bedrock_agent.types.list_prompts_request.ListPromptsRequest = {}
if prompt_identifier is not None:
input_["prompt_identifier"] = prompt_identifier
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|