AWS.Tools.AugmentedAIRuntime.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.AugmentedAIRuntime</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.A2IR.GetA2IRHumanLoopCmdlet">
            <summary>
            Returns information about the specified human loop.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.GetA2IRHumanLoopCmdlet.HumanLoopName">
            <summary>
            <para>
            <para>The name of the human loop.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.GetA2IRHumanLoopCmdlet.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.AugmentedAIRuntime.Model.DescribeHumanLoopResponse).
            Specifying the name of a property of type Amazon.AugmentedAIRuntime.Model.DescribeHumanLoopResponse 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.A2IR.GetA2IRHumanLoopCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the HumanLoopName parameter.
            The -PassThru parameter is deprecated, use -Select '^HumanLoopName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.A2IR.GetA2IRHumanLoopListCmdlet">
            <summary>
            Returns information about human loops, given the specified parameters.<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.A2IR.GetA2IRHumanLoopListCmdlet.CreationTimeAfter">
            <summary>
            <para>
            <para>(Optional) The timestamp of the date when you want the human loops to begin. For example,
            <code>1551000000</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.GetA2IRHumanLoopListCmdlet.CreationTimeBefore">
            <summary>
            <para>
            <para>(Optional) The timestamp of the date before which you want the human loops to begin.
            For example, <code>1550000000</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.GetA2IRHumanLoopListCmdlet.SortOrder">
            <summary>
            <para>
            <para>An optional value that specifies whether you want the results sorted in <code>Ascending</code>
            or <code>Descending</code> order.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.GetA2IRHumanLoopListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The total number of items to return. If the total number of available items is more
            than the value specified in <code>MaxResults</code>, then a <code>NextToken</code>
            will be provided in the output that you can use to resume pagination.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.GetA2IRHumanLoopListCmdlet.NextToken">
            <summary>
            <para>
            <para>A token to resume pagination.</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.A2IR.GetA2IRHumanLoopListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'HumanLoopSummaries'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AugmentedAIRuntime.Model.ListHumanLoopsResponse).
            Specifying the name of a property of type Amazon.AugmentedAIRuntime.Model.ListHumanLoopsResponse 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.A2IR.GetA2IRHumanLoopListCmdlet.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.A2IR.RemoveA2IRHumanLoopCmdlet">
            <summary>
            Deletes the specified human loop for a flow definition.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.RemoveA2IRHumanLoopCmdlet.HumanLoopName">
            <summary>
            <para>
            <para>The name of the human loop you want to delete.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.RemoveA2IRHumanLoopCmdlet.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.AugmentedAIRuntime.Model.DeleteHumanLoopResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.RemoveA2IRHumanLoopCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the HumanLoopName parameter.
            The -PassThru parameter is deprecated, use -Select '^HumanLoopName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.RemoveA2IRHumanLoopCmdlet.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.A2IR.StartA2IRHumanLoopCmdlet">
            <summary>
            Starts a human loop, provided that at least one activation condition is met.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StartA2IRHumanLoopCmdlet.DataAttributes_ContentClassifier">
            <summary>
            <para>
            <para>Declares that your content is free of personally identifiable information or adult
            content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can
            view your task based on this information.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StartA2IRHumanLoopCmdlet.FlowDefinitionArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the flow definition.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StartA2IRHumanLoopCmdlet.HumanLoopName">
            <summary>
            <para>
            <para>The name of the human loop.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StartA2IRHumanLoopCmdlet.HumanLoopInput_InputContent">
            <summary>
            <para>
            <para>Serialized input from the human loop.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StartA2IRHumanLoopCmdlet.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.AugmentedAIRuntime.Model.StartHumanLoopResponse).
            Specifying the name of a property of type Amazon.AugmentedAIRuntime.Model.StartHumanLoopResponse 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.A2IR.StartA2IRHumanLoopCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the HumanLoopName parameter.
            The -PassThru parameter is deprecated, use -Select '^HumanLoopName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StartA2IRHumanLoopCmdlet.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.A2IR.StopA2IRHumanLoopCmdlet">
            <summary>
            Stops the specified human loop.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StopA2IRHumanLoopCmdlet.HumanLoopName">
            <summary>
            <para>
            <para>The name of the human loop you want to stop.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StopA2IRHumanLoopCmdlet.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.AugmentedAIRuntime.Model.StopHumanLoopResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StopA2IRHumanLoopCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the HumanLoopName parameter.
            The -PassThru parameter is deprecated, use -Select '^HumanLoopName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.A2IR.StopA2IRHumanLoopCmdlet.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>