AWS.Tools.StepFunctions.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.StepFunctions</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SFN.AddSFNResourceTagCmdlet"> <summary> Add a tag to a Step Functions resource. <para> An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM Tags</a>. </para><para> Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.AddSFNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.AddSFNResourceTagCmdlet.Tag"> <summary> <para> <para>The list of tags to add to a resource.</para><para>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.AddSFNResourceTagCmdlet.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.StepFunctions.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.AddSFNResourceTagCmdlet.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.SFN.AddSFNResourceTagCmdlet.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.SFN.GetSFNActivityCmdlet"> <summary> Describes an activity. <note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNActivityCmdlet.ActivityArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the activity to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNActivityCmdlet.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.StepFunctions.Model.DescribeActivityResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.DescribeActivityResponse 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.SFN.GetSFNActivityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ActivityArn parameter. The -PassThru parameter is deprecated, use -Select '^ActivityArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNActivityListCmdlet"> <summary> Lists the existing activities. <para> If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error. </para><note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note><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.SFN.GetSFNActivityListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</para><para>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNActivityListCmdlet.NextToken"> <summary> <para> <para>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</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.SFN.GetSFNActivityListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Activities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.ListActivitiesResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.ListActivitiesResponse 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.SFN.GetSFNActivityListCmdlet.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.SFN.GetSFNActivityTaskCmdlet"> <summary> Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a <code>taskToken</code> with a null string. <note><para> This API action isn't logged in CloudTrail. </para></note><important><para> Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). </para><para> Polling with <code>GetActivityTask</code> can cause latency in some implementations. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html">Avoid Latency When Polling for Activity Tasks</a> in the Step Functions Developer Guide. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNActivityTaskCmdlet.ActivityArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using <a>CreateActivity</a>.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNActivityTaskCmdlet.WorkerName"> <summary> <para> <para>You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNActivityTaskCmdlet.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.StepFunctions.Model.GetActivityTaskResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.GetActivityTaskResponse 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.SFN.GetSFNActivityTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ActivityArn parameter. The -PassThru parameter is deprecated, use -Select '^ActivityArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionCmdlet"> <summary> Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run. <note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note><para> This API action is not supported by <code>EXPRESS</code> state machine executions unless they were dispatched by a Map Run. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionCmdlet.ExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the execution to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionCmdlet.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.StepFunctions.Model.DescribeExecutionResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.DescribeExecutionResponse 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.SFN.GetSFNExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^ExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionHistoryCmdlet"> <summary> Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the <code>timeStamp</code> of the events. Use the <code>reverseOrder</code> parameter to get the latest events first. <para> If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error. </para><para> This API action is not supported by <code>EXPRESS</code> state machines. </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.SFN.GetSFNExecutionHistoryCmdlet.ExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionHistoryCmdlet.IncludeExecutionData"> <summary> <para> <para>You can select whether execution data (input or output of a history event) is returned. The default is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionHistoryCmdlet.ReverseOrder"> <summary> <para> <para>Lists events in descending order of their <code>timeStamp</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionHistoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</para><para>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionHistoryCmdlet.NextToken"> <summary> <para> <para>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</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.SFN.GetSFNExecutionHistoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.GetExecutionHistoryResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.GetExecutionHistoryResponse 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.SFN.GetSFNExecutionHistoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^ExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionHistoryCmdlet.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.SFN.GetSFNExecutionListCmdlet"> <summary> Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. <para> Results are sorted by time, with the most recent execution first. </para><para> If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error. </para><note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note><para> This API action is not supported by <code>EXPRESS</code> state machines. </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.SFN.GetSFNExecutionListCmdlet.MapRunArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the <code>mapRunArn</code> field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.</para><para>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionListCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</para><para>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionListCmdlet.StatusFilter"> <summary> <para> <para>If specified, only list the executions whose current execution status matches the given filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</para><para>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionListCmdlet.NextToken"> <summary> <para> <para>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</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.SFN.GetSFNExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Executions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.ListExecutionsResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.ListExecutionsResponse 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.SFN.GetSFNExecutionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StateMachineArn parameter. The -PassThru parameter is deprecated, use -Select '^StateMachineArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionListCmdlet.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.SFN.GetSFNMapRunCmdlet"> <summary> Provides information about a Map Run's configuration, progress, and results. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNMapRunCmdlet.MapRunArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies a Map Run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNMapRunCmdlet.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.StepFunctions.Model.DescribeMapRunResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.DescribeMapRunResponse 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.SFN.GetSFNMapRunCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MapRunArn parameter. The -PassThru parameter is deprecated, use -Select '^MapRunArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNMapRunListCmdlet"> <summary> Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call <code>DescribeMapRun</code> to obtain more information, if needed.<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.SFN.GetSFNMapRunListCmdlet.ExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNMapRunListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</para><para>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNMapRunListCmdlet.NextToken"> <summary> <para> <para>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</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.SFN.GetSFNMapRunListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MapRuns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.ListMapRunsResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.ListMapRunsResponse 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.SFN.GetSFNMapRunListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^ExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNMapRunListCmdlet.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.SFN.GetSFNResourceTagCmdlet"> <summary> List tags for a given resource. <para> Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNResourceTagCmdlet.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.StepFunctions.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.StepFunctions.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.SFN.GetSFNResourceTagCmdlet.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.SFN.GetSFNStateMachineCmdlet"> <summary> Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the <code>Map</code> state's label. <para> A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>. </para><note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineCmdlet.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.StepFunctions.Model.DescribeStateMachineResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.DescribeStateMachineResponse 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.SFN.GetSFNStateMachineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StateMachineArn parameter. The -PassThru parameter is deprecated, use -Select '^StateMachineArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineForExecutionCmdlet"> <summary> Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run. <note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note><para> This API action is not supported by <code>EXPRESS</code> state machines. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineForExecutionCmdlet.ExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the execution you want state machine information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineForExecutionCmdlet.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.StepFunctions.Model.DescribeStateMachineForExecutionResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.DescribeStateMachineForExecutionResponse 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.SFN.GetSFNStateMachineForExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^ExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineListCmdlet"> <summary> Lists the existing state machines. <para> If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error. </para><note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note><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.SFN.GetSFNStateMachineListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</para><para>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineListCmdlet.NextToken"> <summary> <para> <para>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</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.SFN.GetSFNStateMachineListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StateMachines'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.ListStateMachinesResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.ListStateMachinesResponse 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.SFN.GetSFNStateMachineListCmdlet.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.SFN.NewSFNActivityCmdlet"> <summary> Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the <code>GetActivityTask</code> API action and respond using <code>SendTask*</code> API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. <note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note><note><para><code>CreateActivity</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateActivity</code>'s idempotency check is based on the activity <code>name</code>. If a following request has different <code>tags</code> values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>tags</code> will not be updated, even if they are different. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNActivityCmdlet.Name"> <summary> <para> <para>The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions"> Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</para><para>A name must <i>not</i> contain:</para><ul><li><para>white space</para></li><li><para>brackets <code>< > { } [ ]</code></para></li><li><para>wildcard characters <code>? *</code></para></li><li><para>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code></para></li><li><para>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</para></li></ul><para>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNActivityCmdlet.Tag"> <summary> <para> <para>The list of tags to add to a resource.</para><para>An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM Tags</a>.</para><para>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNActivityCmdlet.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.StepFunctions.Model.CreateActivityResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.CreateActivityResponse 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.SFN.NewSFNActivityCmdlet.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.SFN.NewSFNActivityCmdlet.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.SFN.NewSFNStateMachineCmdlet"> <summary> Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> in the Step Functions User Guide. <note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note><note><para><code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency check is based on the state machine <code>name</code>, <code>definition</code>, <code>type</code>, <code>LoggingConfiguration</code> and <code>TracingConfiguration</code>. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.Definition"> <summary> <para> <para>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.LoggingConfiguration_Destination"> <summary> <para> <para>An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to <code>OFF</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.TracingConfiguration_Enabled"> <summary> <para> <para>When set to <code>true</code>, X-Ray tracing is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.LoggingConfiguration_IncludeExecutionData"> <summary> <para> <para>Determines whether execution data is included in your log. When set to <code>false</code>, data is excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.LoggingConfiguration_Level"> <summary> <para> <para>Defines which category of execution history events are logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.Name"> <summary> <para> <para>The name of the state machine. </para><para>A name must <i>not</i> contain:</para><ul><li><para>white space</para></li><li><para>brackets <code>< > { } [ ]</code></para></li><li><para>wildcard characters <code>? *</code></para></li><li><para>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code></para></li><li><para>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</para></li></ul><para>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to use for this state machine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.Tag"> <summary> <para> <para>Tags to be added when creating a state machine.</para><para>An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM Tags</a>.</para><para>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.Type"> <summary> <para> <para>Determines whether a Standard or Express state machine is created. The default is <code>STANDARD</code>. You cannot update the <code>type</code> of a state machine once it has been created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.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.StepFunctions.Model.CreateStateMachineResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.CreateStateMachineResponse 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.SFN.NewSFNStateMachineCmdlet.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.SFN.NewSFNStateMachineCmdlet.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.SFN.RemoveSFNActivityCmdlet"> <summary> Deletes an activity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNActivityCmdlet.ActivityArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the activity to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNActivityCmdlet.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.StepFunctions.Model.DeleteActivityResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNActivityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ActivityArn parameter. The -PassThru parameter is deprecated, use -Select '^ActivityArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNActivityCmdlet.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.SFN.RemoveSFNResourceTagCmdlet"> <summary> Remove a tag from a Step Functions resource </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tags to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNResourceTagCmdlet.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.StepFunctions.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNResourceTagCmdlet.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.SFN.RemoveSFNResourceTagCmdlet.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.SFN.RemoveSFNStateMachineCmdlet"> <summary> Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to <code>DELETING</code> and begins the deletion process. <para> If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException. </para><para> A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>. </para><note><para> For <code>EXPRESS</code> state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code> API is called. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineCmdlet.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.StepFunctions.Model.DeleteStateMachineResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StateMachineArn parameter. The -PassThru parameter is deprecated, use -Select '^StateMachineArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineCmdlet.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.SFN.SendSFNTaskFailureCmdlet"> <summary> Used by activity workers and task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a> pattern to report that the task identified by the <code>taskToken</code> failed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskFailureCmdlet.Cause"> <summary> <para> <para>A more detailed explanation of the cause of the failure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskFailureCmdlet.Error"> <summary> <para> <para>The error code of the failure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskFailureCmdlet.TaskToken"> <summary> <para> <para>The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskFailureCmdlet.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.StepFunctions.Model.SendTaskFailureResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskFailureCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskToken parameter. The -PassThru parameter is deprecated, use -Select '^TaskToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskFailureCmdlet.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.SFN.SendSFNTaskHeartbeatCmdlet"> <summary> Used by activity workers and task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a> pattern to report to Step Functions that the task represented by the specified <code>taskToken</code> is still making progress. This action resets the <code>Heartbeat</code> clock. The <code>Heartbeat</code> threshold is specified in the state machine's Amazon States Language definition (<code>HeartbeatSeconds</code>). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an <code>ActivityTimedOut</code> entry for activities, or a <code>TaskTimedOut</code> entry for for tasks using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a> pattern. <note><para> The <code>Timeout</code> of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of <a>SendTaskHeartbeat</a> requests received. Use <code>HeartbeatSeconds</code> to configure the timeout interval for heartbeats. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskHeartbeatCmdlet.TaskToken"> <summary> <para> <para>The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskHeartbeatCmdlet.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.StepFunctions.Model.SendTaskHeartbeatResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskHeartbeatCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskToken parameter. The -PassThru parameter is deprecated, use -Select '^TaskToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskHeartbeatCmdlet.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.SFN.SendSFNTaskSuccessCmdlet"> <summary> Used by activity workers and task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a> pattern to report that the task identified by the <code>taskToken</code> completed successfully. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskSuccessCmdlet.Output"> <summary> <para> <para>The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskSuccessCmdlet.TaskToken"> <summary> <para> <para>The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskSuccessCmdlet.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.StepFunctions.Model.SendTaskSuccessResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskSuccessCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskToken parameter. The -PassThru parameter is deprecated, use -Select '^TaskToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.SendSFNTaskSuccessCmdlet.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.SFN.StartSFNExecutionCmdlet"> <summary> Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException. <para> A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>. </para><note><para><code>StartExecution</code> is idempotent for <code>STANDARD</code> workflows. For a <code>STANDARD</code> workflow, if <code>StartExecution</code> is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a <code>400 ExecutionAlreadyExists</code> error. Names can be reused after 90 days. </para><para><code>StartExecution</code> is not idempotent for <code>EXPRESS</code> workflows. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNExecutionCmdlet.Input"> <summary> <para> <para>The string that contains the JSON input data for the execution, for example:</para><para><code>"input": "{\"first_name\" : \"test\"}"</code></para><note><para>If you don't include any JSON input data, you still must include the two braces, for example: <code>"input": "{}"</code></para></note><para>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNExecutionCmdlet.Name"> <summary> <para> <para>The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine for 90 days. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions"> Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</para><para>A name must <i>not</i> contain:</para><ul><li><para>white space</para></li><li><para>brackets <code>< > { } [ ]</code></para></li><li><para>wildcard characters <code>? *</code></para></li><li><para>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code></para></li><li><para>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</para></li></ul><para>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNExecutionCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine to execute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNExecutionCmdlet.TraceHeader"> <summary> <para> <para>Passes the X-Ray trace header. The trace header can also be passed in the request payload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNExecutionCmdlet.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.StepFunctions.Model.StartExecutionResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.StartExecutionResponse 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.SFN.StartSFNExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StateMachineArn parameter. The -PassThru parameter is deprecated, use -Select '^StateMachineArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNExecutionCmdlet.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.SFN.StartSFNSyncExecutionCmdlet"> <summary> Starts a Synchronous Express state machine execution. <code>StartSyncExecution</code> is not available for <code>STANDARD</code> workflows. <note><para><code>StartSyncExecution</code> will return a <code>200 OK</code> response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration. </para></note><note><para> This API action isn't logged in CloudTrail. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNSyncExecutionCmdlet.Input"> <summary> <para> <para>The string that contains the JSON input data for the execution, for example:</para><para><code>"input": "{\"first_name\" : \"test\"}"</code></para><note><para>If you don't include any JSON input data, you still must include the two braces, for example: <code>"input": "{}"</code></para></note><para>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNSyncExecutionCmdlet.Name"> <summary> <para> <para>The name of the execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNSyncExecutionCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine to execute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNSyncExecutionCmdlet.TraceHeader"> <summary> <para> <para>Passes the X-Ray trace header. The trace header can also be passed in the request payload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNSyncExecutionCmdlet.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.StepFunctions.Model.StartSyncExecutionResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.StartSyncExecutionResponse 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.SFN.StartSFNSyncExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StateMachineArn parameter. The -PassThru parameter is deprecated, use -Select '^StateMachineArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StartSFNSyncExecutionCmdlet.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.SFN.StopSFNExecutionCmdlet"> <summary> Stops an execution. <para> This API action is not supported by <code>EXPRESS</code> state machines. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StopSFNExecutionCmdlet.Cause"> <summary> <para> <para>A more detailed explanation of the cause of the failure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StopSFNExecutionCmdlet.Error"> <summary> <para> <para>The error code of the failure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StopSFNExecutionCmdlet.ExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the execution to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StopSFNExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StopDate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.StopExecutionResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.StopExecutionResponse 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.SFN.StopSFNExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^ExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.StopSFNExecutionCmdlet.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.SFN.UpdateSFNMapRunCmdlet"> <summary> Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNMapRunCmdlet.MapRunArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Map Run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNMapRunCmdlet.MaxConcurrency"> <summary> <para> <para>The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNMapRunCmdlet.ToleratedFailureCount"> <summary> <para> <para>The maximum number of failed items before the Map Run fails.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNMapRunCmdlet.ToleratedFailurePercentage"> <summary> <para> <para>The maximum percentage of failed items before the Map Run fails.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNMapRunCmdlet.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.StepFunctions.Model.UpdateMapRunResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNMapRunCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MapRunArn parameter. The -PassThru parameter is deprecated, use -Select '^MapRunArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNMapRunCmdlet.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.SFN.UpdateSFNStateMachineCmdlet"> <summary> Updates an existing state machine by modifying its <code>definition</code>, <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue to use the previous <code>definition</code> and <code>roleArn</code>. You must include at least one of <code>definition</code> or <code>roleArn</code> or you will receive a <code>MissingRequiredParameter</code> error. <para> If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException. </para><para> A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>. </para><note><para> All <code>StartExecution</code> calls within a few seconds will use the updated <code>definition</code> and <code>roleArn</code>. Executions started immediately after calling <code>UpdateStateMachine</code> may use the previous state machine <code>definition</code> and <code>roleArn</code>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.Definition"> <summary> <para> <para>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.LoggingConfiguration_Destination"> <summary> <para> <para>An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to <code>OFF</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.TracingConfiguration_Enabled"> <summary> <para> <para>When set to <code>true</code>, X-Ray tracing is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.LoggingConfiguration_IncludeExecutionData"> <summary> <para> <para>Determines whether execution data is included in your log. When set to <code>false</code>, data is excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.LoggingConfiguration_Level"> <summary> <para> <para>Defines which category of execution history events are logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role of the state machine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UpdateDate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.UpdateStateMachineResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.UpdateStateMachineResponse 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.SFN.UpdateSFNStateMachineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StateMachineArn parameter. The -PassThru parameter is deprecated, use -Select '^StateMachineArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.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> |