AWS.Tools.IoTFleetWise.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IoTFleetWise</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IFW.AddIFWResourceTagCmdlet"> <summary> Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.AddIFWResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.AddIFWResourceTagCmdlet.Tag"> <summary> <para> <para>The new or modified tags for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.AddIFWResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.AddIFWResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWCampaignCmdlet"> <summary> Retrieves information about a campaign. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWCampaignCmdlet.Name"> <summary> <para> <para> The name of the campaign to retrieve information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetCampaignResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWCampaignListCmdlet"> <summary> Lists information about created campaigns. <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWCampaignListCmdlet.Status"> <summary> <para> <para>Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: <c>CREATING</c>, <c>WAITING_FOR_APPROVAL</c>, <c>RUNNING</c>, or <c>SUSPENDED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWCampaignListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWCampaignListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWCampaignListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CampaignSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListCampaignsResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListCampaignsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestCmdlet"> <summary> Retrieves information about a created decoder manifest. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestCmdlet.Name"> <summary> <para> <para> The name of the decoder manifest to retrieve information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetDecoderManifestResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetDecoderManifestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestListCmdlet"> <summary> Lists decoder manifests. <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestListCmdlet.ModelManifestArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListDecoderManifestsResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListDecoderManifestsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestNetworkInterfaceListCmdlet"> <summary> Lists the network interfaces specified in a decoder manifest. <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestNetworkInterfaceListCmdlet.Name"> <summary> <para> <para> The name of the decoder manifest to list information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestNetworkInterfaceListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestNetworkInterfaceListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestNetworkInterfaceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NetworkInterfaces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListDecoderManifestNetworkInterfacesResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListDecoderManifestNetworkInterfacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestSignalListCmdlet"> <summary> A list of information about signal decoders specified in a decoder manifest. <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestSignalListCmdlet.Name"> <summary> <para> <para> The name of the decoder manifest to list information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestSignalListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestSignalListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWDecoderManifestSignalListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SignalDecoders'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListDecoderManifestSignalsResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListDecoderManifestSignalsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWEncryptionConfigurationCmdlet"> <summary> Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWEncryptionConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetEncryptionConfigurationResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetEncryptionConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetCmdlet"> <summary> Retrieves information about a fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetCmdlet.FleetId"> <summary> <para> <para> The ID of the fleet to retrieve information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetFleetResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetFleetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetListCmdlet"> <summary> Retrieves information for each created fleet in an Amazon Web Services account. <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListFleetsResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListFleetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetsForVehicleListCmdlet"> <summary> Retrieves a list of IDs for all fleets that the vehicle is associated with. <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetsForVehicleListCmdlet.VehicleName"> <summary> <para> <para> The ID of the vehicle to retrieve information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetsForVehicleListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetsForVehicleListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWFleetsForVehicleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Fleets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListFleetsForVehicleResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListFleetsForVehicleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWLoggingOptionCmdlet"> <summary> Retrieves the logging options. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWLoggingOptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CloudWatchLogDelivery'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetLoggingOptionsResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetLoggingOptionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestCmdlet"> <summary> Retrieves information about a vehicle model (model manifest). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestCmdlet.Name"> <summary> <para> <para> The name of the vehicle model to retrieve information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetModelManifestResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetModelManifestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestListCmdlet"> <summary> Retrieves a list of vehicle models (model manifests). <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestListCmdlet.SignalCatalogArn"> <summary> <para> <para> The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListModelManifestsResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListModelManifestsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestNodeListCmdlet"> <summary> Lists information about nodes specified in a vehicle model (model manifest). <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestNodeListCmdlet.Name"> <summary> <para> <para> The name of the vehicle model to list information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestNodeListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestNodeListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWModelManifestNodeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Nodes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListModelManifestNodesResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListModelManifestNodesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWRegisterAccountStatusCmdlet"> <summary> Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. <para> For more information, including step-by-step procedures, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html">Setting up Amazon Web Services IoT FleetWise</a>. </para><note><para> This API operation doesn't require input parameters. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWRegisterAccountStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetRegisterAccountStatusResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetRegisterAccountStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWResourceTagCmdlet"> <summary> Lists the tags (metadata) you have assigned to the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogCmdlet"> <summary> Retrieves information about a signal catalog. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogCmdlet.Name"> <summary> <para> <para> The name of the signal catalog to retrieve information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetSignalCatalogResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetSignalCatalogResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogListCmdlet"> <summary> Lists all the created signal catalogs in an Amazon Web Services account. <para> You can use to list information about each signal (node) specified in a signal catalog. </para><note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListSignalCatalogsResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListSignalCatalogsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogNodeListCmdlet"> <summary> Lists of information about the signals (nodes) specified in a signal catalog. <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogNodeListCmdlet.Name"> <summary> <para> <para> The name of the signal catalog to list information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogNodeListCmdlet.SignalNodeType"> <summary> <para> <para>The type of node in the signal catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogNodeListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogNodeListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWSignalCatalogNodeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Nodes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListSignalCatalogNodesResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListSignalCatalogNodesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleCmdlet"> <summary> Retrieves information about a vehicle. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleCmdlet.VehicleName"> <summary> <para> <para> The ID of the vehicle to retrieve information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetVehicleResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetVehicleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleListCmdlet"> <summary> Retrieves a list of summaries of created vehicles. <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleListCmdlet.AttributeName"> <summary> <para> <para>The fully qualified names of the attributes. For example, the fully qualified name of an attribute might be <c>Vehicle.Body.Engine.Type</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleListCmdlet.AttributeValue"> <summary> <para> <para>Static information about a vehicle attribute value in string format. For example:</para><para><c>"1.3 L R2"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleListCmdlet.ModelManifestArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VehicleSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListVehiclesResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListVehiclesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehiclesInFleetListCmdlet"> <summary> Retrieves a list of summaries of all vehicles associated with a fleet. <note><para> This API operation uses pagination. Specify the <c>nextToken</c> parameter in the request to return more results. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehiclesInFleetListCmdlet.FleetId"> <summary> <para> <para> The ID of a fleet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehiclesInFleetListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehiclesInFleetListCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehiclesInFleetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Vehicles'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ListVehiclesInFleetResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ListVehiclesInFleetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleStatusCmdlet"> <summary> Retrieves information about the status of a vehicle with any associated campaigns. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleStatusCmdlet.VehicleName"> <summary> <para> <para> The ID of the vehicle to retrieve information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleStatusCmdlet.MaxResult"> <summary> <para> <para> The maximum number of items to return, between 1 and 100, inclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleStatusCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para><para>If the results of a search are large, only a portion of the results are returned, and a <c>nextToken</c> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.GetIFWVehicleStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Campaigns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.GetVehicleStatusResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.GetVehicleStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.ImportIFWDecoderManifestCmdlet"> <summary> Creates a decoder manifest using your existing CAN DBC file from your local device. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWDecoderManifestCmdlet.Name"> <summary> <para> <para> The name of the decoder manifest to import. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWDecoderManifestCmdlet.NetworkFileDefinition"> <summary> <para> <para> The file to load into an Amazon Web Services account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWDecoderManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ImportDecoderManifestResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ImportDecoderManifestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWDecoderManifestCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.ImportIFWSignalCatalogCmdlet"> <summary> Creates a signal catalog using your existing VSS formatted content from your local device. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWSignalCatalogCmdlet.Description"> <summary> <para> <para> A brief description of the signal catalog. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWSignalCatalogCmdlet.Name"> <summary> <para> <para>The name of the signal catalog to import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWSignalCatalogCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the signal catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWSignalCatalogCmdlet.Vss_VssJson"> <summary> <para> <para>Provides the VSS in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWSignalCatalogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.ImportSignalCatalogResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.ImportSignalCatalogResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.ImportIFWSignalCatalogCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet"> <summary> 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. <para> For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html">Collect and transfer data with campaigns</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.Compression"> <summary> <para> <para> (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use <c>OFF</c>. If it's not specified, <c>SNAPPY</c> is used. </para><para>Default: <c>SNAPPY</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.ConditionBasedCollectionScheme_ConditionLanguageVersion"> <summary> <para> <para>Specifies the version of the conditional expression language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.DataDestinationConfig"> <summary> <para> <para>The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.</para><para>Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.</para><para>You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.DataExtraDimension"> <summary> <para> <para> (Optional) A list of vehicle attributes to associate with a campaign. </para><para>Enrich the data with specified vehicle attributes. For example, add <c>make</c> and <c>model</c> to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against <c>make</c> and <c>model</c>.</para><para>Default: An empty array</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.Description"> <summary> <para> <para>An optional description of the campaign to help identify its purpose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.DiagnosticsMode"> <summary> <para> <para> (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use <c>SEND_ACTIVE_DTCS</c>. If it's not specified, <c>OFF</c> is used.</para><para>Default: <c>OFF</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.ExpiryTime"> <summary> <para> <para> (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires. </para><para>Default: 253402214400 (December 31, 9999, 00:00:00 UTC)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.ConditionBasedCollectionScheme_Expression"> <summary> <para> <para>The logical expression used to recognize what data to collect. For example, <c>$variable.`Vehicle.OutsideAirTemperature` >= 105.0</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.ConditionBasedCollectionScheme_MinimumTriggerIntervalMs"> <summary> <para> <para>The minimum duration of time between two triggering events to collect data, in milliseconds.</para><note><para>If a signal changes often, you might want to collect data at a slower rate.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.Name"> <summary> <para> <para> The name of the campaign to create. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.TimeBasedCollectionScheme_PeriodMs"> <summary> <para> <para>The time period (in milliseconds) to decide how often to collect data. For example, if the time period is <c>60000</c>, the Edge Agent software collects data once every minute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.PostTriggerCollectionDuration"> <summary> <para> <para> (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, <c>0</c> is used.</para><para>Default: <c>0</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.Priority"> <summary> <para> <para>(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, <c>0</c> is used. </para><para>Default: <c>0</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.SignalCatalogArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.SignalsToCollect"> <summary> <para> <para>(Optional) A list of information about signals to collect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.SpoolingMode"> <summary> <para> <para>(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use <c>TO_DISK</c>. If it's not specified, <c>OFF</c> is used.</para><para>Default: <c>OFF</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.StartTime"> <summary> <para> <para>(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, <c>0</c> is used.</para><para>Default: <c>0</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.TargetArn"> <summary> <para> <para> The ARN of the vehicle or fleet to deploy a campaign to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.ConditionBasedCollectionScheme_TriggerMode"> <summary> <para> <para>Whether to collect data for all triggering events (<c>ALWAYS</c>). Specify (<c>RISING_EDGE</c>), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.CreateCampaignResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.CreateCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.NewIFWCreateVehicleCmdlet"> <summary> Creates a group, or batch, of vehicles. <note><para> You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. </para></note><para> For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicles-cli.html">Create multiple vehicles (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCreateVehicleCmdlet.Vehicle"> <summary> <para> <para> A list of information about each vehicle to create. For more information, see the API data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCreateVehicleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.BatchCreateVehicleResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.BatchCreateVehicleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWCreateVehicleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.NewIFWDecoderManifestCmdlet"> <summary> Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true: <ul><li><para> Every signal decoder has a unique name. </para></li><li><para> Each signal decoder is associated with a network interface. </para></li><li><para> Each network interface has a unique ID. </para></li><li><para> The signal decoders are specified in the model manifest. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWDecoderManifestCmdlet.Description"> <summary> <para> <para> A brief description of the decoder manifest. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWDecoderManifestCmdlet.ModelManifestArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the vehicle model (model manifest). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWDecoderManifestCmdlet.Name"> <summary> <para> <para> The unique name of the decoder manifest to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWDecoderManifestCmdlet.NetworkInterface"> <summary> <para> <para> A list of information about available network interfaces. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWDecoderManifestCmdlet.SignalDecoder"> <summary> <para> <para> A list of information about signal decoders. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWDecoderManifestCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the decoder manifest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWDecoderManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.CreateDecoderManifestResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.CreateDecoderManifestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWDecoderManifestCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.NewIFWFleetCmdlet"> <summary> Creates a fleet that represents a group of vehicles. <note><para> You must create both a signal catalog and vehicles before you can create a fleet. </para></note><para> For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleets.html">Fleets</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWFleetCmdlet.Description"> <summary> <para> <para> A brief description of the fleet to create. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWFleetCmdlet.FleetId"> <summary> <para> <para> The unique ID of the fleet to create. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWFleetCmdlet.SignalCatalogArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of a signal catalog. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWFleetCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.CreateFleetResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.CreateFleetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWFleetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.NewIFWModelManifestCmdlet"> <summary> Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators). <para> 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>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWModelManifestCmdlet.Description"> <summary> <para> <para> A brief description of the vehicle model. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWModelManifestCmdlet.Name"> <summary> <para> <para> The name of the vehicle model to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWModelManifestCmdlet.Node"> <summary> <para> <para> A list of nodes, which are a general abstraction of signals. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWModelManifestCmdlet.SignalCatalogArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of a signal catalog. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWModelManifestCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the vehicle model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWModelManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.CreateModelManifestResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.CreateModelManifestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWModelManifestCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.NewIFWSignalCatalogCmdlet"> <summary> Creates a collection of standardized signals that can be reused to create vehicle models. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWSignalCatalogCmdlet.Description"> <summary> <para> <para>A brief description of the signal catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWSignalCatalogCmdlet.Name"> <summary> <para> <para> The name of the signal catalog to create. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWSignalCatalogCmdlet.Node"> <summary> <para> <para> A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWSignalCatalogCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the signal catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWSignalCatalogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.CreateSignalCatalogResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.CreateSignalCatalogResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWSignalCatalogCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.NewIFWUpdateVehicleCmdlet"> <summary> Updates a group, or batch, of vehicles. <note><para> You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. </para></note><para> For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/update-vehicles-cli.html">Update multiple vehicles (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWUpdateVehicleCmdlet.Vehicle"> <summary> <para> <para> A list of information about the vehicles to update. For more information, see the API data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWUpdateVehicleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.BatchUpdateVehicleResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.BatchUpdateVehicleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWUpdateVehicleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleCmdlet"> <summary> 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. <note><para> 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. </para></note><para> For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicle-cli.html">Create a vehicle (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleCmdlet.AssociationBehavior"> <summary> <para> <para> An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle. </para><para>Default: <code /></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleCmdlet.Attribute"> <summary> <para> <para>Static information about a vehicle in a key-value pair. For example: <c>"engineType"</c> : <c>"1.3 L R2"</c></para><para>A campaign must include the keys (attribute names) in <c>dataExtraDimensions</c> for them to display in Amazon Timestream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleCmdlet.DecoderManifestArn"> <summary> <para> <para> The ARN of a decoder manifest. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleCmdlet.ModelManifestArn"> <summary> <para> <para> The Amazon Resource Name ARN of a vehicle model. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the vehicle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleCmdlet.VehicleName"> <summary> <para> <para> The unique ID of the vehicle to create. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.CreateVehicleResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.CreateVehicleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleFleetCmdlet"> <summary> Adds, or associates, a vehicle with a fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleFleetCmdlet.FleetId"> <summary> <para> <para> The ID of a fleet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleFleetCmdlet.VehicleName"> <summary> <para> <para> The unique ID of the vehicle to associate with the fleet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.AssociateVehicleFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.NewIFWVehicleFleetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.RegisterIFWAccountCmdlet"> <summary> <important><para> 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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_CreateCampaign.html">CreateCampaign</a> API operation. </para><para> You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_DeleteCampaign.html">DeleteCampaign</a> API operation. </para><para> 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 <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteServiceLinkedRole.html">DeleteServiceLinkedRole</a> in the <i>Identity and Access Management API Reference</i>. </para></important><para> 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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html">Setting up Amazon Web Services IoT FleetWise</a>. </para><note><para> An Amazon Web Services account is <b>not</b> the same thing as a "user." An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html#intro-identity-users">Amazon Web Services user</a> is an identity that you create using Identity and Access Management (IAM) and takes the form of either an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html">IAM user</a> or an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM role, both with credentials</a>. A single Amazon Web Services account can, and typically does, contain many users and roles. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RegisterIFWAccountCmdlet.IamResources_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. For example, <c>arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RegisterIFWAccountCmdlet.TimestreamResources_TimestreamDatabaseName"> <summary> <para> <para>The name of the registered Amazon Timestream database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RegisterIFWAccountCmdlet.TimestreamResources_TimestreamTableName"> <summary> <para> <para>The name of the registered Amazon Timestream database table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RegisterIFWAccountCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.RegisterAccountResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.RegisterAccountResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RegisterIFWAccountCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWCampaignCmdlet"> <summary> Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWCampaignCmdlet.Name"> <summary> <para> <para> The name of the campaign to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.DeleteCampaignResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.DeleteCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWDecoderManifestCmdlet"> <summary> Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it. <note><para> If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWDecoderManifestCmdlet.Name"> <summary> <para> <para> The name of the decoder manifest to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWDecoderManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.DeleteDecoderManifestResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.DeleteDecoderManifestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWDecoderManifestCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWFleetCmdlet"> <summary> Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/delete-fleet-cli.html">Delete a fleet (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. <note><para> If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWFleetCmdlet.FleetId"> <summary> <para> <para> The ID of the fleet to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.DeleteFleetResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.DeleteFleetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWFleetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWModelManifestCmdlet"> <summary> Deletes a vehicle model (model manifest). <note><para> If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWModelManifestCmdlet.Name"> <summary> <para> <para> The name of the model manifest to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWModelManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.DeleteModelManifestResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.DeleteModelManifestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWModelManifestCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWResourceTagCmdlet"> <summary> Removes the given tags (metadata) from the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of the keys of the tags to be removed from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWSignalCatalogCmdlet"> <summary> Deletes a signal catalog. <note><para> If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWSignalCatalogCmdlet.Name"> <summary> <para> <para> The name of the signal catalog to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWSignalCatalogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.DeleteSignalCatalogResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.DeleteSignalCatalogResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWSignalCatalogCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWVehicleCmdlet"> <summary> Deletes a vehicle and removes it from any campaigns. <note><para> If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWVehicleCmdlet.VehicleName"> <summary> <para> <para>The ID of the vehicle to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWVehicleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.DeleteVehicleResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.DeleteVehicleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWVehicleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWVehicleFleetCmdlet"> <summary> Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle. <note><para> If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWVehicleFleetCmdlet.FleetId"> <summary> <para> <para> The unique ID of a fleet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWVehicleFleetCmdlet.VehicleName"> <summary> <para> <para> The unique ID of the vehicle to disassociate from the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWVehicleFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.DisassociateVehicleFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.RemoveIFWVehicleFleetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWCampaignCmdlet"> <summary> Updates a campaign. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWCampaignCmdlet.Action"> <summary> <para> <para> Specifies how to update a campaign. The action can be one of the following:</para><ul><li><para><c>APPROVE</c> - To approve delivering a data collection scheme to vehicles. </para></li><li><para><c>SUSPEND</c> - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.</para></li><li><para><c>RESUME</c> - To reactivate the <c>SUSPEND</c> campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.</para></li><li><para><c>UPDATE</c> - To update a campaign. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWCampaignCmdlet.DataExtraDimension"> <summary> <para> <para> A list of vehicle attributes to associate with a signal. </para><para>Default: An empty array</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWCampaignCmdlet.Description"> <summary> <para> <para>The description of the campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWCampaignCmdlet.Name"> <summary> <para> <para> The name of the campaign to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWCampaignCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.UpdateCampaignResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.UpdateCampaignResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWCampaignCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet"> <summary> Updates a decoder manifest. <para> A decoder manifest can only be updated when the status is <c>DRAFT</c>. Only <c>ACTIVE</c> decoder manifests can be associated with vehicles. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.Description"> <summary> <para> <para> A brief description of the decoder manifest to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.Name"> <summary> <para> <para> The name of the decoder manifest to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.NetworkInterfacesToAdd"> <summary> <para> <para> A list of information about the network interfaces to add to the decoder manifest. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.NetworkInterfacesToRemove"> <summary> <para> <para> A list of network interfaces to remove from the decoder manifest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.NetworkInterfacesToUpdate"> <summary> <para> <para> A list of information about the network interfaces to update in the decoder manifest. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.SignalDecodersToAdd"> <summary> <para> <para> A list of information about decoding additional signals to add to the decoder manifest. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.SignalDecodersToRemove"> <summary> <para> <para> A list of signal decoders to remove from the decoder manifest. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.SignalDecodersToUpdate"> <summary> <para> <para> A list of updated information about decoding signals to update in the decoder manifest. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.Status"> <summary> <para> <para> The state of the decoder manifest. If the status is <c>ACTIVE</c>, the decoder manifest can't be edited. If the status is <c>DRAFT</c>, you can edit the decoder manifest. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.UpdateDecoderManifestResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.UpdateDecoderManifestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWDecoderManifestCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWFleetCmdlet"> <summary> Updates the description of an existing fleet. <note><para> If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWFleetCmdlet.Description"> <summary> <para> <para> An updated description of the fleet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWFleetCmdlet.FleetId"> <summary> <para> <para> The ID of the fleet to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.UpdateFleetResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.UpdateFleetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWFleetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWModelManifestCmdlet"> <summary> Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWModelManifestCmdlet.Description"> <summary> <para> <para> A brief description of the vehicle model. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWModelManifestCmdlet.Name"> <summary> <para> <para> The name of the vehicle model to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWModelManifestCmdlet.NodesToAdd"> <summary> <para> <para> A list of <c>fullyQualifiedName</c> of nodes, which are a general abstraction of signals, to add to the vehicle model. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWModelManifestCmdlet.NodesToRemove"> <summary> <para> <para> A list of <c>fullyQualifiedName</c> of nodes, which are a general abstraction of signals, to remove from the vehicle model. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWModelManifestCmdlet.Status"> <summary> <para> <para> The state of the vehicle model. If the status is <c>ACTIVE</c>, the vehicle model can't be edited. If the status is <c>DRAFT</c>, you can edit the vehicle model. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWModelManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.UpdateModelManifestResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.UpdateModelManifestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWModelManifestCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWSignalCatalogCmdlet"> <summary> Updates a signal catalog. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWSignalCatalogCmdlet.Description"> <summary> <para> <para> A brief description of the signal catalog to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWSignalCatalogCmdlet.Name"> <summary> <para> <para> The name of the signal catalog to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWSignalCatalogCmdlet.NodesToAdd"> <summary> <para> <para> A list of information about nodes to add to the signal catalog. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWSignalCatalogCmdlet.NodesToRemove"> <summary> <para> <para> A list of <c>fullyQualifiedName</c> of nodes to remove from the signal catalog. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWSignalCatalogCmdlet.NodesToUpdate"> <summary> <para> <para> A list of information about nodes to update in the signal catalog. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWSignalCatalogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.UpdateSignalCatalogResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.UpdateSignalCatalogResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWSignalCatalogCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWVehicleCmdlet"> <summary> Updates a vehicle. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWVehicleCmdlet.Attribute"> <summary> <para> <para>Static information about a vehicle in a key-value pair. For example:</para><para><c>"engineType"</c> : <c>"1.3 L R2"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWVehicleCmdlet.AttributeUpdateMode"> <summary> <para> <para>The method the specified attributes will update the existing attributes on the vehicle. Use<c>Overwite</c> to replace the vehicle attributes with the specified attributes. Or use <c>Merge</c> to combine all attributes.</para><para>This is required if attributes are present in the input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWVehicleCmdlet.DecoderManifestArn"> <summary> <para> <para>The ARN of the decoder manifest associated with this vehicle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWVehicleCmdlet.ModelManifestArn"> <summary> <para> <para>The ARN of a vehicle model (model manifest) associated with the vehicle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWVehicleCmdlet.VehicleName"> <summary> <para> <para>The unique ID of the vehicle to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWVehicleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.UpdateVehicleResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.UpdateVehicleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.UpdateIFWVehicleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.WriteIFWEncryptionConfigurationCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/data-encryption.html">Data encryption</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.WriteIFWEncryptionConfigurationCmdlet.EncryptionType"> <summary> <para> <para>The type of encryption. Choose <c>KMS_BASED_ENCRYPTION</c> to use a KMS key or <c>FLEETWISE_DEFAULT_ENCRYPTION</c> to use an Amazon Web Services managed key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.WriteIFWEncryptionConfigurationCmdlet.KmsKeyId"> <summary> <para> <para>The ID of the KMS key that is used for encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.WriteIFWEncryptionConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.PutEncryptionConfigurationResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.PutEncryptionConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.WriteIFWEncryptionConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IFW.WriteIFWLoggingOptionCmdlet"> <summary> Creates or updates the logging option. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.WriteIFWLoggingOptionCmdlet.CloudWatchLogDelivery_LogGroupName"> <summary> <para> <para>The Amazon CloudWatch Logs group the operation sends data to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.WriteIFWLoggingOptionCmdlet.CloudWatchLogDelivery_LogType"> <summary> <para> <para>The type of log to send data to Amazon CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.WriteIFWLoggingOptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetWise.Model.PutLoggingOptionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IFW.WriteIFWLoggingOptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |