Skip to content

get_state_template

get_state_template(
    identifier: ResourceIdentifier,
    *,
    config_overrides: Optional[IoTFleetWiseClientConfig] = None,
) -> GetStateTemplateResponse

Retrieves information about a state template.

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:

Raises:

Source code in docs_src/capo_iotfleetwise/_services/io_t_fleet_wise.py
def get_state_template(
    self,
    identifier: "capo_iotfleetwise.types.resource_identifier.ResourceIdentifier",
    *,
    config_overrides: Optional[IoTFleetWiseClientConfig] = None,
) -> "capo_iotfleetwise.types.get_state_template_response.GetStateTemplateResponse":
    """<p>Retrieves information about a state template.</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:
        identifier: <p>The unique ID of the state template.</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.resource_not_found_exception.ResourceNotFoundException: <p>The resource wasn't found.</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.get_state_template_request.GetStateTemplateRequest]",
    ) -> OperationResponse[
        "capo_iotfleetwise.types.get_state_template_response.GetStateTemplateResponse"
    ]:
        import capo_iotfleetwise._operations.io_t_autobahn_control_plane.get_state_template

        output, http_response = (
            capo_iotfleetwise._operations.io_t_autobahn_control_plane.get_state_template.get_state_template(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetStateTemplate")
    )
    input_: capo_iotfleetwise.types.get_state_template_request.GetStateTemplateRequest = {
        "identifier": identifier
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output