Skip to content

create_model_manifest

create_model_manifest(
    name: resourceName,
    nodes: listOfStrings,
    signal_catalog_arn: arn,
    *,
    config_overrides: Optional[IoTFleetWiseClientConfig] = None,
    description: Optional[description] = None,
    tags: Optional[TagList] = None,
) -> CreateModelManifestResponse

Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).

For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide.

Parameters:

  • name (resourceName) –

    The name of the vehicle model to create.

  • description (Optional[description], default: None ) –

    A brief description of the vehicle model.

  • nodes (listOfStrings) –

    A list of nodes, which are a general abstraction of signals.

  • signal_catalog_arn (arn) –

    The Amazon Resource Name (ARN) of a signal catalog.

  • tags (Optional[TagList], default: None ) –

    Metadata that can be used to manage the vehicle model.

Raises:

Source code in docs_src/capo_iotfleetwise/_services/io_t_fleet_wise.py
def create_model_manifest(
    self,
    name: "capo_iotfleetwise.types.resource_name.resourceName",
    nodes: "capo_iotfleetwise.types.list_of_strings.listOfStrings",
    signal_catalog_arn: "capo_iotfleetwise.types.arn.arn",
    *,
    config_overrides: Optional[IoTFleetWiseClientConfig] = None,
    description: Optional["capo_iotfleetwise.types.description.description"] = None,
    tags: Optional["capo_iotfleetwise.types.tag_list.TagList"] = None,
) -> "capo_iotfleetwise.types.create_model_manifest_response.CreateModelManifestResponse":
    """<p> Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators). </p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicle-models.html">Vehicle models</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>

    Args:
        name: <p> The name of the vehicle model to create.</p>
        description: <p> A brief description of the vehicle model. </p>
        nodes: <p> A list of nodes, which are a general abstraction of signals. </p>
        signal_catalog_arn: <p> The Amazon Resource Name (ARN) of a signal catalog. </p>
        tags: <p>Metadata that can be used to manage the vehicle model.</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.conflict_exception.ConflictException: <p>The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotfleetwise.errors.invalid_signals_exception.InvalidSignalsException: <p>The request couldn't be completed because it contains signals that aren't valid.</p>
        capo_iotfleetwise.errors.limit_exceeded_exception.LimitExceededException: <p>A service quota was exceeded. </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.create_model_manifest_request.CreateModelManifestRequest]",
    ) -> OperationResponse[
        "capo_iotfleetwise.types.create_model_manifest_response.CreateModelManifestResponse"
    ]:
        import capo_iotfleetwise._operations.io_t_autobahn_control_plane.create_model_manifest

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateModelManifest")
    )
    input_: capo_iotfleetwise.types.create_model_manifest_request.CreateModelManifestRequest = {
        "name": name,
        "nodes": nodes,
        "signal_catalog_arn": signal_catalog_arn,
    }
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags

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