Skip to content

update_decoder_manifest async

update_decoder_manifest(
    name: resourceName,
    *,
    config_overrides: Optional[AsyncIoTFleetWiseClientConfig] = None,
    description: Optional[description] = None,
    signal_decoders_to_add: Optional[SignalDecoders] = None,
    signal_decoders_to_update: Optional[SignalDecoders] = None,
    signal_decoders_to_remove: Optional[Fqns] = None,
    network_interfaces_to_add: Optional[NetworkInterfaces] = None,
    network_interfaces_to_update: Optional[NetworkInterfaces] = None,
    network_interfaces_to_remove: Optional[InterfaceIds] = None,
    status: Optional[ManifestStatus] = None,
    default_for_unmapped_signals: Optional[DefaultForUnmappedSignalsType] = None,
) -> UpdateDecoderManifestResponse

Updates a decoder manifest.

A decoder manifest can only be updated when the status is DRAFT. Only ACTIVE decoder manifests can be associated with vehicles.

Parameters:

  • name (resourceName) –

    The name of the decoder manifest to update.

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

    A brief description of the decoder manifest to update.

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

    A list of information about decoding additional signals to add to the decoder manifest.

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

    A list of updated information about decoding signals to update in the decoder manifest.

  • signal_decoders_to_remove (Optional[Fqns], default: None ) –

    A list of signal decoders to remove from the decoder manifest.

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

    A list of information about the network interfaces to add to the decoder manifest.

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

    A list of information about the network interfaces to update in the decoder manifest.

  • network_interfaces_to_remove (Optional[InterfaceIds], default: None ) –

    A list of network interfaces to remove from the decoder manifest.

  • status (Optional[ManifestStatus], default: None ) –

    The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.

  • 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.

Raises:

Source code in docs_src/capo_iotfleetwise/_services/async_io_t_fleet_wise.py
async def update_decoder_manifest(
    self,
    name: "capo_iotfleetwise.types.resource_name.resourceName",
    *,
    config_overrides: Optional[AsyncIoTFleetWiseClientConfig] = None,
    description: Optional["capo_iotfleetwise.types.description.description"] = None,
    signal_decoders_to_add: Optional[
        "capo_iotfleetwise.types.signal_decoders.SignalDecoders"
    ] = None,
    signal_decoders_to_update: Optional[
        "capo_iotfleetwise.types.signal_decoders.SignalDecoders"
    ] = None,
    signal_decoders_to_remove: Optional["capo_iotfleetwise.types.fqns.Fqns"] = None,
    network_interfaces_to_add: Optional[
        "capo_iotfleetwise.types.network_interfaces.NetworkInterfaces"
    ] = None,
    network_interfaces_to_update: Optional[
        "capo_iotfleetwise.types.network_interfaces.NetworkInterfaces"
    ] = None,
    network_interfaces_to_remove: Optional[
        "capo_iotfleetwise.types.interface_ids.InterfaceIds"
    ] = None,
    status: Optional[
        "capo_iotfleetwise.types.manifest_status.ManifestStatus"
    ] = None,
    default_for_unmapped_signals: Optional[
        "capo_iotfleetwise.types.default_for_unmapped_signals_type.DefaultForUnmappedSignalsType"
    ] = None,
) -> "capo_iotfleetwise.types.update_decoder_manifest_response.UpdateDecoderManifestResponse":
    """<p> Updates a decoder manifest.</p> <p>A decoder manifest can only be updated when the status is <code>DRAFT</code>. Only <code>ACTIVE</code> decoder manifests can be associated with vehicles.</p>

    Args:
        name: <p> The name of the decoder manifest to update.</p>
        description: <p> A brief description of the decoder manifest to update. </p>
        signal_decoders_to_add: <p> A list of information about decoding additional signals to add to the decoder manifest. </p>
        signal_decoders_to_update: <p> A list of updated information about decoding signals to update in the decoder manifest. </p>
        signal_decoders_to_remove: <p> A list of signal decoders to remove from the decoder manifest. </p>
        network_interfaces_to_add: <p> A list of information about the network interfaces to add to the decoder manifest. </p>
        network_interfaces_to_update: <p> A list of information about the network interfaces to update in the decoder manifest. </p>
        network_interfaces_to_remove: <p> A list of network interfaces to remove from the decoder manifest.</p>
        status: <p> The state of the decoder manifest. If the status is <code>ACTIVE</code>, the decoder manifest can't be edited. If the status is <code>DRAFT</code>, you can edit the decoder manifest. </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>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotfleetwise.types.update_decoder_manifest_request.UpdateDecoderManifestRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotfleetwise.types.update_decoder_manifest_response.UpdateDecoderManifestResponse"
    ]:
        import capo_iotfleetwise._operations.io_t_autobahn_control_plane.update_decoder_manifest

        (
            output,
            http_response,
        ) = await capo_iotfleetwise._operations.io_t_autobahn_control_plane.update_decoder_manifest.async_update_decoder_manifest(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDecoderManifest")
    )
    input_: capo_iotfleetwise.types.update_decoder_manifest_request.UpdateDecoderManifestRequest = {
        "name": name
    }
    if description is not None:
        input_["description"] = description
    if signal_decoders_to_add is not None:
        input_["signal_decoders_to_add"] = signal_decoders_to_add
    if signal_decoders_to_update is not None:
        input_["signal_decoders_to_update"] = signal_decoders_to_update
    if signal_decoders_to_remove is not None:
        input_["signal_decoders_to_remove"] = signal_decoders_to_remove
    if network_interfaces_to_add is not None:
        input_["network_interfaces_to_add"] = network_interfaces_to_add
    if network_interfaces_to_update is not None:
        input_["network_interfaces_to_update"] = network_interfaces_to_update
    if network_interfaces_to_remove is not None:
        input_["network_interfaces_to_remove"] = network_interfaces_to_remove
    if status is not None:
        input_["status"] = status
    if default_for_unmapped_signals is not None:
        input_["default_for_unmapped_signals"] = default_for_unmapped_signals

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output