JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.iotfleetwise

Interface AWSIoTFleetWise

    • Method Detail

      • createCampaign

        CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest)

        Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles.

        For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.

        Parameters:
        createCampaignRequest -
        Returns:
        Result of the CreateCampaign operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource wasn't found.
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        LimitExceededException - A service quota was exceeded.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • createDecoderManifest

        CreateDecoderManifestResult createDecoderManifest(CreateDecoderManifestRequest createDecoderManifestRequest)

        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:
        createDecoderManifestRequest -
        Returns:
        Result of the CreateDecoderManifest operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource wasn't found.
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        LimitExceededException - A service quota was exceeded.
        DecoderManifestValidationException - The request couldn't be completed because it contains signal decoders with one or more validation errors.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • createFleet

        CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)

        Creates a fleet that represents a group of vehicles.

        You must create both a signal catalog and vehicles before you can create a fleet.

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

        Parameters:
        createFleetRequest -
        Returns:
        Result of the CreateFleet operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        ResourceNotFoundException - The resource wasn't found.
        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.
        LimitExceededException - A service quota was exceeded.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • createSignalCatalog

        CreateSignalCatalogResult createSignalCatalog(CreateSignalCatalogRequest createSignalCatalogRequest)

        Creates a collection of standardized signals that can be reused to create vehicle models.

        Parameters:
        createSignalCatalogRequest -
        Returns:
        Result of the CreateSignalCatalog operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        LimitExceededException - A service quota was exceeded.
        InvalidNodeException - The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.
        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.
        InvalidSignalsException - The request couldn't be completed because it contains signals that aren't valid.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • createVehicle

        CreateVehicleResult createVehicle(CreateVehicleRequest createVehicleRequest)

        Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.

        If you have an existing Amazon Web Services IoT thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.

        For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

        Parameters:
        createVehicleRequest -
        Returns:
        Result of the CreateVehicle operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        ResourceNotFoundException - The resource wasn't found.
        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.
        LimitExceededException - A service quota was exceeded.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • deleteDecoderManifest

        DeleteDecoderManifestResult deleteDecoderManifest(DeleteDecoderManifestRequest deleteDecoderManifestRequest)

        Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.

        If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

        Parameters:
        deleteDecoderManifestRequest -
        Returns:
        Result of the DeleteDecoderManifest operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • deleteFleet

        DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)

        Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

        If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

        Parameters:
        deleteFleetRequest -
        Returns:
        Result of the DeleteFleet operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • deleteModelManifest

        DeleteModelManifestResult deleteModelManifest(DeleteModelManifestRequest deleteModelManifestRequest)

        Deletes a vehicle model (model manifest).

        If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

        Parameters:
        deleteModelManifestRequest -
        Returns:
        Result of the DeleteModelManifest operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • deleteSignalCatalog

        DeleteSignalCatalogResult deleteSignalCatalog(DeleteSignalCatalogRequest deleteSignalCatalogRequest)

        Deletes a signal catalog.

        If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

        Parameters:
        deleteSignalCatalogRequest -
        Returns:
        Result of the DeleteSignalCatalog operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • deleteVehicle

        DeleteVehicleResult deleteVehicle(DeleteVehicleRequest deleteVehicleRequest)

        Deletes a vehicle and removes it from any campaigns.

        If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

        Parameters:
        deleteVehicleRequest -
        Returns:
        Result of the DeleteVehicle operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • disassociateVehicleFleet

        DisassociateVehicleFleetResult disassociateVehicleFleet(DisassociateVehicleFleetRequest disassociateVehicleFleetRequest)

        Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.

        If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

        Parameters:
        disassociateVehicleFleetRequest -
        Returns:
        Result of the DisassociateVehicleFleet operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • listCampaigns

        ListCampaignsResult listCampaigns(ListCampaignsRequest listCampaignsRequest)

        Lists information about created campaigns.

        This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

        Parameters:
        listCampaignsRequest -
        Returns:
        Result of the ListCampaigns operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • listDecoderManifests

        ListDecoderManifestsResult listDecoderManifests(ListDecoderManifestsRequest listDecoderManifestsRequest)

        Lists decoder manifests.

        This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

        Parameters:
        listDecoderManifestsRequest -
        Returns:
        Result of the ListDecoderManifests operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • listFleets

        ListFleetsResult listFleets(ListFleetsRequest listFleetsRequest)

        Retrieves information for each created fleet in an Amazon Web Services account.

        This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

        Parameters:
        listFleetsRequest -
        Returns:
        Result of the ListFleets operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • listModelManifests

        ListModelManifestsResult listModelManifests(ListModelManifestsRequest listModelManifestsRequest)

        Retrieves a list of vehicle models (model manifests).

        This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

        Parameters:
        listModelManifestsRequest -
        Returns:
        Result of the ListModelManifests operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • listSignalCatalogs

        ListSignalCatalogsResult listSignalCatalogs(ListSignalCatalogsRequest listSignalCatalogsRequest)

        Lists all the created signal catalogs in an Amazon Web Services account.

        You can use to list information about each signal (node) specified in a signal catalog.

        This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

        Parameters:
        listSignalCatalogsRequest -
        Returns:
        Result of the ListSignalCatalogs operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • listVehicles

        ListVehiclesResult listVehicles(ListVehiclesRequest listVehiclesRequest)

        Retrieves a list of summaries of created vehicles.

        This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

        Parameters:
        listVehiclesRequest -
        Returns:
        Result of the ListVehicles operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • putEncryptionConfiguration

        PutEncryptionConfigurationResult putEncryptionConfiguration(PutEncryptionConfigurationRequest putEncryptionConfigurationRequest)

        Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise Developer Guide.

        Parameters:
        putEncryptionConfigurationRequest -
        Returns:
        Result of the PutEncryptionConfiguration operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource wasn't found.
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • registerAccount

        RegisterAccountResult registerAccount(RegisterAccountRequest registerAccountRequest)

        This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation.

        You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation.

        If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the Identity and Access Management API Reference.

        Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.

        An Amazon Web Services account is not the same thing as a "user." An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.

        Parameters:
        registerAccountRequest -
        Returns:
        Result of the RegisterAccount operation returned by the service.
        Throws:
        ResourceNotFoundException - The resource wasn't found.
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        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.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • updateFleet

        UpdateFleetResult updateFleet(UpdateFleetRequest updateFleetRequest)

        Updates the description of an existing fleet.

        If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.

        Parameters:
        updateFleetRequest -
        Returns:
        Result of the UpdateFleet operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        ResourceNotFoundException - The resource wasn't found.
        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.
        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.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • updateModelManifest

        UpdateModelManifestResult updateModelManifest(UpdateModelManifestRequest updateModelManifestRequest)

        Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.

        Parameters:
        updateModelManifestRequest -
        Returns:
        Result of the UpdateModelManifest operation returned by the service.
        Throws:
        InternalServerException - The request couldn't be completed because the server temporarily failed.
        ResourceNotFoundException - The resource wasn't found.
        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.
        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.
        InvalidSignalsException - The request couldn't be completed because it contains signals that aren't valid.
        AccessDeniedException - You don't have sufficient permission to perform this action.
        See Also:
        AWS API Documentation
      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /