Lists information about created state templates.
Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
Parameters:
-
next_token
(Optional[nextToken], default:
None
)
–
The token to retrieve the next set of results, or null if there are no more results.
-
max_results
(Optional[maxResults], default:
None
)
–
The maximum number of items to return, between 1 and 100, inclusive.
-
list_response_scope
(Optional[ListResponseScope], default:
None
)
–
When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time.
Raises:
Source code in docs_src/capo_iotfleetwise/_services/io_t_fleet_wise.py
| def list_state_templates(
self,
*,
config_overrides: Optional[IoTFleetWiseClientConfig] = None,
next_token: Optional["capo_iotfleetwise.types.next_token.nextToken"] = None,
max_results: Optional["capo_iotfleetwise.types.max_results.maxResults"] = None,
list_response_scope: Optional[
"capo_iotfleetwise.types.list_response_scope.ListResponseScope"
] = None,
) -> "capo_iotfleetwise.types.list_state_templates_response.ListStateTemplatesResponse":
"""<p>Lists information about created state templates.</p> <important> <p>Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">Amazon Web Services Region and feature availability</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p> </important>
Args:
next_token: <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
max_results: <p>The maximum number of items to return, between 1 and 100, inclusive.</p>
list_response_scope: <p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time.</p>
Raises:
capo_iotfleetwise.errors.internal_server_exception.InternalServerException: <p>The request couldn't be completed because the server temporarily failed.</p>
capo_iotfleetwise.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permission to perform this action.</p>
capo_iotfleetwise.errors.throttling_exception.ThrottlingException: <p>The request couldn't be completed due to throttling.</p>
capo_iotfleetwise.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_iotfleetwise.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iotfleetwise.types.list_state_templates_request.ListStateTemplatesRequest]",
) -> OperationResponse[
"capo_iotfleetwise.types.list_state_templates_response.ListStateTemplatesResponse"
]:
import capo_iotfleetwise._operations.io_t_autobahn_control_plane.list_state_templates
output, http_response = (
capo_iotfleetwise._operations.io_t_autobahn_control_plane.list_state_templates.list_state_templates(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListStateTemplates")
)
input_: capo_iotfleetwise.types.list_state_templates_request.ListStateTemplatesRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if list_response_scope is not None:
input_["list_response_scope"] = list_response_scope
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|