Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects.
To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
-
max_results
(Optional[MaxResults], default:
None
)
–
The number of items to return in the response.
-
filters
(Optional[Filters], default:
None
)
–
An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude resources that match the statement from the list. The match statement consists of a key and a value.
Filter properties
-
Condition - The condition to apply. Valid values are IS and IS_NOT.
-
Key - The name of the parameter to filter on. Valid values are ResourceArn and Status.
-
Value - The value to match.
Raises:
Source code in docs_src/capo_forecast/_services/async_forecast.py
| async def list_explainability_exports(
self,
*,
config_overrides: Optional[AsyncforecastClientConfig] = None,
next_token: Optional["capo_forecast.types.next_token.NextToken"] = None,
max_results: Optional["capo_forecast.types.max_results.MaxResults"] = None,
filters: Optional["capo_forecast.types.filters.Filters"] = None,
) -> "capo_forecast.types.list_explainability_exports_response.ListExplainabilityExportsResponse":
"""<p>Returns a list of Explainability exports created using the <a>CreateExplainabilityExport</a> operation. This operation returns a summary for each Explainability export. You can filter the list using an array of <a>Filter</a> objects.</p> <p>To retrieve the complete set of properties for a particular Explainability export, use the ARN with the <a>DescribeExplainability</a> operation.</p>
Args:
next_token: <p>If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>
max_results: <p>The number of items to return in the response.</p>
filters: <p>An array of filters. For each filter, provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude resources that match the statement from the list. The match statement consists of a key and a value.</p> <p> <b>Filter properties</b> </p> <ul> <li> <p> <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and <code>IS_NOT</code>.</p> </li> <li> <p> <code>Key</code> - The name of the parameter to filter on. Valid values are <code>ResourceArn</code> and <code>Status</code>.</p> </li> <li> <p> <code>Value</code> - The value to match.</p> </li> </ul>
Raises:
capo_forecast.errors.invalid_input_exception.InvalidInputException: <p>We can't process the request because it includes an invalid value or a value that exceeds the valid range.</p>
capo_forecast.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The token is not valid. Tokens expire after 24 hours.</p>
capo_forecast.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_forecast.types.list_explainability_exports_request.ListExplainabilityExportsRequest]",
) -> AsyncOperationResponse[
"capo_forecast.types.list_explainability_exports_response.ListExplainabilityExportsResponse"
]:
import capo_forecast._operations.amazon_forecast.list_explainability_exports
(
output,
http_response,
) = await capo_forecast._operations.amazon_forecast.list_explainability_exports.async_list_explainability_exports(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListExplainabilityExports")
)
input_: capo_forecast.types.list_explainability_exports_request.ListExplainabilityExportsRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if filters is not None:
input_["filters"] = filters
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|