AWS.Tools.NovaAct.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.NovaAct</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAActListCmdlet"> <summary> Lists all acts within a specific session with their current status and execution details.<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.NOVA.GetNOVAActListCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the session to list acts for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAActListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the returned acts (ascending or descending).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAActListCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition containing the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAActListCmdlet.WorkflowRunId"> <summary> <para> <para>The unique identifier of the workflow run containing the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAActListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of acts to return in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAActListCmdlet.NextToken"> <summary> <para> <para>The token for retrieving the next page 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.NOVA.GetNOVAActListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ActSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NovaAct.Model.ListActsResponse). Specifying the name of a property of type Amazon.NovaAct.Model.ListActsResponse 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.NOVA.GetNOVAActListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkflowDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^WorkflowDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAActListCmdlet.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.NOVA.GetNOVAModelListCmdlet"> <summary> Lists all available AI models that can be used for workflow execution, including their status and compatibility information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAModelListCmdlet.ClientCompatibilityVersion"> <summary> <para> <para>The client compatibility version to filter models by compatibility.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAModelListCmdlet.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.NovaAct.Model.ListModelsResponse). Specifying the name of a property of type Amazon.NovaAct.Model.ListModelsResponse 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.NOVA.GetNOVAModelListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClientCompatibilityVersion parameter. The -PassThru parameter is deprecated, use -Select '^ClientCompatibilityVersion' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NOVA.GetNOVASessionListCmdlet"> <summary> Lists all sessions within a specific workflow run.<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.NOVA.GetNOVASessionListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the returned sessions (ascending or descending).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVASessionListCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition containing the workflow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVASessionListCmdlet.WorkflowRunId"> <summary> <para> <para>The unique identifier of the workflow run to list sessions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVASessionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of sessions to return in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVASessionListCmdlet.NextToken"> <summary> <para> <para>The token for retrieving the next page 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.NOVA.GetNOVASessionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SessionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NovaAct.Model.ListSessionsResponse). Specifying the name of a property of type Amazon.NovaAct.Model.ListSessionsResponse 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.NOVA.GetNOVASessionListCmdlet.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.NOVA.GetNOVAWorkflowDefinitionCmdlet"> <summary> Retrieves the details and configuration of a specific workflow definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowDefinitionCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowDefinitionCmdlet.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.NovaAct.Model.GetWorkflowDefinitionResponse). Specifying the name of a property of type Amazon.NovaAct.Model.GetWorkflowDefinitionResponse 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.NOVA.GetNOVAWorkflowDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkflowDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^WorkflowDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowDefinitionListCmdlet"> <summary> Lists all workflow definitions in your account with optional filtering and pagination.<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.NOVA.GetNOVAWorkflowDefinitionListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the returned workflow definitions (ascending or descending).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of workflow definitions to return in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowDefinitionListCmdlet.NextToken"> <summary> <para> <para>The token for retrieving the next page 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.NOVA.GetNOVAWorkflowDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkflowDefinitionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NovaAct.Model.ListWorkflowDefinitionsResponse). Specifying the name of a property of type Amazon.NovaAct.Model.ListWorkflowDefinitionsResponse 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.NOVA.GetNOVAWorkflowDefinitionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SortOrder parameter. The -PassThru parameter is deprecated, use -Select '^SortOrder' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowDefinitionListCmdlet.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.NOVA.GetNOVAWorkflowRunCmdlet"> <summary> Retrieves the current state, configuration, and execution details of a workflow run. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowRunCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition containing the workflow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowRunCmdlet.WorkflowRunId"> <summary> <para> <para>The unique identifier of the workflow run to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowRunCmdlet.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.NovaAct.Model.GetWorkflowRunResponse). Specifying the name of a property of type Amazon.NovaAct.Model.GetWorkflowRunResponse 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.NOVA.GetNOVAWorkflowRunListCmdlet"> <summary> Lists all workflow runs for a specific workflow definition with optional filtering and pagination.<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.NOVA.GetNOVAWorkflowRunListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the returned workflow runs (ascending or descending).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowRunListCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition to list workflow runs for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowRunListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of workflow runs to return in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowRunListCmdlet.NextToken"> <summary> <para> <para>The token for retrieving the next page 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.NOVA.GetNOVAWorkflowRunListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkflowRunSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NovaAct.Model.ListWorkflowRunsResponse). Specifying the name of a property of type Amazon.NovaAct.Model.ListWorkflowRunsResponse 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.NOVA.GetNOVAWorkflowRunListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkflowDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^WorkflowDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.GetNOVAWorkflowRunListCmdlet.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.NOVA.InvokeNOVAActStepCmdlet"> <summary> Executes the next step of an act, processing tool call results and returning new tool calls if needed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.InvokeNOVAActStepCmdlet.ActId"> <summary> <para> <para>The unique identifier of the act to invoke the next step for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.InvokeNOVAActStepCmdlet.CallResult"> <summary> <para> <para>The results from previous tool calls that the act requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.InvokeNOVAActStepCmdlet.PreviousStepId"> <summary> <para> <para>The identifier of the previous step, used for tracking execution flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.InvokeNOVAActStepCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the session containing the act.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.InvokeNOVAActStepCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition containing the act.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.InvokeNOVAActStepCmdlet.WorkflowRunId"> <summary> <para> <para>The unique identifier of the workflow run containing the act.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.InvokeNOVAActStepCmdlet.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.NovaAct.Model.InvokeActStepResponse). Specifying the name of a property of type Amazon.NovaAct.Model.InvokeActStepResponse 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.NOVA.InvokeNOVAActStepCmdlet.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.NOVA.NewNOVAActCmdlet"> <summary> Creates a new AI task (act) within a session that can interact with tools and perform specific actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAActCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the session to create the act in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAActCmdlet.Task"> <summary> <para> <para>The task description that defines what the act should accomplish.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAActCmdlet.ToolSpec"> <summary> <para> <para>A list of tool specifications that the act can invoke to complete its task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAActCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition containing the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAActCmdlet.WorkflowRunId"> <summary> <para> <para>The unique identifier of the workflow run containing the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAActCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAActCmdlet.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.NovaAct.Model.CreateActResponse). Specifying the name of a property of type Amazon.NovaAct.Model.CreateActResponse 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.NOVA.NewNOVAActCmdlet.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.NOVA.NewNOVASessionCmdlet"> <summary> Creates a new session context within a workflow run to manage conversation state and acts. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVASessionCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition containing the workflow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVASessionCmdlet.WorkflowRunId"> <summary> <para> <para>The unique identifier of the workflow run to create the session in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVASessionCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVASessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SessionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NovaAct.Model.CreateSessionResponse). Specifying the name of a property of type Amazon.NovaAct.Model.CreateSessionResponse 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.NOVA.NewNOVASessionCmdlet.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.NOVA.NewNOVAWorkflowDefinitionCmdlet"> <summary> Creates a new workflow definition template that can be used to execute multiple workflow runs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowDefinitionCmdlet.Description"> <summary> <para> <para>An optional description of the workflow definition's purpose and functionality.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowDefinitionCmdlet.Name"> <summary> <para> <para>The name of the workflow definition. Must be unique within your account and region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowDefinitionCmdlet.ExportConfig_S3BucketName"> <summary> <para> <para>The name of your Amazon S3 bucket, that Nova Act uses to export your workflow data. Note that the IAM role used to access Nova Act must also have write permissions to this bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowDefinitionCmdlet.ExportConfig_S3KeyPrefix"> <summary> <para> <para>An optional prefix for Amazon S3 object keys to organize exported data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowDefinitionCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NovaAct.Model.CreateWorkflowDefinitionResponse). Specifying the name of a property of type Amazon.NovaAct.Model.CreateWorkflowDefinitionResponse 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.NOVA.NewNOVAWorkflowDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowDefinitionCmdlet.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.NOVA.NewNOVAWorkflowRunCmdlet"> <summary> Creates a new execution instance of a workflow definition with specified parameters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowRunCmdlet.ClientInfo_CompatibilityVersion"> <summary> <para> <para>The compatibility version of the client, used to ensure API compatibility.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowRunCmdlet.LogGroupName"> <summary> <para> <para>The CloudWatch log group name for storing workflow execution logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowRunCmdlet.ModelId"> <summary> <para> <para>The ID of the AI model to use for workflow execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowRunCmdlet.ClientInfo_SdkVersion"> <summary> <para> <para>The version of the SDK being used by the client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowRunCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition to execute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowRunCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.NewNOVAWorkflowRunCmdlet.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.NovaAct.Model.CreateWorkflowRunResponse). Specifying the name of a property of type Amazon.NovaAct.Model.CreateWorkflowRunResponse 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.NOVA.NewNOVAWorkflowRunCmdlet.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.NOVA.RemoveNOVAWorkflowDefinitionCmdlet"> <summary> Deletes a workflow definition and all associated resources. This operation cannot be undone. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.RemoveNOVAWorkflowDefinitionCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.RemoveNOVAWorkflowDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NovaAct.Model.DeleteWorkflowDefinitionResponse). Specifying the name of a property of type Amazon.NovaAct.Model.DeleteWorkflowDefinitionResponse 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.NOVA.RemoveNOVAWorkflowDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkflowDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^WorkflowDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.RemoveNOVAWorkflowDefinitionCmdlet.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.NOVA.RemoveNOVAWorkflowRunCmdlet"> <summary> Terminates and cleans up a workflow run, stopping all associated acts and sessions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.RemoveNOVAWorkflowRunCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition containing the workflow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.RemoveNOVAWorkflowRunCmdlet.WorkflowRunId"> <summary> <para> <para>The unique identifier of the workflow run to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.RemoveNOVAWorkflowRunCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NovaAct.Model.DeleteWorkflowRunResponse). Specifying the name of a property of type Amazon.NovaAct.Model.DeleteWorkflowRunResponse 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.NOVA.RemoveNOVAWorkflowRunCmdlet.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.NOVA.UpdateNOVAActCmdlet"> <summary> Updates an existing act's configuration, status, or error information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAActCmdlet.ActId"> <summary> <para> <para>The unique identifier of the act to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAActCmdlet.Error_Message"> <summary> <para> <para>A human-readable description of the error that occurred.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAActCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the session containing the act.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAActCmdlet.Status"> <summary> <para> <para>The new status to set for the act.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAActCmdlet.Error_Type"> <summary> <para> <para>The type or category of error that occurred.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAActCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition containing the act.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAActCmdlet.WorkflowRunId"> <summary> <para> <para>The unique identifier of the workflow run containing the act.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAActCmdlet.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.NovaAct.Model.UpdateActResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAActCmdlet.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.NOVA.UpdateNOVAWorkflowRunCmdlet"> <summary> Updates the configuration or state of an active workflow run. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAWorkflowRunCmdlet.Status"> <summary> <para> <para>The new status to set for the workflow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAWorkflowRunCmdlet.WorkflowDefinitionName"> <summary> <para> <para>The name of the workflow definition containing the workflow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAWorkflowRunCmdlet.WorkflowRunId"> <summary> <para> <para>The unique identifier of the workflow run to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAWorkflowRunCmdlet.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.NovaAct.Model.UpdateWorkflowRunResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NOVA.UpdateNOVAWorkflowRunCmdlet.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> |