import_signal_catalog ¶

import_signal_catalog(
    name: resourceName,
    *,
    config_overrides: Optional[IoTFleetWiseClientConfig] = None,
    description: Optional[description] = None,
    vss: Optional[FormattedVss] = None,
    tags: Optional[TagList] = None,
) -> ImportSignalCatalogResponse

Creates a signal catalog using your existing VSS formatted content from your local device.

Parameters:

name (resourceName) –

The name of the signal catalog to import.
description (Optional[description], default: None ) –

A brief description of the signal catalog.
vss (Optional[FormattedVss], default: None ) –

The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.
tags (Optional[TagList], default: None ) –

Metadata that can be used to manage the signal catalog.

Raises:

InternalServerException –

The request couldn't be completed because the server temporarily failed.
AccessDeniedException –

You don't have sufficient permission to perform this action.
ConflictException –

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.
InvalidSignalsException –

The request couldn't be completed because it contains signals that aren't valid.
LimitExceededException –

A service quota was exceeded.
ResourceNotFoundException –

The resource wasn't found.
ThrottlingException –

The request couldn't be completed due to throttling.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotfleetwise/_services/io_t_fleet_wise.py

def import_signal_catalog(
    self,
    name: "capo_iotfleetwise.types.resource_name.resourceName",
    *,
    config_overrides: Optional[IoTFleetWiseClientConfig] = None,
    description: Optional["capo_iotfleetwise.types.description.description"] = None,
    vss: Optional["capo_iotfleetwise.types.formatted_vss.FormattedVss"] = None,
    tags: Optional["capo_iotfleetwise.types.tag_list.TagList"] = None,
) -> "capo_iotfleetwise.types.import_signal_catalog_response.ImportSignalCatalogResponse":
    """<p> Creates a signal catalog using your existing VSS formatted content from your local device. </p>

    Args:
        name: <p>The name of the signal catalog to import.</p>
        description: <p> A brief description of the signal catalog. </p>
        vss: <p>The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.</p>
        tags: <p>Metadata that can be used to manage the signal catalog.</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.import_signal_catalog_request.ImportSignalCatalogRequest]",
    ) -> OperationResponse[
        "capo_iotfleetwise.types.import_signal_catalog_response.ImportSignalCatalogResponse"
    ]:
        import capo_iotfleetwise._operations.io_t_autobahn_control_plane.import_signal_catalog

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ImportSignalCatalog")
    )
    input_: capo_iotfleetwise.types.import_signal_catalog_request.ImportSignalCatalogRequest = {
        "name": name
    }
    if description is not None:
        input_["description"] = description
    if vss is not None:
        input_["vss"] = vss
    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