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: <c>_ . : / = + - @</c>. </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: <c>_ . : / = + - @</c>.</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.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="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNActivityListCmdlet"> <summary> Lists the existing activities. <para> If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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 <c>nextToken</c> 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 <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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 <c>taskToken</c> 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 <c>GetActivityTask</c> 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="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionCmdlet"> <summary> Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html">redriven</a> an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run. <para> If you specify a version or alias ARN when you call the <a>StartExecution</a> API action, <c>DescribeExecution</c> returns that ARN. </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> Executions of an <c>EXPRESS</c> state machine aren't supported by <c>DescribeExecution</c> unless a Map Run dispatched them. </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.IncludedData"> <summary> <para> <para>If your state machine definition is encrypted with a KMS key, callers must have <c>kms:Decrypt</c> permission to decrypt the definition. Alternatively, you can call DescribeStateMachine API with <c>includedData = METADATA_ONLY</c> to get a successful response without the encrypted definition.</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="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 <c>timeStamp</c> of the events. Use the <c>reverseOrder</c> parameter to get the latest events first. <para> If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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 <c>EXPRESS</c> 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 <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionHistoryCmdlet.ReverseOrder"> <summary> <para> <para>Lists events in descending order of their <c>timeStamp</c>.</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 <c>nextToken</c> 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 <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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.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. Using this API action, you can also list all <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html">redriven</a> executions. <para> You can also provide a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> ARN or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> ARN to list the executions associated with a specific alias or version. </para><para> Results are sorted by time, with the most recent execution first. </para><para> If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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 <c>EXPRESS</c> 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 <c>mapRunArn</c> 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 <c>mapRunArn</c> or a <c>stateMachineArn</c>, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNExecutionListCmdlet.RedriveFilter"> <summary> <para> <para>Sets a filter to list executions based on whether or not they have been redriven.</para><para>For a Distributed Map, <c>redriveFilter</c> sets a filter to list child workflow executions based on whether or not they have been redriven.</para><para>If you do not provide a <c>redriveFilter</c>, Step Functions returns a list of both redriven and non-redriven executions.</para><para>If you provide a state machine ARN in <c>redriveFilter</c>, the API returns a validation exception.</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 <c>mapRunArn</c> or a <c>stateMachineArn</c>, but not both.</para><para>You can also return a list of executions associated with a specific <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, by specifying an alias ARN or a version ARN in the <c>stateMachineArn</c> parameter.</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 <c>nextToken</c> 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 <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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.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. If you've <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html">redriven</a> a Map Run, this API action also returns information about the redrives of that Map Run. 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="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 <c>DescribeMapRun</c> 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 <c>nextToken</c> 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 <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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.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: <c>_ . : / = + - @</c>. </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="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineCmdlet"> <summary> Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. <para> A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN. </para><para> The following are some examples of qualified and unqualified state machine ARNs: </para><ul><li><para> The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <c>mapStateLabel</c> in a state machine named <c>myStateMachine</c>. </para><para><c>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</c></para><note><para> If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <c>ValidationException</c>. </para></note></li><li><para> The following qualified state machine ARN refers to an alias named <c>PROD</c>. </para><para><c>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></c></para><note><para> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. </para></note></li><li><para> The following unqualified state machine ARN refers to a state machine named <c>myStateMachine</c>. </para><para><c>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></c></para></li></ul><para> This API action returns the details for a state machine version if the <c>stateMachineArn</c> you specify is a state machine version ARN. </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.IncludedData"> <summary> <para> <para>If your state machine definition is encrypted with a KMS key, callers must have <c>kms:Decrypt</c> permission to decrypt the definition. Alternatively, you can call the API with <c>includedData = METADATA_ONLY</c> to get a successful response without the encrypted definition.</para><note><para> When calling a labelled ARN for an encrypted state machine, the <c>includedData = METADATA_ONLY</c> parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have <c>kms:Decrypt</c> permission. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine for which you want the information.</para><para>If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <c>stateMachineARN:1</c>.</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="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineAliasCmdlet"> <summary> Returns details about a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>. <para><b>Related operations:</b></para><ul><li><para><a>CreateStateMachineAlias</a></para></li><li><para><a>ListStateMachineAliases</a></para></li><li><para><a>UpdateStateMachineAlias</a></para></li><li><para><a>DeleteStateMachineAlias</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineAliasCmdlet.StateMachineAliasArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineAliasCmdlet.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.DescribeStateMachineAliasResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.DescribeStateMachineAliasResponse 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.SFN.GetSFNStateMachineAliasListCmdlet"> <summary> Lists <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">aliases</a> for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. <para> To list aliases that reference a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, you can specify the version ARN in the <c>stateMachineArn</c> parameter. </para><para> If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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><b>Related operations:</b></para><ul><li><para><a>CreateStateMachineAlias</a></para></li><li><para><a>DescribeStateMachineAlias</a></para></li><li><para><a>UpdateStateMachineAlias</a></para></li><li><para><a>DeleteStateMachineAlias</a></para></li></ul><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.GetSFNStateMachineAliasListCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.</para><para>If you specify a state machine version ARN, this API returns a list of aliases for that version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineAliasListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> 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.GetSFNStateMachineAliasListCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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.GetSFNStateMachineAliasListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StateMachineAliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.ListStateMachineAliasesResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.ListStateMachineAliasesResponse 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.GetSFNStateMachineAliasListCmdlet.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.GetSFNStateMachineForExecutionCmdlet"> <summary> Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is 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 <c>EXPRESS</c> 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.IncludedData"> <summary> <para> <para>If your state machine definition is encrypted with a KMS key, callers must have <c>kms:Decrypt</c> permission to decrypt the definition. Alternatively, you can call the API with <c>includedData = METADATA_ONLY</c> to get a successful response without the encrypted definition.</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="T:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineListCmdlet"> <summary> Lists the existing state machines. <para> If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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 <c>nextToken</c> 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 <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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.GetSFNStateMachineVersionListCmdlet"> <summary> Lists <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> for the specified state machine Amazon Resource Name (ARN). <para> The results are sorted in descending order of the version creation time. </para><para> If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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><b>Related operations:</b></para><ul><li><para><a>PublishStateMachineVersion</a></para></li><li><para><a>DeleteStateMachineVersion</a></para></li></ul><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.GetSFNStateMachineVersionListCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.GetSFNStateMachineVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> 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.GetSFNStateMachineVersionListCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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.GetSFNStateMachineVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StateMachineVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.ListStateMachineVersionsResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.ListStateMachineVersionsResponse 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.GetSFNStateMachineVersionListCmdlet.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 <c>GetActivityTask</c> API action and respond using <c>SendTask*</c> 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><c>CreateActivity</c> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <c>CreateActivity</c>'s idempotency check is based on the activity <c>name</c>. If a following request has different <c>tags</c> values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <c>tags</c> will not be updated, even if they are different. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNActivityCmdlet.EncryptionConfiguration_KmsDataKeyReusePeriodSecond"> <summary> <para> <para>Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call <c>GenerateDataKey</c>. Only applies to customer managed keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNActivityCmdlet.EncryptionConfiguration_KmsKeyId"> <summary> <para> <para>An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</para> </para> </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 <c>< > { } [ ]</c></para></li><li><para>wildcard characters <c>? *</c></para></li><li><para>special characters <c>" # % \ ^ | ~ ` $ & , ; : /</c></para></li><li><para>control characters (<c>U+0000-001F</c>, <c>U+007F-009F</c>)</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: <c>_ . : / = + - @</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNActivityCmdlet.EncryptionConfiguration_Type"> <summary> <para> <para>Encryption type</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.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 (<c>Task</c> states), determine to which states to transition next (<c>Choice</c> states), stop an execution with an error (<c>Fail</c> 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. <para> If you set the <c>publish</c> parameter of this API action to <c>true</c>, it publishes version <c>1</c> as the first revision of the state machine. </para><para> For additional control over security, you can encrypt your data using a <b>customer-managed key</b> for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a <b>State Machine</b>. The execution history and state machine definition will be encrypted with the key applied to the State Machine. </para><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><c>CreateStateMachine</c> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <c>CreateStateMachine</c>'s idempotency check is based on the state machine <c>name</c>, <c>definition</c>, <c>type</c>, <c>LoggingConfiguration</c>, <c>TracingConfiguration</c>, and <c>EncryptionConfiguration</c> The check is also based on the <c>publish</c> and <c>versionDescription</c> parameters. If a following request has a different <c>roleArn</c> or <c>tags</c>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <c>roleArn</c> and <c>tags</c> 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 <c>OFF</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.TracingConfiguration_Enabled"> <summary> <para> <para>When set to <c>true</c>, 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 <c>false</c>, data is excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.EncryptionConfiguration_KmsDataKeyReusePeriodSecond"> <summary> <para> <para>Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call <c>GenerateDataKey</c>. Only applies to customer managed keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.EncryptionConfiguration_KmsKeyId"> <summary> <para> <para>An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</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 <c>< > { } [ ]</c></para></li><li><para>wildcard characters <c>? *</c></para></li><li><para>special characters <c>" # % \ ^ | ~ ` $ & , ; : /</c></para></li><li><para>control characters (<c>U+0000-001F</c>, <c>U+007F-009F</c>)</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.Publish"> <summary> <para> <para>Set to <c>true</c> to publish the first version of the state machine during creation. The default is <c>false</c>.</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: <c>_ . : / = + - @</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.EncryptionConfiguration_Type"> <summary> <para> <para>Encryption type</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 <c>STANDARD</c>. You cannot update the <c>type</c> of a state machine once it has been created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineCmdlet.VersionDescription"> <summary> <para> <para>Sets description about the state machine version. You can only set the description if the <c>publish</c> parameter is set to <c>true</c>. Otherwise, if you set <c>versionDescription</c>, but <c>publish</c> to <c>false</c>, this API action throws <c>ValidationException</c>.</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.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.NewSFNStateMachineAliasCmdlet"> <summary> Creates an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> for a state machine that points to one or two <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> of the same state machine. You can set your application to call <a>StartExecution</a> with an alias and update the version the alias uses without changing the client's code. <para> You can also map an alias to split <a>StartExecution</a> requests between two versions of a state machine. To do this, add a second <c>RoutingConfig</c> object in the <c>routingConfiguration</c> parameter. You must also specify the percentage of execution run requests each version should receive in both <c>RoutingConfig</c> objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify. </para><para> To create an alias that points to a single version, specify a single <c>RoutingConfig</c> object with a <c>weight</c> set to 100. </para><para> You can create up to 100 aliases for each state machine. You must delete unused aliases using the <a>DeleteStateMachineAlias</a> API action. </para><para><c>CreateStateMachineAlias</c> is an idempotent API. Step Functions bases the idempotency check on the <c>stateMachineArn</c>, <c>description</c>, <c>name</c>, and <c>routingConfiguration</c> parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource. </para><para><b>Related operations:</b></para><ul><li><para><a>DescribeStateMachineAlias</a></para></li><li><para><a>ListStateMachineAliases</a></para></li><li><para><a>UpdateStateMachineAlias</a></para></li><li><para><a>DeleteStateMachineAlias</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineAliasCmdlet.Description"> <summary> <para> <para>A description for the state machine alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineAliasCmdlet.Name"> <summary> <para> <para>The name of the state machine alias.</para><para>To avoid conflict with version ARNs, don't use an integer in the name of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineAliasCmdlet.RoutingConfiguration"> <summary> <para> <para>The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. <c>routingConfiguration</c> contains an array of <c>RoutingConfig</c> objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each <c>RoutingConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.NewSFNStateMachineAliasCmdlet.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.CreateStateMachineAliasResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.CreateStateMachineAliasResponse 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.NewSFNStateMachineAliasCmdlet.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.PublishSFNStateMachineVersionCmdlet"> <summary> Creates a <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use <a>CreateStateMachineAlias</a>. <para> You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the <a>DeleteStateMachineVersion</a> API action. </para><para><c>PublishStateMachineVersion</c> is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions bases <c>PublishStateMachineVersion</c>'s idempotency check on the <c>stateMachineArn</c>, <c>name</c>, and <c>revisionId</c> parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a <c>revisionId</c>, Step Functions checks for a previously published version of the state machine's current revision. </para><para><b>Related operations:</b></para><ul><li><para><a>DeleteStateMachineVersion</a></para></li><li><para><a>ListStateMachineVersions</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.PublishSFNStateMachineVersionCmdlet.Description"> <summary> <para> <para>An optional description of the state machine version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.PublishSFNStateMachineVersionCmdlet.RevisionId"> <summary> <para> <para>Only publish the state machine version if the current state machine's revision ID matches the specified ID.</para><para>Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn't match the state machine's current revision ID, the API returns <c>ConflictException</c>.</para><note><para>To specify an initial revision ID for a state machine with no revision ID assigned, specify the string <c>INITIAL</c> for the <c>revisionId</c> parameter. For example, you can specify a <c>revisionID</c> of <c>INITIAL</c> when you create a state machine using the <a>CreateStateMachine</a> API action.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.PublishSFNStateMachineVersionCmdlet.StateMachineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.PublishSFNStateMachineVersionCmdlet.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.PublishStateMachineVersionResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.PublishStateMachineVersionResponse 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.PublishSFNStateMachineVersionCmdlet.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.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.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 <c>DELETING</c> and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated. <para> A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN. </para><para> The following are some examples of qualified and unqualified state machine ARNs: </para><ul><li><para> The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <c>mapStateLabel</c> in a state machine named <c>myStateMachine</c>. </para><para><c>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</c></para><note><para> If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <c>ValidationException</c>. </para></note></li><li><para> The following unqualified state machine ARN refers to a state machine named <c>myStateMachine</c>. </para><para><c>arn:partition:states:region:account-id:stateMachine:myStateMachine</c></para></li></ul><para> This API action also deletes all <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> and <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">aliases</a> associated with a state machine. </para><note><para> For <c>EXPRESS</c> state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after <c>DeleteStateMachine</c> 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.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.RemoveSFNStateMachineAliasCmdlet"> <summary> Deletes a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>. <para> After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references. </para><para><b>Related operations:</b></para><ul><li><para><a>CreateStateMachineAlias</a></para></li><li><para><a>DescribeStateMachineAlias</a></para></li><li><para><a>ListStateMachineAliases</a></para></li><li><para><a>UpdateStateMachineAlias</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineAliasCmdlet.StateMachineAliasArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine alias to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineAliasCmdlet.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.DeleteStateMachineAliasResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineAliasCmdlet.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.RemoveSFNStateMachineVersionCmdlet"> <summary> Deletes a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>. After you delete a version, you can't call <a>StartExecution</a> using that version's ARN or use the version with a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>. <note><para> Deleting a state machine version won't terminate its in-progress executions. </para></note><note><para> You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version. </para></note><para><b>Related operations:</b></para><ul><li><para><a>PublishStateMachineVersion</a></para></li><li><para><a>ListStateMachineVersions</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineVersionCmdlet.StateMachineVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine version to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineVersionCmdlet.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.DeleteStateMachineVersionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RemoveSFNStateMachineVersionCmdlet.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.RestartSFNExecutionCmdlet"> <summary> Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html">redrive</a> an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt. <para> For workflows that include an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html">Inline Map</a> or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-parallel-state.html">Parallel</a> state, <c>RedriveExecution</c> API action reschedules and redrives only the iterations and branches that failed or aborted. </para><para> To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/use-dist-map-orchestrate-large-scale-parallel-workloads.html#dist-map-orchestrate-parallel-workloads-key-terms">parent workflow</a>. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run. </para><note><para> This API action is not supported by <c>EXPRESS</c> state machines. </para><para> However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the <a>StartExecution</a> API action. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html">Redriving Map Runs</a>. </para></note><para> You can redrive executions if your original execution meets the following conditions: </para><ul><li><para> The execution status isn't <c>SUCCEEDED</c>. </para></li><li><para> Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution. </para></li><li><para> The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits-overview.html#service-limits-state-machine-executions">Quotas related to state machine executions</a>. </para></li><li><para> The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the <c>ExecutionRedriven</c> history event and at least one other history event. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RestartSFNExecutionCmdlet.ExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the execution to be redriven.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RestartSFNExecutionCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API will return idempotent responses for the last 10 client tokens used to successfully redrive the execution. These client tokens are valid for up to 15 minutes after they are first used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.RestartSFNExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RedriveDate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StepFunctions.Model.RedriveExecutionResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.RedriveExecutionResponse 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.RestartSFNExecutionCmdlet.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, 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, and optionally Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> pattern to report that the task identified by the <c>taskToken</c> failed. <para> For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role. </para><para> A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both <c>error</c> and <c>cause</c> fields because no data needs to be encrypted. </para> </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.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, and optionally Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> pattern to report to Step Functions that the task represented by the specified <c>taskToken</c> is still making progress. This action resets the <c>Heartbeat</c> clock. The <c>Heartbeat</c> threshold is specified in the state machine's Amazon States Language definition (<c>HeartbeatSeconds</c>). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an <c>ActivityTimedOut</c> entry for activities, or a <c>TaskTimedOut</c> entry 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 <c>Timeout</c> 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 <c>HeartbeatSeconds</c> 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.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, 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, and optionally Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> pattern to report that the task identified by the <c>taskToken</c> 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.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. <para> A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN. </para><para> The following are some examples of qualified and unqualified state machine ARNs: </para><ul><li><para> The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <c>mapStateLabel</c> in a state machine named <c>myStateMachine</c>. </para><para><c>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</c></para><note><para> If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <c>ValidationException</c>. </para></note></li><li><para> The following qualified state machine ARN refers to an alias named <c>PROD</c>. </para><para><c>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></c></para><note><para> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. </para></note></li><li><para> The following unqualified state machine ARN refers to a state machine named <c>myStateMachine</c>. </para><para><c>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></c></para></li></ul><para> If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution. </para><para> To start executions of a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, call <c>StartExecution</c> and provide the version ARN or the ARN of an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> that points to the version. </para><note><para><c>StartExecution</c> is idempotent for <c>STANDARD</c> workflows. For a <c>STANDARD</c> workflow, if you call <c>StartExecution</c> with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a <c>400 ExecutionAlreadyExists</c> error. You can reuse names after 90 days. </para><para><c>StartExecution</c> isn't idempotent for <c>EXPRESS</c> 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><c>"input": "{\"first_name\" : \"test\"}"</c></para><note><para>If you don't include any JSON input data, you still must include the two braces, for example: <c>"input": "{}"</c></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>Optional 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>If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.</para><para>A name must <i>not</i> contain:</para><ul><li><para>white space</para></li><li><para>brackets <c>< > { } [ ]</c></para></li><li><para>wildcard characters <c>? *</c></para></li><li><para>special characters <c>" # % \ ^ | ~ ` $ & , ; : /</c></para></li><li><para>control characters (<c>U+0000-001F</c>, <c>U+007F-009F</c>)</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>The <c>stateMachineArn</c> parameter accepts one of the following inputs:</para><ul><li><para><b>An unqualified state machine ARN</b> – Refers to a state machine ARN that isn't qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.</para><para><c>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></c></para><para>Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.</para></li><li><para><b>A state machine version ARN</b> – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10. </para><para><c>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10</c></para><para>Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that version.</para></li><li><para><b>A state machine alias ARN</b> – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named <c>PROD</c>.</para><para><c>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></c></para><para>Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.</para></li></ul> </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.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. <c>StartSyncExecution</c> is not available for <c>STANDARD</c> workflows. <note><para><c>StartSyncExecution</c> will return a <c>200 OK</c> 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.IncludedData"> <summary> <para> <para>If your state machine definition is encrypted with a KMS key, callers must have <c>kms:Decrypt</c> permission to decrypt the definition. Alternatively, you can call the API with <c>includedData = METADATA_ONLY</c> to get a successful response without the encrypted definition.</para> </para> </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><c>"input": "{\"first_name\" : \"test\"}"</c></para><note><para>If you don't include any JSON input data, you still must include the two braces, for example: <c>"input": "{}"</c></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.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 <c>EXPRESS</c> state machines. </para><para> For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role. </para><para> A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both <c>error</c> and <c>cause</c> fields because no data needs to be encrypted. </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.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.TestSFNStateCmdlet"> <summary> Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following: <ul><li><para> A state's <a href="https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-input-output-dataflow">input and output processing</a> data flow </para></li><li><para> An <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-services.html">Amazon Web Services service integration</a> request and response </para></li><li><para> An <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-third-party-apis.html">HTTP Task</a> request and response </para></li></ul><para> You can call this API on only one state at a time. The states that you can test include the following: </para><ul><li><para><a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-task-state.html#task-types">All Task types</a> except <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-activities.html">Activity</a></para></li><li><para><a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-pass-state.html">Pass</a></para></li><li><para><a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-wait-state.html">Wait</a></para></li><li><para><a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html">Choice</a></para></li><li><para><a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-succeed-state.html">Succeed</a></para></li><li><para><a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-fail-state.html">Fail</a></para></li></ul><para> The <c>TestState</c> API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions">IAM permissions to test a state</a>. </para><para> The <c>TestState</c> API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the <c>States.Timeout</c> error. </para><para><c>TestState</c> doesn't support <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-activities.html">Activity tasks</a>, <c>.sync</c> or <c>.waitForTaskToken</c><a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html">service integration patterns</a>, <a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-parallel-state.html">Parallel</a>, or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html">Map</a> states. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateCmdlet.Definition"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> (ASL) definition of the state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateCmdlet.Input"> <summary> <para> <para>A string that contains the JSON input data for the state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateCmdlet.InspectionLevel"> <summary> <para> <para>Determines the values to return when a state is tested. You can specify one of the following types:</para><ul><li><para><c>INFO</c>: Shows the final state output. By default, Step Functions sets <c>inspectionLevel</c> to <c>INFO</c> if you don't specify a level.</para></li><li><para><c>DEBUG</c>: Shows the final state output along with the input and output data processing result.</para></li><li><para><c>TRACE</c>: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.</para></li></ul><para>Each of these levels also provide information about the status of the state execution and the next state to transition to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateCmdlet.RevealSecret"> <summary> <para> <para>Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.</para><para>If you set <c>revealSecrets</c> to <c>true</c>, you must make sure that the IAM user that calls the <c>TestState</c> API has permission for the <c>states:RevealSecrets</c> action. For an example of IAM policy that sets the <c>states:RevealSecrets</c> permission, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions">IAM permissions to test a state</a>. Without this permission, Step Functions throws an access denied error.</para><para>By default, <c>revealSecrets</c> is set to <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateCmdlet.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.TestStateResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.TestStateResponse 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.SFN.TestSFNStateMachineDefinitionValidationCmdlet"> <summary> Validates the syntax of a state machine definition. <para> You can validate that a state machine definition is correct without creating a state machine resource. Step Functions will implicitly perform the same syntax check when you invoke <c>CreateStateMachine</c> and <c>UpdateStateMachine</c>. State machine definitions are specified using a JSON-based, structured language. For more information on Amazon States Language see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> (ASL). </para><para> Suggested uses for <c>ValidateStateMachineDefinition</c>: </para><ul><li><para> Integrate automated checks into your code review or Continuous Integration (CI) process to validate state machine definitions before starting deployments. </para></li><li><para> Run the validation from a Git pre-commit hook to check your state machine definitions before committing them to your source repository. </para></li></ul><note><para> Errors found in the state machine definition will be returned in the response as a list of <b>diagnostic elements</b>, rather than raise an exception. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateMachineDefinitionValidationCmdlet.Definition"> <summary> <para> <para>The Amazon States Language definition of the state machine. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> (ASL).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateMachineDefinitionValidationCmdlet.Severity"> <summary> <para> <para>Minimum level of diagnostics to return. <c>ERROR</c> returns only <c>ERROR</c> diagnostics, whereas <c>WARNING</c> returns both <c>WARNING</c> and <c>ERROR</c> diagnostics. The default is <c>ERROR</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateMachineDefinitionValidationCmdlet.Type"> <summary> <para> <para>The target type of state machine for this definition. The default is <c>STANDARD</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateMachineDefinitionValidationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of diagnostics that are returned per call. The default and maximum value is 100. Setting the value to 0 will also use the default of 100.</para><para>If the number of diagnostics returned in the response exceeds <c>maxResults</c>, the value of the <c>truncated</c> field in the response will be set to <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.TestSFNStateMachineDefinitionValidationCmdlet.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.ValidateStateMachineDefinitionResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.ValidateStateMachineDefinitionResponse 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.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.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 <c>definition</c>, <c>roleArn</c>, <c>loggingConfiguration</c>, or <c>EncryptionConfiguration</c>. Running executions will continue to use the previous <c>definition</c> and <c>roleArn</c>. You must include at least one of <c>definition</c> or <c>roleArn</c> or you will receive a <c>MissingRequiredParameter</c> error. <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 <c>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</c> refers to a <i>Distributed Map state</i> with a label <c>mapStateLabel</c> in the state machine named <c>stateMachineName</c>. </para><para> A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN. </para><para> The following are some examples of qualified and unqualified state machine ARNs: </para><ul><li><para> The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <c>mapStateLabel</c> in a state machine named <c>myStateMachine</c>. </para><para><c>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</c></para><note><para> If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <c>ValidationException</c>. </para></note></li><li><para> The following qualified state machine ARN refers to an alias named <c>PROD</c>. </para><para><c>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></c></para><note><para> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. </para></note></li><li><para> The following unqualified state machine ARN refers to a state machine named <c>myStateMachine</c>. </para><para><c>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></c></para></li></ul><para> After you update your state machine, you can set the <c>publish</c> parameter to <c>true</c> in the same action to publish a new <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>. This way, you can opt-in to strict versioning of your state machine. </para><note><para> Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1. </para></note><note><para> All <c>StartExecution</c> calls within a few seconds use the updated <c>definition</c> and <c>roleArn</c>. Executions started immediately after you call <c>UpdateStateMachine</c> may use the previous state machine <c>definition</c> and <c>roleArn</c>. </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 <c>OFF</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.TracingConfiguration_Enabled"> <summary> <para> <para>When set to <c>true</c>, 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 <c>false</c>, data is excluded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.EncryptionConfiguration_KmsDataKeyReusePeriodSecond"> <summary> <para> <para>Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call <c>GenerateDataKey</c>. Only applies to customer managed keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.EncryptionConfiguration_KmsKeyId"> <summary> <para> <para>An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</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.Publish"> <summary> <para> <para>Specifies whether the state machine version is published. The default is <c>false</c>. To publish a version after updating the state machine, set <c>publish</c> to <c>true</c>.</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.EncryptionConfiguration_Type"> <summary> <para> <para>Encryption type</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineCmdlet.VersionDescription"> <summary> <para> <para>An optional description of the state machine version to publish.</para><para>You can only specify the <c>versionDescription</c> parameter if you've set <c>publish</c> to <c>true</c>.</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.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.UpdateSFNStateMachineAliasCmdlet"> <summary> Updates the configuration of an existing state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> by modifying its <c>description</c> or <c>routingConfiguration</c>. <para> You must specify at least one of the <c>description</c> or <c>routingConfiguration</c> parameters to update a state machine alias. </para><note><para><c>UpdateStateMachineAlias</c> is an idempotent API. Step Functions bases the idempotency check on the <c>stateMachineAliasArn</c>, <c>description</c>, and <c>routingConfiguration</c> parameters. Requests with the same parameters return an idempotent response. </para></note><note><para> This operation is eventually consistent. All <a>StartExecution</a> requests made within a few seconds use the latest alias configuration. Executions started immediately after calling <c>UpdateStateMachineAlias</c> may use the previous routing configuration. </para></note><para><b>Related operations:</b></para><ul><li><para><a>CreateStateMachineAlias</a></para></li><li><para><a>DescribeStateMachineAlias</a></para></li><li><para><a>ListStateMachineAliases</a></para></li><li><para><a>DeleteStateMachineAlias</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineAliasCmdlet.Description"> <summary> <para> <para>A description of the state machine alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineAliasCmdlet.RoutingConfiguration"> <summary> <para> <para>The routing configuration of the state machine alias.</para><para>An array of <c>RoutingConfig</c> objects that specifies up to two state machine versions that the alias starts executions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineAliasCmdlet.StateMachineAliasArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the state machine alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SFN.UpdateSFNStateMachineAliasCmdlet.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.UpdateStateMachineAliasResponse). Specifying the name of a property of type Amazon.StepFunctions.Model.UpdateStateMachineAliasResponse 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.UpdateSFNStateMachineAliasCmdlet.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> |