Lists the advanced prompt optimization jobs in your account.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return in the response.
-
next_token
(Optional[PaginationToken], default:
None
)
–
If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.
-
sort_by
(Optional[SortJobsBy], default:
None
)
–
The field to sort the results by.
-
sort_order
(Optional[SortOrder], default:
None
)
–
The sort order for the results.
Raises:
Source code in docs_src/capo_bedrock/_services/bedrock.py
| def list_advanced_prompt_optimization_jobs(
self,
*,
config_overrides: Optional[BedrockClientConfig] = None,
max_results: Optional["capo_bedrock.types.max_results.MaxResults"] = None,
next_token: Optional[
"capo_bedrock.types.pagination_token.PaginationToken"
] = None,
sort_by: Optional["capo_bedrock.types.sort_jobs_by.SortJobsBy"] = None,
sort_order: Optional["capo_bedrock.types.sort_order.SortOrder"] = None,
) -> "capo_bedrock.types.list_advanced_prompt_optimization_jobs_response.ListAdvancedPromptOptimizationJobsResponse":
"""<p>Lists the advanced prompt optimization jobs in your account.</p>
Args:
max_results: <p>The maximum number of results to return in the response.</p>
next_token: <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token in a subsequent request to get the next set of results.</p>
sort_by: <p>The field to sort the results by.</p>
sort_order: <p>The sort order for the results.</p>
Raises:
capo_bedrock.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
capo_bedrock.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
capo_bedrock.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
capo_bedrock.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
capo_bedrock.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_bedrock.types.list_advanced_prompt_optimization_jobs_request.ListAdvancedPromptOptimizationJobsRequest]",
) -> OperationResponse[
"capo_bedrock.types.list_advanced_prompt_optimization_jobs_response.ListAdvancedPromptOptimizationJobsResponse"
]:
import capo_bedrock._operations.amazon_bedrock_control_plane_service.list_advanced_prompt_optimization_jobs
output, http_response = (
capo_bedrock._operations.amazon_bedrock_control_plane_service.list_advanced_prompt_optimization_jobs.list_advanced_prompt_optimization_jobs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListAdvancedPromptOptimizationJobs")
)
input_: capo_bedrock.types.list_advanced_prompt_optimization_jobs_request.ListAdvancedPromptOptimizationJobsRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if sort_by is not None:
input_["sort_by"] = sort_by
if sort_order is not None:
input_["sort_order"] = sort_order
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|