AWS.Tools.IoTSiteWise.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IoTSiteWise</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWResourceTagCmdlet"> <summary> Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWResourceTagCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that contain metadata for the resource. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWResourceTagCmdlet.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.IoTSiteWise.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWResourceTagCmdlet.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.IOTSW.AddIOTSWTimeSeriesToAssetPropertyCmdlet"> <summary> Associates a time series (data stream) with an asset property. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWTimeSeriesToAssetPropertyCmdlet.Alias"> <summary> <para> <para>The alias that identifies the time series.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWTimeSeriesToAssetPropertyCmdlet.AssetId"> <summary> <para> <para>The ID of the asset in which the asset property was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWTimeSeriesToAssetPropertyCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWTimeSeriesToAssetPropertyCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWTimeSeriesToAssetPropertyCmdlet.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.IoTSiteWise.Model.AssociateTimeSeriesToAssetPropertyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.AddIOTSWTimeSeriesToAssetPropertyCmdlet.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.IOTSW.ConnectIOTSWAssetCmdlet"> <summary> Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html">Associating assets</a> in the <i>IoT SiteWise User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssetCmdlet.AssetId"> <summary> <para> <para>The ID of the parent asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssetCmdlet.ChildAssetId"> <summary> <para> <para>The ID of the child asset to be associated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssetCmdlet.HierarchyId"> <summary> <para> <para>The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssetCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssetCmdlet.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.IoTSiteWise.Model.AssociateAssetsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssetCmdlet.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.IOTSW.ConnectIOTSWAssociateProjectAssetCmdlet"> <summary> Associates a group (batch) of assets with an IoT SiteWise Monitor project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssociateProjectAssetCmdlet.AssetId"> <summary> <para> <para>The IDs of the assets to be associated to the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssociateProjectAssetCmdlet.ProjectId"> <summary> <para> <para>The ID of the project to which to associate the assets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssociateProjectAssetCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssociateProjectAssetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Errors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.BatchAssociateProjectAssetsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.BatchAssociateProjectAssetsResponse 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.IOTSW.ConnectIOTSWAssociateProjectAssetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ConnectIOTSWAssociateProjectAssetCmdlet.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.IOTSW.DisconnectIOTSWAssetCmdlet"> <summary> Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWAssetCmdlet.AssetId"> <summary> <para> <para>The ID of the parent asset from which to disassociate the child asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWAssetCmdlet.ChildAssetId"> <summary> <para> <para>The ID of the child asset to disassociate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWAssetCmdlet.HierarchyId"> <summary> <para> <para>The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWAssetCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWAssetCmdlet.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.IoTSiteWise.Model.DisassociateAssetsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWAssetCmdlet.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.IOTSW.DisconnectIOTSWDisassociateProjectAssetCmdlet"> <summary> Disassociates a group (batch) of assets from an IoT SiteWise Monitor project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWDisassociateProjectAssetCmdlet.AssetId"> <summary> <para> <para>The IDs of the assets to be disassociated from the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWDisassociateProjectAssetCmdlet.ProjectId"> <summary> <para> <para>The ID of the project from which to disassociate the assets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWDisassociateProjectAssetCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWDisassociateProjectAssetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Errors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.BatchDisassociateProjectAssetsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.BatchDisassociateProjectAssetsResponse 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.IOTSW.DisconnectIOTSWDisassociateProjectAssetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.DisconnectIOTSWDisassociateProjectAssetCmdlet.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.IOTSW.GetIOTSWAccessPolicyCmdlet"> <summary> Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyCmdlet.AccessPolicyId"> <summary> <para> <para>The ID of the access policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyCmdlet.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.IoTSiteWise.Model.DescribeAccessPolicyResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeAccessPolicyResponse 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.IOTSW.GetIOTSWAccessPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccessPolicyId parameter. The -PassThru parameter is deprecated, use -Select '^AccessPolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyListCmdlet"> <summary> Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyListCmdlet.IamArn"> <summary> <para> <para>The ARN of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the <i>IAM User Guide</i>. This parameter is required if you specify <code>IAM</code> for <code>identityType</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyListCmdlet.IdentityId"> <summary> <para> <para>The ID of the identity. This parameter is required if you specify <code>USER</code> or <code>GROUP</code> for <code>identityType</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyListCmdlet.IdentityType"> <summary> <para> <para>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify <code>identityId</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyListCmdlet.ResourceId"> <summary> <para> <para>The ID of the resource. This parameter is required if you specify <code>resourceType</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyListCmdlet.ResourceType"> <summary> <para> <para>The type of resource (portal or project). This parameter is required if you specify <code>resourceId</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAccessPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPolicySummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListAccessPoliciesResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListAccessPoliciesResponse 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.IOTSW.GetIOTSWAccessPolicyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetCmdlet"> <summary> Retrieves information about an asset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetCmdlet.AssetId"> <summary> <para> <para>The ID of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetCmdlet.ExcludeProperty"> <summary> <para> <para> Whether or not to exclude asset properties from the response. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetCmdlet.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.IoTSiteWise.Model.DescribeAssetResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeAssetResponse 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.IOTSW.GetIOTSWAssetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetId parameter. The -PassThru parameter is deprecated, use -Select '^AssetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetListCmdlet"> <summary> Retrieves a paginated list of asset summaries. <para> You can use this operation to do the following: </para><ul><li><para> List assets based on a specific asset model. </para></li><li><para> List top-level assets. </para></li></ul><para> You can't use this operation to list all assets. To retrieve summaries for all of your assets, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html">ListAssetModels</a> to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetListCmdlet.AssetModelId"> <summary> <para> <para>The ID of the asset model by which to filter the list of assets. This parameter is required if you choose <code>ALL</code> for <code>filter</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetListCmdlet.Filter"> <summary> <para> <para>The filter for the requested list of assets. Choose one of the following options:</para><ul><li><para><code>ALL</code> – The list includes all assets for a given asset model ID. The <code>assetModelId</code> parameter is required if you filter by <code>ALL</code>.</para></li><li><para><code>TOP_LEVEL</code> – The list includes only top-level assets in the asset hierarchy tree.</para></li></ul><para>Default: <code>ALL</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListAssetsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListAssetsResponse 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.IOTSW.GetIOTSWAssetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelCmdlet"> <summary> Retrieves information about an asset model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelCmdlet.AssetModelId"> <summary> <para> <para>The ID of the asset model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelCmdlet.ExcludeProperty"> <summary> <para> <para> Whether or not to exclude asset model properties from the response. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelCmdlet.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.IoTSiteWise.Model.DescribeAssetModelResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeAssetModelResponse 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.IOTSW.GetIOTSWAssetModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetModelId parameter. The -PassThru parameter is deprecated, use -Select '^AssetModelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelListCmdlet"> <summary> Retrieves a paginated list of summaries of all asset models.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetModelSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListAssetModelsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListAssetModelsResponse 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.IOTSW.GetIOTSWAssetModelListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelPropertyListCmdlet"> <summary> Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelPropertyListCmdlet.AssetModelId"> <summary> <para> <para>The ID of the asset model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelPropertyListCmdlet.Filter"> <summary> <para> <para> Filters the requested list of asset model properties. You can choose one of the following options:</para><ul><li><para><code>ALL</code> – The list includes all asset model properties for a given asset model ID. </para></li><li><para><code>BASE</code> – The list includes only base asset model properties for a given asset model ID. </para></li></ul><para>Default: <code>BASE</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelPropertyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelPropertyListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelPropertyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetModelPropertySummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListAssetModelPropertiesResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListAssetModelPropertiesResponse 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.IOTSW.GetIOTSWAssetModelPropertyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetModelId parameter. The -PassThru parameter is deprecated, use -Select '^AssetModelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetModelPropertyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyCmdlet"> <summary> Retrieves information about an asset property. <note><para> When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value. </para></note><para> This operation doesn't return the value of the asset property. To get the value of an asset property, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html">GetAssetPropertyValue</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyCmdlet.AssetId"> <summary> <para> <para>The ID of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyCmdlet.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.IoTSiteWise.Model.DescribeAssetPropertyResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeAssetPropertyResponse 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.IOTSW.GetIOTSWAssetPropertyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetId parameter. The -PassThru parameter is deprecated, use -Select '^AssetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet"> <summary> Gets aggregated values for an asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates">Querying aggregates</a> in the <i>IoT SiteWise User Guide</i>. <para> To identify an asset property, you must specify one of the following: </para><ul><li><para> The <code>assetId</code> and <code>propertyId</code> of an asset property. </para></li><li><para> A <code>propertyAlias</code>, which is a data stream alias (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>. </para></li></ul><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.AggregateType"> <summary> <para> <para>The data aggregating function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.AssetId"> <summary> <para> <para>The ID of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.EndDate"> <summary> <para> <para>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.PropertyAlias"> <summary> <para> <para>The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.Quality"> <summary> <para> <para>The quality by which to filter asset data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.Resolution"> <summary> <para> <para>The time interval over which to aggregate data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.StartDate"> <summary> <para> <para>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.TimeOrdering"> <summary> <para> <para>The chronological sorting order of the requested information.</para><para>Default: <code>ASCENDING</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 100</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AggregatedValues'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesResponse 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.IOTSW.GetIOTSWAssetPropertyAggregateCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyListCmdlet"> <summary> Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyListCmdlet.AssetId"> <summary> <para> <para>The ID of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyListCmdlet.Filter"> <summary> <para> <para> Filters the requested list of asset properties. You can choose one of the following options:</para><ul><li><para><code>ALL</code> – The list includes all asset properties for a given asset model ID. </para></li><li><para><code>BASE</code> – The list includes only base asset properties for a given asset model ID. </para></li></ul><para>Default: <code>BASE</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetPropertySummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListAssetPropertiesResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListAssetPropertiesResponse 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.IOTSW.GetIOTSWAssetPropertyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetId parameter. The -PassThru parameter is deprecated, use -Select '^AssetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueCmdlet"> <summary> Gets an asset property's current value. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values">Querying current values</a> in the <i>IoT SiteWise User Guide</i>. <para> To identify an asset property, you must specify one of the following: </para><ul><li><para> The <code>assetId</code> and <code>propertyId</code> of an asset property. </para></li><li><para> A <code>propertyAlias</code>, which is a data stream alias (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueCmdlet.AssetId"> <summary> <para> <para>The ID of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueCmdlet.PropertyAlias"> <summary> <para> <para>The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PropertyValue'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.GetAssetPropertyValueResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.GetAssetPropertyValueResponse 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.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet"> <summary> Gets the history of an asset property's values. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values">Querying historical values</a> in the <i>IoT SiteWise User Guide</i>. <para> To identify an asset property, you must specify one of the following: </para><ul><li><para> The <code>assetId</code> and <code>propertyId</code> of an asset property. </para></li><li><para> A <code>propertyAlias</code>, which is a data stream alias (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>. </para></li></ul><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.AssetId"> <summary> <para> <para>The ID of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.EndDate"> <summary> <para> <para>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.PropertyAlias"> <summary> <para> <para>The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.Quality"> <summary> <para> <para>The quality by which to filter asset data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.StartDate"> <summary> <para> <para>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.TimeOrdering"> <summary> <para> <para>The chronological sorting order of the requested information.</para><para>Default: <code>ASCENDING</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 100</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetPropertyValueHistory'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.GetAssetPropertyValueHistoryResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.GetAssetPropertyValueHistoryResponse 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.IOTSW.GetIOTSWAssetPropertyValueHistoryCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetRelationshipListCmdlet"> <summary> Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetRelationshipListCmdlet.AssetId"> <summary> <para> <para>The ID of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetRelationshipListCmdlet.TraversalType"> <summary> <para> <para>The type of traversal to use to identify asset relationships. Choose the following option:</para><ul><li><para><code>PATH_TO_ROOT</code> – Identify the asset's parent assets up to the root asset. The asset that you specify in <code>assetId</code> is the first result in the list of <code>assetRelationshipSummaries</code>, and the root asset is the last result.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetRelationshipListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetRelationshipListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetRelationshipListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetRelationshipSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListAssetRelationshipsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListAssetRelationshipsResponse 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.IOTSW.GetIOTSWAssetRelationshipListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetId parameter. The -PassThru parameter is deprecated, use -Select '^AssetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssetRelationshipListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssociatedAssetListCmdlet"> <summary> Retrieves a paginated list of associated assets. <para> You can use this operation to do the following: </para><ul><li><para> List child assets associated to a parent asset by a hierarchy that you specify. </para></li><li><para> List an asset's parent asset. </para></li></ul><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssociatedAssetListCmdlet.AssetId"> <summary> <para> <para>The ID of the asset to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssociatedAssetListCmdlet.HierarchyId"> <summary> <para> <para>The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html">DescribeAsset</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a> operations. This parameter is required if you choose <code>CHILD</code> for <code>traversalDirection</code>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssociatedAssetListCmdlet.TraversalDirection"> <summary> <para> <para>The direction to list associated assets. Choose one of the following options:</para><ul><li><para><code>CHILD</code> – The list includes all child assets associated to the asset. The <code>hierarchyId</code> parameter is required if you choose <code>CHILD</code>.</para></li><li><para><code>PARENT</code> – The list includes the asset's parent asset.</para></li></ul><para>Default: <code>CHILD</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssociatedAssetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssociatedAssetListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssociatedAssetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListAssociatedAssetsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListAssociatedAssetsResponse 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.IOTSW.GetIOTSWAssociatedAssetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetId parameter. The -PassThru parameter is deprecated, use -Select '^AssetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWAssociatedAssetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyAggregateCmdlet"> <summary> Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates">Querying aggregates</a> in the <i>IoT SiteWise User Guide</i>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyAggregateCmdlet.Entry"> <summary> <para> <para>The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyAggregateCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.</para><ul><li><para>The size of the result set is less than 1 MB.</para></li><li><para>The number of data points in the result set is less than the value of <code>maxResults</code>. The maximum value of <code>maxResults</code> is 4000.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyAggregateCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyAggregateCmdlet.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.IoTSiteWise.Model.BatchGetAssetPropertyAggregatesResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.BatchGetAssetPropertyAggregatesResponse 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.IOTSW.GetIOTSWBatchAssetPropertyAggregateCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyValueCmdlet"> <summary> Gets the current value for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values">Querying current values</a> in the <i>IoT SiteWise User Guide</i>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyValueCmdlet.Entry"> <summary> <para> <para>The list of asset property value entries for the batch get request. You can specify up to 128 entries per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyValueCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyValueCmdlet.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.IoTSiteWise.Model.BatchGetAssetPropertyValueResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.BatchGetAssetPropertyValueResponse 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.IOTSW.GetIOTSWBatchAssetPropertyValueCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyValueHistoryCmdlet"> <summary> Gets the historical values for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values">Querying historical values</a> in the <i>IoT SiteWise User Guide</i>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyValueHistoryCmdlet.Entry"> <summary> <para> <para>The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyValueHistoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.</para><ul><li><para>The size of the result set is less than 1 MB.</para></li><li><para>The number of data points in the result set is less than the value of <code>maxResults</code>. The maximum value of <code>maxResults</code> is 4000.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyValueHistoryCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBatchAssetPropertyValueHistoryCmdlet.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.IoTSiteWise.Model.BatchGetAssetPropertyValueHistoryResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.BatchGetAssetPropertyValueHistoryResponse 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.IOTSW.GetIOTSWBatchAssetPropertyValueHistoryCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBulkImportJobCmdlet"> <summary> Retrieves information about a bulk import job request. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html">Describe a bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBulkImportJobCmdlet.JobId"> <summary> <para> <para>The ID of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBulkImportJobCmdlet.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.IoTSiteWise.Model.DescribeBulkImportJobResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeBulkImportJobResponse 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.IOTSW.GetIOTSWBulkImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBulkImportJobListCmdlet"> <summary> Retrieves a paginated list of bulk import job requests. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html">List bulk import jobs (CLI)</a> in the <i>IoT SiteWise User Guide</i>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBulkImportJobListCmdlet.Filter"> <summary> <para> <para>You can use a filter to select the bulk import jobs that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBulkImportJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBulkImportJobListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBulkImportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListBulkImportJobsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListBulkImportJobsResponse 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.IOTSW.GetIOTSWBulkImportJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWBulkImportJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDashboardCmdlet"> <summary> Retrieves information about a dashboard. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDashboardCmdlet.DashboardId"> <summary> <para> <para>The ID of the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDashboardCmdlet.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.IoTSiteWise.Model.DescribeDashboardResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeDashboardResponse 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.IOTSW.GetIOTSWDashboardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDashboardListCmdlet"> <summary> Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDashboardListCmdlet.ProjectId"> <summary> <para> <para>The ID of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDashboardListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDashboardListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDashboardListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DashboardSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListDashboardsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListDashboardsResponse 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.IOTSW.GetIOTSWDashboardListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDashboardListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDefaultEncryptionConfigurationCmdlet"> <summary> Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html">Key management</a> in the <i>IoT SiteWise User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWDefaultEncryptionConfigurationCmdlet.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.IoTSiteWise.Model.DescribeDefaultEncryptionConfigurationResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeDefaultEncryptionConfigurationResponse 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.IOTSW.GetIOTSWGatewayCmdlet"> <summary> Retrieves information about a gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayCmdlet.GatewayId"> <summary> <para> <para>The ID of the gateway device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayCmdlet.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.IoTSiteWise.Model.DescribeGatewayResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeGatewayResponse 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.IOTSW.GetIOTSWGatewayCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GatewayId parameter. The -PassThru parameter is deprecated, use -Select '^GatewayId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayCapabilityConfigurationCmdlet"> <summary> Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html">DescribeGateway</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayCapabilityConfigurationCmdlet.CapabilityNamespace"> <summary> <para> <para>The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as <code>1</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayCapabilityConfigurationCmdlet.GatewayId"> <summary> <para> <para>The ID of the gateway that defines the capability configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayCapabilityConfigurationCmdlet.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.IoTSiteWise.Model.DescribeGatewayCapabilityConfigurationResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeGatewayCapabilityConfigurationResponse 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.IOTSW.GetIOTSWGatewayCapabilityConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GatewayId parameter. The -PassThru parameter is deprecated, use -Select '^GatewayId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayListCmdlet"> <summary> Retrieves a paginated list of gateways.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWGatewayListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GatewaySummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListGatewaysResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListGatewaysResponse 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.IOTSW.GetIOTSWGatewayListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet"> <summary> Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data. <para> For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. </para><para> To identify an asset property, you must specify one of the following: </para><ul><li><para> The <code>assetId</code> and <code>propertyId</code> of an asset property. </para></li><li><para> A <code>propertyAlias</code>, which is a data stream alias (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>. </para></li></ul><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.AssetId"> <summary> <para> <para>The ID of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.EndTimeInSecond"> <summary> <para> <para>The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.EndTimeOffsetInNano"> <summary> <para> <para>The nanosecond offset converted from <code>endTimeInSeconds</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.IntervalInSecond"> <summary> <para> <para>The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.IntervalWindowInSecond"> <summary> <para> <para>The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.</para><note><ul><li><para>If you specify a value for the <code>intervalWindowInSeconds</code> parameter, the value for the <code>type</code> parameter must be <code>LINEAR_INTERPOLATION</code>.</para></li><li><para>If a data point isn't found during the specified query window, IoT SiteWise won't return an interpolated value for the interval. This indicates that there's a gap in the ingested data points.</para></li></ul></note><para>For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.PropertyAlias"> <summary> <para> <para>The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.Quality"> <summary> <para> <para>The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.StartTimeInSecond"> <summary> <para> <para>The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.StartTimeOffsetInNano"> <summary> <para> <para>The nanosecond offset converted from <code>startTimeInSeconds</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.Type"> <summary> <para> <para>The interpolation type.</para><para>Valid values: <code>LINEAR_INTERPOLATION | LOCF_INTERPOLATION</code></para><ul><li><para><code>LINEAR_INTERPOLATION</code> – Estimates missing data using <a href="https://en.wikipedia.org/wiki/Linear_interpolation">linear interpolation</a>.</para><para>For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.</para></li><li><para><code>LOCF_INTERPOLATION</code> – Estimates missing data using last observation carried forward interpolation</para><para>If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found.</para><para>For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request. If not specified, the default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InterpolatedAssetPropertyValues'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.GetInterpolatedAssetPropertyValuesResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.GetInterpolatedAssetPropertyValuesResponse 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.IOTSW.GetIOTSWInterpolatedAssetPropertyValueCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWLoggingOptionCmdlet"> <summary> Retrieves the current IoT SiteWise logging options. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWLoggingOptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LoggingOptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.DescribeLoggingOptionsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeLoggingOptionsResponse 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.IOTSW.GetIOTSWPortalCmdlet"> <summary> Retrieves information about a portal. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWPortalCmdlet.PortalId"> <summary> <para> <para>The ID of the portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWPortalCmdlet.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.IoTSiteWise.Model.DescribePortalResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribePortalResponse 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.IOTSW.GetIOTSWPortalCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PortalId parameter. The -PassThru parameter is deprecated, use -Select '^PortalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWPortalListCmdlet"> <summary> Retrieves a paginated list of IoT SiteWise Monitor portals.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWPortalListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWPortalListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWPortalListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PortalSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListPortalsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListPortalsResponse 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.IOTSW.GetIOTSWPortalListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectCmdlet"> <summary> Retrieves information about a project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectCmdlet.ProjectId"> <summary> <para> <para>The ID of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectCmdlet.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.IoTSiteWise.Model.DescribeProjectResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeProjectResponse 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.IOTSW.GetIOTSWProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectAssetListCmdlet"> <summary> Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectAssetListCmdlet.ProjectId"> <summary> <para> <para>The ID of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectAssetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectAssetListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectAssetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListProjectAssetsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListProjectAssetsResponse 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.IOTSW.GetIOTSWProjectAssetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectAssetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectListCmdlet"> <summary> Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectListCmdlet.PortalId"> <summary> <para> <para>The ID of the portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para><para>Default: 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListProjectsResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListProjectsResponse 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.IOTSW.GetIOTSWProjectListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PortalId parameter. The -PassThru parameter is deprecated, use -Select '^PortalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWProjectListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWResourceTagCmdlet"> <summary> Retrieves the list of tags for an IoT SiteWise resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWResourceTagCmdlet.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.IoTSiteWise.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.IoTSiteWise.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="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWStorageConfigurationCmdlet"> <summary> Retrieves information about the storage configuration for IoT SiteWise. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWStorageConfigurationCmdlet.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.IoTSiteWise.Model.DescribeStorageConfigurationResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeStorageConfigurationResponse 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.IOTSW.GetIOTSWTimeSeriesCmdlet"> <summary> Retrieves information about a time series (data stream). <para> To identify a time series, do one of the following: </para><ul><li><para> If the time series isn't associated with an asset property, specify the <code>alias</code> of the time series. </para></li><li><para> If the time series is associated with an asset property, specify one of the following: </para><ul><li><para> The <code>alias</code> of the time series. </para></li><li><para> The <code>assetId</code> and <code>propertyId</code> that identifies the asset property. </para></li></ul></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesCmdlet.Alias"> <summary> <para> <para>The alias that identifies the time series.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesCmdlet.AssetId"> <summary> <para> <para>The ID of the asset in which the asset property was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesCmdlet.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.IoTSiteWise.Model.DescribeTimeSeriesResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DescribeTimeSeriesResponse 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.IOTSW.GetIOTSWTimeSeriesListCmdlet"> <summary> Retrieves a paginated list of time series (data streams).<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesListCmdlet.AliasPrefix"> <summary> <para> <para>The alias prefix of the time series.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesListCmdlet.AssetId"> <summary> <para> <para>The ID of the asset in which the asset property was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesListCmdlet.TimeSeriesType"> <summary> <para> <para>The type of the time series. The time series type can be one of the following values:</para><ul><li><para><code>ASSOCIATED</code> – The time series is associated with an asset property.</para></li><li><para><code>DISASSOCIATED</code> – The time series isn't associated with any asset property.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for each paginated request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesListCmdlet.NextToken"> <summary> <para> <para>The token to be used for the next set of paginated results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.GetIOTSWTimeSeriesListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TimeSeriesSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.ListTimeSeriesResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.ListTimeSeriesResponse 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.IOTSW.GetIOTSWTimeSeriesListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTSW.ImportIOTSWPutAssetPropertyValueCmdlet"> <summary> Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html">Ingesting data using the API</a> in the <i>IoT SiteWise User Guide</i>. <para> To identify an asset property, you must specify one of the following: </para><ul><li><para> The <code>assetId</code> and <code>propertyId</code> of an asset property. </para></li><li><para> A <code>propertyAlias</code>, which is a data stream alias (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>. </para></li></ul><important><para> With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a <code>TimestampOutOfRangeException</code> error. </para><para> For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV <code>{T1, GOOD, V1}</code>, then storing <code>{T1, GOOD, V2}</code> replaces the existing TQV. </para></important><para> IoT SiteWise authorizes access to each <code>BatchPutAssetPropertyValue</code> entry individually. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action">BatchPutAssetPropertyValue authorization</a> in the <i>IoT SiteWise User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ImportIOTSWPutAssetPropertyValueCmdlet.Entry"> <summary> <para> <para>The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.ImportIOTSWPutAssetPropertyValueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ErrorEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.BatchPutAssetPropertyValueResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.BatchPutAssetPropertyValueResponse 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.IOTSW.ImportIOTSWPutAssetPropertyValueCmdlet.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.IOTSW.NewIOTSWAccessPolicyCmdlet"> <summary> Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.AccessPolicyPermission"> <summary> <para> <para>The permission level for this access policy. Note that a project <code>ADMINISTRATOR</code> is also known as a project owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.IamRole_Arn"> <summary> <para> <para>The ARN of the IAM role. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the <i>IAM User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.IamUser_Arn"> <summary> <para> <para>The ARN of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the <i>IAM User Guide</i>.</para><note><para>If you delete the IAM user, access policies that contain this identity include an empty <code>arn</code>. You can delete the access policy for the IAM user that no longer exists.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.Group_Id"> <summary> <para> <para>The IAM Identity Center ID of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.User_Id"> <summary> <para> <para>The IAM Identity Center ID of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.Portal_Id"> <summary> <para> <para>The ID of the portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.Project_Id"> <summary> <para> <para>The ID of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that contain metadata for the access policy. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.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.IoTSiteWise.Model.CreateAccessPolicyResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreateAccessPolicyResponse 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.IOTSW.NewIOTSWAccessPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccessPolicyPermission parameter. The -PassThru parameter is deprecated, use -Select '^AccessPolicyPermission' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAccessPolicyCmdlet.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.IOTSW.NewIOTSWAssetCmdlet"> <summary> Creates an asset from an existing asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html">Creating assets</a> in the <i>IoT SiteWise User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetCmdlet.AssetDescription"> <summary> <para> <para>A description for the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetCmdlet.AssetModelId"> <summary> <para> <para>The ID of the asset model from which to create the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetCmdlet.AssetName"> <summary> <para> <para>A friendly name for the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that contain metadata for the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetCmdlet.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.IoTSiteWise.Model.CreateAssetResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreateAssetResponse 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.IOTSW.NewIOTSWAssetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetModelId parameter. The -PassThru parameter is deprecated, use -Select '^AssetModelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetCmdlet.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.IOTSW.NewIOTSWAssetModelCmdlet"> <summary> Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html">Defining asset models</a> in the <i>IoT SiteWise User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetModelCmdlet.AssetModelCompositeModel"> <summary> <para> <para>The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetModelCmdlet.AssetModelDescription"> <summary> <para> <para>A description for the asset model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetModelCmdlet.AssetModelHierarchy"> <summary> <para> <para>The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</para><para>You can specify up to 10 hierarchies per asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetModelCmdlet.AssetModelName"> <summary> <para> <para>A unique, friendly name for the asset model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetModelCmdlet.AssetModelProperty"> <summary> <para> <para>The property definitions of the asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html">Asset properties</a> in the <i>IoT SiteWise User Guide</i>.</para><para>You can specify up to 200 properties per asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetModelCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that contain metadata for the asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetModelCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWAssetModelCmdlet.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.IoTSiteWise.Model.CreateAssetModelResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreateAssetModelResponse 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.IOTSW.NewIOTSWAssetModelCmdlet.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.IOTSW.NewIOTSWBulkImportJobCmdlet"> <summary> Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html">Create a bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>. <important><para> You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWBulkImportJobCmdlet.ErrorReportLocation_Bucket"> <summary> <para> <para>The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWBulkImportJobCmdlet.Csv_ColumnName"> <summary> <para> <para>The column names specified in the .csv file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWBulkImportJobCmdlet.File"> <summary> <para> <para>The files in the specified Amazon S3 bucket that contain your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWBulkImportJobCmdlet.JobName"> <summary> <para> <para>The unique name that helps identify the job request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWBulkImportJobCmdlet.JobRoleArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IAM role that allows IoT SiteWise to read Amazon S3 data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWBulkImportJobCmdlet.ErrorReportLocation_Prefix"> <summary> <para> <para>Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWBulkImportJobCmdlet.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.IoTSiteWise.Model.CreateBulkImportJobResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreateBulkImportJobResponse 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.IOTSW.NewIOTSWBulkImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobName parameter. The -PassThru parameter is deprecated, use -Select '^JobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWBulkImportJobCmdlet.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.IOTSW.NewIOTSWDashboardCmdlet"> <summary> Creates a dashboard in an IoT SiteWise Monitor project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWDashboardCmdlet.DashboardDefinition"> <summary> <para> <para>The dashboard definition specified in a JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWDashboardCmdlet.DashboardDescription"> <summary> <para> <para>A description for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWDashboardCmdlet.DashboardName"> <summary> <para> <para>A friendly name for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWDashboardCmdlet.ProjectId"> <summary> <para> <para>The ID of the project in which to create the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWDashboardCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that contain metadata for the dashboard. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWDashboardCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWDashboardCmdlet.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.IoTSiteWise.Model.CreateDashboardResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreateDashboardResponse 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.IOTSW.NewIOTSWDashboardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWDashboardCmdlet.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.IOTSW.NewIOTSWGatewayCmdlet"> <summary> Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html">Ingesting data using a gateway</a> in the <i>IoT SiteWise User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWGatewayCmdlet.GreengrassV2_CoreDeviceThingName"> <summary> <para> <para>The name of the IoT thing for your IoT Greengrass V2 core device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWGatewayCmdlet.GatewayName"> <summary> <para> <para>A unique, friendly name for the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWGatewayCmdlet.Greengrass_GroupArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Greengrass group. For more information about how to find a group's ARN, see <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html">ListGroups</a> and <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html">GetGroup</a> in the <i>IoT Greengrass API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWGatewayCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that contain metadata for the gateway. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWGatewayCmdlet.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.IoTSiteWise.Model.CreateGatewayResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreateGatewayResponse 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.IOTSW.NewIOTSWGatewayCmdlet.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.IOTSW.NewIOTSWPortalCmdlet"> <summary> Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions. <note><para> Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins">Adding or removing portal administrators</a> in the <i>IoT SiteWise User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.Alarms_AlarmRoleArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.PortalLogoImageFile_Data"> <summary> <para> <para>The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.Alarms_NotificationLambdaArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Lambda function that manages alarm notifications. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">Managing alarm notifications</a> in the <i>IoT Events Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.NotificationSenderEmail"> <summary> <para> <para>The email address that sends alarm notifications.</para><important><para>If you use the <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">IoT Events managed Lambda function</a> to manage your emails, you must <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html">verify the sender email address in Amazon SES</a>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.PortalAuthMode"> <summary> <para> <para>The service to use to authenticate users to the portal. Choose from the following options:</para><ul><li><para><code>SSO</code> – The portal uses IAM Identity Center (successor to Single Sign-On) to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso">Enabling IAM Identity Center</a> in the <i>IoT SiteWise User Guide</i>. This option is only available in Amazon Web Services Regions other than the China Regions.</para></li><li><para><code>IAM</code> – The portal uses Identity and Access Management to authenticate users and manage user permissions.</para></li></ul><para>You can't change this value after you create a portal.</para><para>Default: <code>SSO</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.PortalContactEmail"> <summary> <para> <para>The Amazon Web Services administrator's contact email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.PortalDescription"> <summary> <para> <para>A description for the portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.PortalName"> <summary> <para> <para>A friendly name for the portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.RoleArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html">Using service roles for IoT SiteWise Monitor</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that contain metadata for the portal. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.PortalLogoImageFile_Type"> <summary> <para> <para>The file type of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWPortalCmdlet.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.IoTSiteWise.Model.CreatePortalResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreatePortalResponse 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.IOTSW.NewIOTSWPortalCmdlet.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.IOTSW.NewIOTSWProjectCmdlet"> <summary> Creates a project in the specified portal. <note><para> Make sure that the project name and description don't contain confidential information. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWProjectCmdlet.PortalId"> <summary> <para> <para>The ID of the portal in which to create the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWProjectCmdlet.ProjectDescription"> <summary> <para> <para>A description for the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWProjectCmdlet.ProjectName"> <summary> <para> <para>A friendly name for the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWProjectCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that contain metadata for the project. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWProjectCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWProjectCmdlet.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.IoTSiteWise.Model.CreateProjectResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreateProjectResponse 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.IOTSW.NewIOTSWProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PortalId parameter. The -PassThru parameter is deprecated, use -Select '^PortalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.NewIOTSWProjectCmdlet.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.IOTSW.RemoveIOTSWAccessPolicyCmdlet"> <summary> Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAccessPolicyCmdlet.AccessPolicyId"> <summary> <para> <para>The ID of the access policy to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAccessPolicyCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAccessPolicyCmdlet.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.IoTSiteWise.Model.DeleteAccessPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAccessPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccessPolicyId parameter. The -PassThru parameter is deprecated, use -Select '^AccessPolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAccessPolicyCmdlet.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.IOTSW.RemoveIOTSWAssetCmdlet"> <summary> Deletes an asset. This action can't be undone. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html">Deleting assets and models</a> in the <i>IoT SiteWise User Guide</i>. <note><para> You can't delete an asset that's associated to another asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html">DisassociateAssets</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAssetCmdlet.AssetId"> <summary> <para> <para>The ID of the asset to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAssetCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAssetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.DeleteAssetResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DeleteAssetResponse 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.IOTSW.RemoveIOTSWAssetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetId parameter. The -PassThru parameter is deprecated, use -Select '^AssetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAssetCmdlet.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.IOTSW.RemoveIOTSWAssetModelCmdlet"> <summary> Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html">Deleting assets and models</a> in the <i>IoT SiteWise User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAssetModelCmdlet.AssetModelId"> <summary> <para> <para>The ID of the asset model to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAssetModelCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAssetModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetModelStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.DeleteAssetModelResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DeleteAssetModelResponse 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.IOTSW.RemoveIOTSWAssetModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetModelId parameter. The -PassThru parameter is deprecated, use -Select '^AssetModelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWAssetModelCmdlet.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.IOTSW.RemoveIOTSWDashboardCmdlet"> <summary> Deletes a dashboard from IoT SiteWise Monitor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWDashboardCmdlet.DashboardId"> <summary> <para> <para>The ID of the dashboard to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWDashboardCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWDashboardCmdlet.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.IoTSiteWise.Model.DeleteDashboardResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWDashboardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWDashboardCmdlet.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.IOTSW.RemoveIOTSWGatewayCmdlet"> <summary> Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWGatewayCmdlet.GatewayId"> <summary> <para> <para>The ID of the gateway to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWGatewayCmdlet.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.IoTSiteWise.Model.DeleteGatewayResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWGatewayCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GatewayId parameter. The -PassThru parameter is deprecated, use -Select '^GatewayId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWGatewayCmdlet.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.IOTSW.RemoveIOTSWPortalCmdlet"> <summary> Deletes a portal from IoT SiteWise Monitor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWPortalCmdlet.PortalId"> <summary> <para> <para>The ID of the portal to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWPortalCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWPortalCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PortalStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.DeletePortalResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.DeletePortalResponse 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.IOTSW.RemoveIOTSWPortalCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PortalId parameter. The -PassThru parameter is deprecated, use -Select '^PortalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWPortalCmdlet.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.IOTSW.RemoveIOTSWProjectCmdlet"> <summary> Deletes a project from IoT SiteWise Monitor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWProjectCmdlet.ProjectId"> <summary> <para> <para>The ID of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWProjectCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWProjectCmdlet.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.IoTSiteWise.Model.DeleteProjectResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWProjectCmdlet.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.IOTSW.RemoveIOTSWResourceTagCmdlet"> <summary> Removes a tag from an IoT SiteWise resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to untag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of keys for tags to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWResourceTagCmdlet.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.IoTSiteWise.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWResourceTagCmdlet.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.IOTSW.RemoveIOTSWTimeSeriesCmdlet"> <summary> Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property. <para> To identify a time series, do one of the following: </para><ul><li><para> If the time series isn't associated with an asset property, specify the <code>alias</code> of the time series. </para></li><li><para> If the time series is associated with an asset property, specify one of the following: </para><ul><li><para> The <code>alias</code> of the time series. </para></li><li><para> The <code>assetId</code> and <code>propertyId</code> that identifies the asset property. </para></li></ul></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesCmdlet.Alias"> <summary> <para> <para>The alias that identifies the time series.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesCmdlet.AssetId"> <summary> <para> <para>The ID of the asset in which the asset property was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesCmdlet.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.IoTSiteWise.Model.DeleteTimeSeriesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesCmdlet.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.IOTSW.RemoveIOTSWTimeSeriesFromAssetPropertyCmdlet"> <summary> Disassociates a time series (data stream) from an asset property. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesFromAssetPropertyCmdlet.Alias"> <summary> <para> <para>The alias that identifies the time series.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesFromAssetPropertyCmdlet.AssetId"> <summary> <para> <para>The ID of the asset in which the asset property was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesFromAssetPropertyCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesFromAssetPropertyCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesFromAssetPropertyCmdlet.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.IoTSiteWise.Model.DisassociateTimeSeriesFromAssetPropertyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.RemoveIOTSWTimeSeriesFromAssetPropertyCmdlet.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.IOTSW.UpdateIOTSWAccessPolicyCmdlet"> <summary> Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.AccessPolicyId"> <summary> <para> <para>The ID of the access policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.AccessPolicyPermission"> <summary> <para> <para>The permission level for this access policy. Note that a project <code>ADMINISTRATOR</code> is also known as a project owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.IamRole_Arn"> <summary> <para> <para>The ARN of the IAM role. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the <i>IAM User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.IamUser_Arn"> <summary> <para> <para>The ARN of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the <i>IAM User Guide</i>.</para><note><para>If you delete the IAM user, access policies that contain this identity include an empty <code>arn</code>. You can delete the access policy for the IAM user that no longer exists.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.Group_Id"> <summary> <para> <para>The IAM Identity Center ID of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.User_Id"> <summary> <para> <para>The IAM Identity Center ID of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.Portal_Id"> <summary> <para> <para>The ID of the portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.Project_Id"> <summary> <para> <para>The ID of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.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.IoTSiteWise.Model.UpdateAccessPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccessPolicyId parameter. The -PassThru parameter is deprecated, use -Select '^AccessPolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAccessPolicyCmdlet.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.IOTSW.UpdateIOTSWAssetCmdlet"> <summary> Updates an asset's name. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the <i>IoT SiteWise User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetCmdlet.AssetDescription"> <summary> <para> <para>A description for the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetCmdlet.AssetId"> <summary> <para> <para>The ID of the asset to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetCmdlet.AssetName"> <summary> <para> <para>A friendly name for the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.UpdateAssetResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.UpdateAssetResponse 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.IOTSW.UpdateIOTSWAssetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetId parameter. The -PassThru parameter is deprecated, use -Select '^AssetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetCmdlet.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.IOTSW.UpdateIOTSWAssetModelCmdlet"> <summary> Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the <i>IoT SiteWise User Guide</i>. <important><para> This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a>. </para><para> If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetModelCmdlet.AssetModelCompositeModel"> <summary> <para> <para>The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetModelCmdlet.AssetModelDescription"> <summary> <para> <para>A description for the asset model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetModelCmdlet.AssetModelHierarchy"> <summary> <para> <para>The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</para><para>You can specify up to 10 hierarchies per asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetModelCmdlet.AssetModelId"> <summary> <para> <para>The ID of the asset model to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetModelCmdlet.AssetModelName"> <summary> <para> <para>A unique, friendly name for the asset model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetModelCmdlet.AssetModelProperty"> <summary> <para> <para>The updated property definitions of the asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html">Asset properties</a> in the <i>IoT SiteWise User Guide</i>.</para><para>You can specify up to 200 properties per asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetModelCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetModelStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.UpdateAssetModelResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.UpdateAssetModelResponse 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.IOTSW.UpdateIOTSWAssetModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetModelId parameter. The -PassThru parameter is deprecated, use -Select '^AssetModelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetModelCmdlet.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.IOTSW.UpdateIOTSWAssetPropertyCmdlet"> <summary> Updates an asset property's alias and notification state. <important><para> This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html">DescribeAssetProperty</a>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetPropertyCmdlet.AssetId"> <summary> <para> <para>The ID of the asset to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetPropertyCmdlet.PropertyAlias"> <summary> <para> <para>The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.</para><para>If you omit this parameter, the alias is removed from the property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetPropertyCmdlet.PropertyId"> <summary> <para> <para>The ID of the asset property to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetPropertyCmdlet.PropertyNotificationState"> <summary> <para> <para>The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html">Interacting with other services</a> in the <i>IoT SiteWise User Guide</i>.</para><para>If you omit this parameter, the notification state is set to <code>DISABLED</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetPropertyCmdlet.PropertyUnit"> <summary> <para> <para>The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the <code>assetModelProperty</code> in the asset model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetPropertyCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetPropertyCmdlet.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.IoTSiteWise.Model.UpdateAssetPropertyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetPropertyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetId parameter. The -PassThru parameter is deprecated, use -Select '^AssetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWAssetPropertyCmdlet.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.IOTSW.UpdateIOTSWDashboardCmdlet"> <summary> Updates an IoT SiteWise Monitor dashboard. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWDashboardCmdlet.DashboardDefinition"> <summary> <para> <para>The new dashboard definition, as specified in a JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWDashboardCmdlet.DashboardDescription"> <summary> <para> <para>A new description for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWDashboardCmdlet.DashboardId"> <summary> <para> <para>The ID of the dashboard to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWDashboardCmdlet.DashboardName"> <summary> <para> <para>A new friendly name for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWDashboardCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWDashboardCmdlet.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.IoTSiteWise.Model.UpdateDashboardResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWDashboardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWDashboardCmdlet.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.IOTSW.UpdateIOTSWGatewayCmdlet"> <summary> Updates a gateway's name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCmdlet.GatewayId"> <summary> <para> <para>The ID of the gateway to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCmdlet.GatewayName"> <summary> <para> <para>A unique, friendly name for the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCmdlet.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.IoTSiteWise.Model.UpdateGatewayResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GatewayId parameter. The -PassThru parameter is deprecated, use -Select '^GatewayId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCmdlet.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.IOTSW.UpdateIOTSWGatewayCapabilityConfigurationCmdlet"> <summary> Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html">DescribeGateway</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCapabilityConfigurationCmdlet.CapabilityConfiguration"> <summary> <para> <para>The JSON document that defines the configuration for the gateway capability. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring data sources (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCapabilityConfigurationCmdlet.CapabilityNamespace"> <summary> <para> <para>The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as <code>1</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCapabilityConfigurationCmdlet.GatewayId"> <summary> <para> <para>The ID of the gateway to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCapabilityConfigurationCmdlet.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.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationResponse 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.IOTSW.UpdateIOTSWGatewayCapabilityConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GatewayId parameter. The -PassThru parameter is deprecated, use -Select '^GatewayId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWGatewayCapabilityConfigurationCmdlet.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.IOTSW.UpdateIOTSWPortalCmdlet"> <summary> Updates an IoT SiteWise Monitor portal. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.Alarms_AlarmRoleArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.File_Data"> <summary> <para> <para>The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.PortalLogoImage_Id"> <summary> <para> <para>The ID of an existing image. Specify this parameter to keep an existing image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.Alarms_NotificationLambdaArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Lambda function that manages alarm notifications. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">Managing alarm notifications</a> in the <i>IoT Events Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.NotificationSenderEmail"> <summary> <para> <para>The email address that sends alarm notifications.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.PortalContactEmail"> <summary> <para> <para>The Amazon Web Services administrator's contact email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.PortalDescription"> <summary> <para> <para>A new description for the portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.PortalId"> <summary> <para> <para>The ID of the portal to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.PortalName"> <summary> <para> <para>A new friendly name for the portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.RoleArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html">Using service roles for IoT SiteWise Monitor</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.File_Type"> <summary> <para> <para>The file type of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PortalStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.UpdatePortalResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.UpdatePortalResponse 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.IOTSW.UpdateIOTSWPortalCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PortalId parameter. The -PassThru parameter is deprecated, use -Select '^PortalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWPortalCmdlet.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.IOTSW.UpdateIOTSWProjectCmdlet"> <summary> Updates an IoT SiteWise Monitor project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWProjectCmdlet.ProjectDescription"> <summary> <para> <para>A new description for the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWProjectCmdlet.ProjectId"> <summary> <para> <para>The ID of the project to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWProjectCmdlet.ProjectName"> <summary> <para> <para>A new friendly name for the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWProjectCmdlet.ClientToken"> <summary> <para> <para>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWProjectCmdlet.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.IoTSiteWise.Model.UpdateProjectResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectId parameter. The -PassThru parameter is deprecated, use -Select '^ProjectId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.UpdateIOTSWProjectCmdlet.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.IOTSW.WriteIOTSWDefaultEncryptionConfigurationCmdlet"> <summary> Sets the default encryption configuration for the Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html">Key management</a> in the <i>IoT SiteWise User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWDefaultEncryptionConfigurationCmdlet.EncryptionType"> <summary> <para> <para>The type of encryption used for the encryption configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWDefaultEncryptionConfigurationCmdlet.KmsKeyId"> <summary> <para> <para>The Key ID of the customer managed key used for KMS encryption. This is required if you use <code>KMS_BASED_ENCRYPTION</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWDefaultEncryptionConfigurationCmdlet.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.IoTSiteWise.Model.PutDefaultEncryptionConfigurationResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.PutDefaultEncryptionConfigurationResponse 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.IOTSW.WriteIOTSWDefaultEncryptionConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EncryptionType parameter. The -PassThru parameter is deprecated, use -Select '^EncryptionType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWDefaultEncryptionConfigurationCmdlet.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.IOTSW.WriteIOTSWLoggingOptionCmdlet"> <summary> Sets logging options for IoT SiteWise. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWLoggingOptionCmdlet.LoggingOptions_Level"> <summary> <para> <para>The IoT SiteWise logging verbosity level.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWLoggingOptionCmdlet.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.IoTSiteWise.Model.PutLoggingOptionsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWLoggingOptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LoggingOptions_Level parameter. The -PassThru parameter is deprecated, use -Select '^LoggingOptions_Level' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWLoggingOptionCmdlet.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.IOTSW.WriteIOTSWStorageConfigurationCmdlet"> <summary> Configures storage settings for IoT SiteWise. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWStorageConfigurationCmdlet.DisassociatedDataStorage"> <summary> <para> <para>Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The <code>disassociatedDataStorage</code> can be one of the following values:</para><ul><li><para><code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</para><important><para>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</para></important></li><li><para><code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a> in the <i>IoT SiteWise User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWStorageConfigurationCmdlet.RetentionPeriod_NumberOfDay"> <summary> <para> <para>The number of days that your data is kept.</para><note><para>If you specified a value for this parameter, the <code>unlimited</code> parameter must be <code>false</code>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWStorageConfigurationCmdlet.CustomerManagedS3Storage_RoleArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWStorageConfigurationCmdlet.CustomerManagedS3Storage_S3ResourceArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html">Amazon S3 resources</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWStorageConfigurationCmdlet.StorageType"> <summary> <para> <para>The storage tier that you specified for your data. The <code>storageType</code> parameter can be one of the following values:</para><ul><li><para><code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.</para></li><li><para><code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWStorageConfigurationCmdlet.RetentionPeriod_Unlimited"> <summary> <para> <para>If true, your data is kept indefinitely.</para><note><para>If configured to <code>true</code>, you must not specify a value for the <code>numberOfDays</code> parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWStorageConfigurationCmdlet.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.IoTSiteWise.Model.PutStorageConfigurationResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.PutStorageConfigurationResponse 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.IOTSW.WriteIOTSWStorageConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StorageType parameter. The -PassThru parameter is deprecated, use -Select '^StorageType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTSW.WriteIOTSWStorageConfigurationCmdlet.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> |