Skip to content

create_decoder_manifest

create_decoder_manifest(
    name: resourceName,
    model_manifest_arn: arn,
    *,
    config_overrides: Optional[IoTFleetWiseClientConfig] = None,
    description: Optional[description] = None,
    signal_decoders: Optional[SignalDecoders] = None,
    network_interfaces: Optional[NetworkInterfaces] = None,
    default_for_unmapped_signals: Optional[DefaultForUnmappedSignalsType] = None,
    tags: Optional[TagList] = None,
) -> CreateDecoderManifestResponse

Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:

  • Every signal decoder has a unique name.

  • Each signal decoder is associated with a network interface.

  • Each network interface has a unique ID.

  • The signal decoders are specified in the model manifest.

Parameters:

  • name (resourceName) –

    The unique name of the decoder manifest to create.

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

    A brief description of the decoder manifest.

  • model_manifest_arn (arn) –

    The Amazon Resource Name (ARN) of the vehicle model (model manifest).

  • signal_decoders (Optional[SignalDecoders], default: None ) –

    A list of information about signal decoders.

  • network_interfaces (Optional[NetworkInterfaces], default: None ) –

    A list of information about available network interfaces.

  • default_for_unmapped_signals (Optional[DefaultForUnmappedSignalsType], default: None ) –

    Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.

    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.

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

    Metadata that can be used to manage the decoder manifest.

Raises:

Source code in docs_src/capo_iotfleetwise/_services/io_t_fleet_wise.py
def create_decoder_manifest(
    self,
    name: "capo_iotfleetwise.types.resource_name.resourceName",
    model_manifest_arn: "capo_iotfleetwise.types.arn.arn",
    *,
    config_overrides: Optional[IoTFleetWiseClientConfig] = None,
    description: Optional["capo_iotfleetwise.types.description.description"] = None,
    signal_decoders: Optional[
        "capo_iotfleetwise.types.signal_decoders.SignalDecoders"
    ] = None,
    network_interfaces: Optional[
        "capo_iotfleetwise.types.network_interfaces.NetworkInterfaces"
    ] = None,
    default_for_unmapped_signals: Optional[
        "capo_iotfleetwise.types.default_for_unmapped_signals_type.DefaultForUnmappedSignalsType"
    ] = None,
    tags: Optional["capo_iotfleetwise.types.tag_list.TagList"] = None,
) -> "capo_iotfleetwise.types.create_decoder_manifest_response.CreateDecoderManifestResponse":
    """<p>Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:</p> <ul> <li> <p>Every signal decoder has a unique name.</p> </li> <li> <p>Each signal decoder is associated with a network interface.</p> </li> <li> <p>Each network interface has a unique ID.</p> </li> <li> <p>The signal decoders are specified in the model manifest.</p> </li> </ul>

    Args:
        name: <p> The unique name of the decoder manifest to create.</p>
        description: <p>A brief description of the decoder manifest. </p>
        model_manifest_arn: <p> The Amazon Resource Name (ARN) of the vehicle model (model manifest). </p>
        signal_decoders: <p> A list of information about signal decoders. </p>
        network_interfaces: <p> A list of information about available network interfaces. </p>
        default_for_unmapped_signals: <p>Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.</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>
        tags: <p>Metadata that can be used to manage the decoder manifest.</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.decoder_manifest_validation_exception.DecoderManifestValidationException: <p>The request couldn't be completed because it contains signal decoders with one or more validation errors.</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_decoder_manifest_request.CreateDecoderManifestRequest]",
    ) -> OperationResponse[
        "capo_iotfleetwise.types.create_decoder_manifest_response.CreateDecoderManifestResponse"
    ]:
        import capo_iotfleetwise._operations.io_t_autobahn_control_plane.create_decoder_manifest

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDecoderManifest")
    )
    input_: capo_iotfleetwise.types.create_decoder_manifest_request.CreateDecoderManifestRequest = {
        "name": name,
        "model_manifest_arn": model_manifest_arn,
    }
    if description is not None:
        input_["description"] = description
    if signal_decoders is not None:
        input_["signal_decoders"] = signal_decoders
    if network_interfaces is not None:
        input_["network_interfaces"] = network_interfaces
    if default_for_unmapped_signals is not None:
        input_["default_for_unmapped_signals"] = default_for_unmapped_signals
    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