Lists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations.
Parameters:
-
filters
(Optional[Filters], default:
None
)
–
Optional filters to apply when listing export image tasks. Filters help you narrow down the results based on specific criteria.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of export image tasks to return in a single request. The valid range is 1-500, with a default of 50.
-
next_token
(Optional[String], default:
None
)
–
The pagination token from a previous request. Use this to retrieve the next page of results when there are more tasks than the MaxResults limit.
Raises:
Source code in docs_src/capo_appstream/_services/app_stream.py
| def list_export_image_tasks(
self,
*,
config_overrides: Optional[AppStreamClientConfig] = None,
filters: Optional["capo_appstream.types.filters.Filters"] = None,
max_results: Optional["capo_appstream.types.max_results.MaxResults"] = None,
next_token: Optional["capo_appstream.types.string.String"] = None,
) -> (
"capo_appstream.types.list_export_image_tasks_result.ListExportImageTasksResult"
):
"""<p>Lists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations.</p>
Args:
filters: <p>Optional filters to apply when listing export image tasks. Filters help you narrow down the results based on specific criteria.</p>
max_results: <p>The maximum number of export image tasks to return in a single request. The valid range is 1-500, with a default of 50.</p>
next_token: <p>The pagination token from a previous request. Use this to retrieve the next page of results when there are more tasks than the MaxResults limit.</p>
Raises:
capo_appstream.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>The attempted operation is not permitted.</p>
capo_appstream.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_appstream.types.list_export_image_tasks_request.ListExportImageTasksRequest]",
) -> OperationResponse[
"capo_appstream.types.list_export_image_tasks_result.ListExportImageTasksResult"
]:
import capo_appstream._operations.photon_admin_proxy_service.list_export_image_tasks
output, http_response = (
capo_appstream._operations.photon_admin_proxy_service.list_export_image_tasks.list_export_image_tasks(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListExportImageTasks")
)
input_: capo_appstream.types.list_export_image_tasks_request.ListExportImageTasksRequest = {}
if filters is not None:
input_["filters"] = filters
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|