AWS.Tools.IoTFleetHub.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IoTFleetHub</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IOTFH.AddIOTFHResourceTagCmdlet"> <summary> Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.AddIOTFHResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.AddIOTFHResourceTagCmdlet.Tag"> <summary> <para> <para>The new or modified tags for the resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.AddIOTFHResourceTagCmdlet.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.IoTFleetHub.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.AddIOTFHResourceTagCmdlet.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.IOTFH.GetIOTFHApplicationCmdlet"> <summary> Gets information about a Fleet Hub for IoT Device Management web application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.GetIOTFHApplicationCmdlet.ApplicationId"> <summary> <para> <para>The unique Id of the web application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.GetIOTFHApplicationCmdlet.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.IoTFleetHub.Model.DescribeApplicationResponse). Specifying the name of a property of type Amazon.IoTFleetHub.Model.DescribeApplicationResponse 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.IOTFH.GetIOTFHApplicationListCmdlet"> <summary> Gets a list of Fleet Hub for IoT Device Management web applications for the current account.<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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.GetIOTFHApplicationListCmdlet.NextToken"> <summary> <para> <para>A token used to get the next set of 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.GetIOTFHApplicationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTFleetHub.Model.ListApplicationsResponse). Specifying the name of a property of type Amazon.IoTFleetHub.Model.ListApplicationsResponse 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.IOTFH.GetIOTFHApplicationListCmdlet.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. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTFH.GetIOTFHResourceTagCmdlet"> <summary> Lists the tags for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.GetIOTFHResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.GetIOTFHResourceTagCmdlet.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.IoTFleetHub.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.IoTFleetHub.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTFH.NewIOTFHApplicationCmdlet"> <summary> Creates a Fleet Hub for IoT Device Management web application. <para> When creating a Fleet Hub application, you must create an organization instance of IAM Identity Center if you don't already have one. The Fleet Hub application you create must also be in the same Amazon Web Services Region of the organization instance of IAM Identity Center. For more information see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/get-set-up-for-idc.html">Enabling IAM Identity Center</a> and <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/organization-instances-identity-center.html">Organization instances of IAM Identity Center</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.NewIOTFHApplicationCmdlet.ApplicationDescription"> <summary> <para> <para>An optional description of the web application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.NewIOTFHApplicationCmdlet.ApplicationName"> <summary> <para> <para>The name of the web application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.NewIOTFHApplicationCmdlet.RoleArn"> <summary> <para> <para>The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.</para><note><para>The name of the role must be in the form <c>AWSIotFleetHub_<i>random_string</i></c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.NewIOTFHApplicationCmdlet.Tag"> <summary> <para> <para>A set of key/value pairs that you can use to manage the web application resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.NewIOTFHApplicationCmdlet.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.IOTFH.NewIOTFHApplicationCmdlet.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.IoTFleetHub.Model.CreateApplicationResponse). Specifying the name of a property of type Amazon.IoTFleetHub.Model.CreateApplicationResponse 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.IOTFH.NewIOTFHApplicationCmdlet.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.IOTFH.RemoveIOTFHApplicationCmdlet"> <summary> Deletes a Fleet Hub for IoT Device Management web application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.RemoveIOTFHApplicationCmdlet.ApplicationId"> <summary> <para> <para>The unique Id of the web application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.RemoveIOTFHApplicationCmdlet.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.IOTFH.RemoveIOTFHApplicationCmdlet.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.IoTFleetHub.Model.DeleteApplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.RemoveIOTFHApplicationCmdlet.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.IOTFH.RemoveIOTFHResourceTagCmdlet"> <summary> Removes the specified tags (metadata) from the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.RemoveIOTFHResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.RemoveIOTFHResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of the keys of the tags to be removed from the resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.RemoveIOTFHResourceTagCmdlet.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.IoTFleetHub.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.RemoveIOTFHResourceTagCmdlet.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.IOTFH.UpdateIOTFHApplicationCmdlet"> <summary> Updates information about a Fleet Hub for IoT Device Management web application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.UpdateIOTFHApplicationCmdlet.ApplicationDescription"> <summary> <para> <para>An optional description of the web application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.UpdateIOTFHApplicationCmdlet.ApplicationId"> <summary> <para> <para>The unique Id of the web application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.UpdateIOTFHApplicationCmdlet.ApplicationName"> <summary> <para> <para>The name of the web application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.UpdateIOTFHApplicationCmdlet.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.IOTFH.UpdateIOTFHApplicationCmdlet.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.IoTFleetHub.Model.UpdateApplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTFH.UpdateIOTFHApplicationCmdlet.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> |