AWS.Tools.IoTDeviceAdvisor.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IoTDeviceAdvisor</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IOTDA.AddIOTDAResourceTagCmdlet"> <summary> Adds to and modifies existing tags of an IoT Device Advisor resource. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TagResource</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.AddIOTDAResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.AddIOTDAResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to be attached to the IoT Device Advisor resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.AddIOTDAResourceTagCmdlet.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.IoTDeviceAdvisor.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.AddIOTDAResourceTagCmdlet.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.IOTDA.AddIOTDAResourceTagCmdlet.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.IOTDA.GetIOTDAEndpointCmdlet"> <summary> Gets information about an Device Advisor endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDAEndpointCmdlet.AuthenticationMethod"> <summary> <para> <para>The authentication method used during the device connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDAEndpointCmdlet.CertificateArn"> <summary> <para> <para>The certificate ARN of the device. This is an optional parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDAEndpointCmdlet.DeviceRoleArn"> <summary> <para> <para>The device role ARN of the device. This is an optional parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDAEndpointCmdlet.ThingArn"> <summary> <para> <para>The thing ARN of the device. This is an optional parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDAEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTDeviceAdvisor.Model.GetEndpointResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.Model.GetEndpointResponse 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.IOTDA.GetIOTDAResourceTagCmdlet"> <summary> Lists the tags attached to an IoT Device Advisor resource. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListTagsForResource</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDAResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDAResourceTagCmdlet.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.IoTDeviceAdvisor.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.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.IOTDA.GetIOTDAResourceTagCmdlet.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.IOTDA.GetIOTDASuiteDefinitionCmdlet"> <summary> Gets information about a Device Advisor test suite. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetSuiteDefinition</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteDefinitionCmdlet.SuiteDefinitionId"> <summary> <para> <para>Suite definition ID of the test suite to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteDefinitionCmdlet.SuiteDefinitionVersion"> <summary> <para> <para>Suite definition version of the test suite to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteDefinitionCmdlet.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.IoTDeviceAdvisor.Model.GetSuiteDefinitionResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.Model.GetSuiteDefinitionResponse 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.IOTDA.GetIOTDASuiteDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SuiteDefinitionId parameter. The -PassThru parameter is deprecated, use -Select '^SuiteDefinitionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteDefinitionListCmdlet"> <summary> Lists the Device Advisor test suites you have created. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSuiteDefinitions</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteDefinitionListCmdlet.NextToken"> <summary> <para> <para>A token used to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SuiteDefinitionInformationList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTDeviceAdvisor.Model.ListSuiteDefinitionsResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.Model.ListSuiteDefinitionsResponse 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.IOTDA.GetIOTDASuiteRunCmdlet"> <summary> Gets information about a Device Advisor test suite run. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetSuiteRun</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunCmdlet.SuiteDefinitionId"> <summary> <para> <para>Suite definition ID for the test suite run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunCmdlet.SuiteRunId"> <summary> <para> <para>Suite run ID for the test suite run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunCmdlet.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.IoTDeviceAdvisor.Model.GetSuiteRunResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.Model.GetSuiteRunResponse 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.IOTDA.GetIOTDASuiteRunCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SuiteDefinitionId parameter. The -PassThru parameter is deprecated, use -Select '^SuiteDefinitionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunListCmdlet"> <summary> Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSuiteRuns</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunListCmdlet.SuiteDefinitionId"> <summary> <para> <para>Lists the test suite runs of the specified test suite based on suite definition ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunListCmdlet.SuiteDefinitionVersion"> <summary> <para> <para>Must be passed along with <c>suiteDefinitionId</c>. Lists the test suite runs of the specified test suite based on suite definition version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunListCmdlet.NextToken"> <summary> <para> <para>A token to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SuiteRunsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTDeviceAdvisor.Model.ListSuiteRunsResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.Model.ListSuiteRunsResponse 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.IOTDA.GetIOTDASuiteRunListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SuiteDefinitionId parameter. The -PassThru parameter is deprecated, use -Select '^SuiteDefinitionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunReportCmdlet"> <summary> Gets a report download link for a successful Device Advisor qualifying test suite run. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetSuiteRunReport</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunReportCmdlet.SuiteDefinitionId"> <summary> <para> <para>Suite definition ID of the test suite.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunReportCmdlet.SuiteRunId"> <summary> <para> <para>Suite run ID of the test suite run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.GetIOTDASuiteRunReportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QualificationReportDownloadUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTDeviceAdvisor.Model.GetSuiteRunReportResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.Model.GetSuiteRunReportResponse 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.IOTDA.GetIOTDASuiteRunReportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SuiteRunId parameter. The -PassThru parameter is deprecated, use -Select '^SuiteRunId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet"> <summary> Creates a Device Advisor test suite. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateSuiteDefinition</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_DevicePermissionRoleArn"> <summary> <para> <para>Gets the device permission ARN. This is a required parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_Device"> <summary> <para> <para>Gets the devices configured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_IntendedForQualification"> <summary> <para> <para>Gets the tests intended for qualification in a suite.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_IsLongDurationTest"> <summary> <para> <para>Verifies if the test suite is a long duration test.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_Protocol"> <summary> <para> <para>Sets the MQTT protocol that is configured in the suite definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_RootGroup"> <summary> <para> <para>Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if <c>intendedForQualification</c> is set to true, <c>rootGroup</c> can be an empty string. If <c>intendedForQualification</c> is false, <c>rootGroup</c> cannot be an empty string. If <c>rootGroup</c> is empty, and <c>intendedForQualification</c> is set to true, all the qualification tests are included, and the configuration is default.</para><para> For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_SuiteDefinitionName"> <summary> <para> <para>Gets the suite definition name. This is a required parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet.Tag"> <summary> <para> <para>The tags to be attached to the suite definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.NewIOTDASuiteDefinitionCmdlet.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.IoTDeviceAdvisor.Model.CreateSuiteDefinitionResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.Model.CreateSuiteDefinitionResponse 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.IOTDA.NewIOTDASuiteDefinitionCmdlet.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.IOTDA.RemoveIOTDAResourceTagCmdlet"> <summary> Removes tags from an IoT Device Advisor resource. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UntagResource</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.RemoveIOTDAResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.RemoveIOTDAResourceTagCmdlet.TagKey"> <summary> <para> <para>List of tag keys to remove from the IoT Device Advisor resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.RemoveIOTDAResourceTagCmdlet.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.IoTDeviceAdvisor.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.RemoveIOTDAResourceTagCmdlet.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.IOTDA.RemoveIOTDAResourceTagCmdlet.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.IOTDA.RemoveIOTDASuiteDefinitionCmdlet"> <summary> Deletes a Device Advisor test suite. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteSuiteDefinition</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.RemoveIOTDASuiteDefinitionCmdlet.SuiteDefinitionId"> <summary> <para> <para>Suite definition ID of the test suite to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.RemoveIOTDASuiteDefinitionCmdlet.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.IoTDeviceAdvisor.Model.DeleteSuiteDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.RemoveIOTDASuiteDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SuiteDefinitionId parameter. The -PassThru parameter is deprecated, use -Select '^SuiteDefinitionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.RemoveIOTDASuiteDefinitionCmdlet.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.IOTDA.StartIOTDASuiteRunCmdlet"> <summary> Starts a Device Advisor test suite run. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartSuiteRun</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.PrimaryDevice_CertificateArn"> <summary> <para> <para>Lists device's certificate ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.PrimaryDevice_DeviceRoleArn"> <summary> <para> <para>Lists device's role ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.SuiteRunConfiguration_ParallelRun"> <summary> <para> <para>TRUE if multiple test suites run in parallel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.SuiteRunConfiguration_SelectedTestList"> <summary> <para> <para>Sets test case list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.SuiteDefinitionId"> <summary> <para> <para>Suite definition ID of the test suite.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.SuiteDefinitionVersion"> <summary> <para> <para>Suite definition version of the test suite.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.Tag"> <summary> <para> <para>The tags to be attached to the suite run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.PrimaryDevice_ThingArn"> <summary> <para> <para>Lists device's thing ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.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.IoTDeviceAdvisor.Model.StartSuiteRunResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.Model.StartSuiteRunResponse 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.IOTDA.StartIOTDASuiteRunCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SuiteDefinitionId parameter. The -PassThru parameter is deprecated, use -Select '^SuiteDefinitionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StartIOTDASuiteRunCmdlet.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.IOTDA.StopIOTDASuiteRunCmdlet"> <summary> Stops a Device Advisor test suite run that is currently running. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StopSuiteRun</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StopIOTDASuiteRunCmdlet.SuiteDefinitionId"> <summary> <para> <para>Suite definition ID of the test suite run to be stopped.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StopIOTDASuiteRunCmdlet.SuiteRunId"> <summary> <para> <para>Suite run ID of the test suite run to be stopped.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StopIOTDASuiteRunCmdlet.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.IoTDeviceAdvisor.Model.StopSuiteRunResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StopIOTDASuiteRunCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SuiteRunId parameter. The -PassThru parameter is deprecated, use -Select '^SuiteRunId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.StopIOTDASuiteRunCmdlet.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.IOTDA.UpdateIOTDASuiteDefinitionCmdlet"> <summary> Updates a Device Advisor test suite. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateSuiteDefinition</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_DevicePermissionRoleArn"> <summary> <para> <para>Gets the device permission ARN. This is a required parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_Device"> <summary> <para> <para>Gets the devices configured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_IntendedForQualification"> <summary> <para> <para>Gets the tests intended for qualification in a suite.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_IsLongDurationTest"> <summary> <para> <para>Verifies if the test suite is a long duration test.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_Protocol"> <summary> <para> <para>Sets the MQTT protocol that is configured in the suite definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_RootGroup"> <summary> <para> <para>Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if <c>intendedForQualification</c> is set to true, <c>rootGroup</c> can be an empty string. If <c>intendedForQualification</c> is false, <c>rootGroup</c> cannot be an empty string. If <c>rootGroup</c> is empty, and <c>intendedForQualification</c> is set to true, all the qualification tests are included, and the configuration is default.</para><para> For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.SuiteDefinitionId"> <summary> <para> <para>Suite definition ID of the test suite to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.SuiteDefinitionConfiguration_SuiteDefinitionName"> <summary> <para> <para>Gets the suite definition name. This is a required parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.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.IoTDeviceAdvisor.Model.UpdateSuiteDefinitionResponse). Specifying the name of a property of type Amazon.IoTDeviceAdvisor.Model.UpdateSuiteDefinitionResponse 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.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SuiteDefinitionId parameter. The -PassThru parameter is deprecated, use -Select '^SuiteDefinitionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTDA.UpdateIOTDASuiteDefinitionCmdlet.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> |