AWS.Tools.SimSpaceWeaver.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SimSpaceWeaver</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet"> <summary> Adds tags to a SimSpace Weaver resource. For more information about tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to add tags to. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags to apply to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet.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.SimSpaceWeaver.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet.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.SSW.GetSSWAppCmdlet"> <summary> Returns the state of the given custom app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppCmdlet.App"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppCmdlet.Domain"> <summary> <para> <para>The name of the domain of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppCmdlet.Simulation"> <summary> <para> <para>The name of the simulation of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppCmdlet.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.SimSpaceWeaver.Model.DescribeAppResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.DescribeAppResponse 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.SSW.GetSSWAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the App parameter. The -PassThru parameter is deprecated, use -Select '^App' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet"> <summary> Lists all custom apps or service apps for the given simulation and domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.Domain"> <summary> <para> <para>The name of the domain that you want to list apps for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.Simulation"> <summary> <para> <para>The name of the simulation that you want to list apps for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of apps to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.NextToken"> <summary> <para> <para>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Apps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimSpaceWeaver.Model.ListAppsResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.ListAppsResponse 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.SSW.GetSSWAppListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Simulation parameter. The -PassThru parameter is deprecated, use -Select '^Simulation' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSW.GetSSWResourceTagCmdlet"> <summary> Lists all tags on a SimSpace Weaver resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWResourceTagCmdlet.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.SimSpaceWeaver.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationCmdlet"> <summary> Returns the current state of the given simulation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationCmdlet.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.SimSpaceWeaver.Model.DescribeSimulationResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.DescribeSimulationResponse 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.SSW.GetSSWSimulationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Simulation parameter. The -PassThru parameter is deprecated, use -Select '^Simulation' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationListCmdlet"> <summary> Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of simulations to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationListCmdlet.NextToken"> <summary> <para> <para>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Simulations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimSpaceWeaver.Model.ListSimulationsResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.ListSimulationsResponse 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.SSW.NewSSWSnapshotCmdlet"> <summary> Creates a snapshot of the specified simulation. A snapshot is a file that contains simulation state data at a specific time. The state data saved in a snapshot includes entity data from the State Fabric, the simulation configuration specified in the schema, and the clock tick number. You can use the snapshot to initialize a new simulation. For more information about snapshots, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html">Snapshots</a> in the <i>SimSpace Weaver User Guide</i>. <para> You specify a <code>Destination</code> when you create a snapshot. The <code>Destination</code> is the name of an Amazon S3 bucket and an optional <code>ObjectKeyPrefix</code>. The <code>ObjectKeyPrefix</code> is usually the name of a folder in the bucket. SimSpace Weaver creates a <code>snapshot</code> folder inside the <code>Destination</code> and places the snapshot file there. </para><para> The snapshot file is an Amazon S3 object. It has an object key with the form: <code><i>object-key-prefix</i>/snapshot/<i>simulation-name</i>-<i>YYMMdd</i>-<i>HHmm</i>-<i>ss</i>.zip</code>, where: </para><ul><li><para><code><i>YY</i></code> is the 2-digit year </para></li><li><para><code><i>MM</i></code> is the 2-digit month </para></li><li><para><code><i>dd</i></code> is the 2-digit day of the month </para></li><li><para><code><i>HH</i></code> is the 2-digit hour (24-hour clock) </para></li><li><para><code><i>mm</i></code> is the 2-digit minutes </para></li><li><para><code><i>ss</i></code> is the 2-digit seconds </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.Destination_BucketName"> <summary> <para> <para>The name of an Amazon S3 bucket. For more information about buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.Destination_ObjectKeyPrefix"> <summary> <para> <para>A string prefix for an Amazon S3 object key. It's usually a folder name. For more information about folders in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html">Organizing objects in the Amazon S3 console using folders</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.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.SimSpaceWeaver.Model.CreateSnapshotResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Simulation parameter. The -PassThru parameter is deprecated, use -Select '^Simulation' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.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.SSW.RemoveSSWAppCmdlet"> <summary> Deletes the instance of the given custom app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.App"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.Domain"> <summary> <para> <para>The name of the domain of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.Simulation"> <summary> <para> <para>The name of the simulation of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.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.SimSpaceWeaver.Model.DeleteAppResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the App parameter. The -PassThru parameter is deprecated, use -Select '^App' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.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.SSW.RemoveSSWResourceTagCmdlet"> <summary> Removes tags from a SimSpace Weaver resource. For more information about tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to remove tags from. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWResourceTagCmdlet.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.SimSpaceWeaver.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWResourceTagCmdlet.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.SSW.RemoveSSWSimulationCmdlet"> <summary> Deletes all SimSpace Weaver resources assigned to the given simulation. <note><para> Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWSimulationCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWSimulationCmdlet.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.SimSpaceWeaver.Model.DeleteSimulationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWSimulationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Simulation parameter. The -PassThru parameter is deprecated, use -Select '^Simulation' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWSimulationCmdlet.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.SSW.StartSSWAppCmdlet"> <summary> Starts a custom app with the configuration specified in the simulation schema. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.Description"> <summary> <para> <para>The description of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.Domain"> <summary> <para> <para>The name of the domain of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.LaunchOverrides_LaunchCommand"> <summary> <para> <para>App launch commands and command line parameters that override the launch command configured in the simulation schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.Name"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.Simulation"> <summary> <para> <para>The name of the simulation of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.ClientToken"> <summary> <para> <para>A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A <code>ClientToken</code> is also known as an <i>idempotency token</i>. A <code>ClientToken</code> expires after 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.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.SimSpaceWeaver.Model.StartAppResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.StartAppResponse 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.SSW.StartSSWAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.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.SSW.StartSSWClockCmdlet"> <summary> Starts the simulation clock. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWClockCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWClockCmdlet.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.SimSpaceWeaver.Model.StartClockResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWClockCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Simulation parameter. The -PassThru parameter is deprecated, use -Select '^Simulation' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWClockCmdlet.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.SSW.StartSSWSimulationCmdlet"> <summary> Starts a simulation with the given name. You must choose to start your simulation from a schema or from a snapshot. For more information about the schema, see the <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/schema-reference.html">schema reference</a> in the <i>SimSpace Weaver User Guide</i>. For more information about snapshots, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html">Snapshots</a> in the <i>SimSpace Weaver User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.SchemaS3Location_BucketName"> <summary> <para> <para>The name of an Amazon S3 bucket. For more information about buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.SnapshotS3Location_BucketName"> <summary> <para> <para>The name of an Amazon S3 bucket. For more information about buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.Description"> <summary> <para> <para>The description of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.MaximumDuration"> <summary> <para> <para>The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is <code>14D</code>, or its equivalent in the other units. The default value is <code>14D</code>. A value equivalent to <code>0</code> makes the simulation immediately transition to <code>Stopping</code> as soon as it reaches <code>Started</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.Name"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.SchemaS3Location_ObjectKey"> <summary> <para> <para>The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html">Uploading, downloading, and working with objects in Amazon S3</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.SnapshotS3Location_ObjectKey"> <summary> <para> <para>The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html">Uploading, downloading, and working with objects in Amazon S3</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. For more information about IAM roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the <i>Identity and Access Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.Tag"> <summary> <para> <para>A list of tags for the simulation. For more information about tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.ClientToken"> <summary> <para> <para>A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A <code>ClientToken</code> is also known as an <i>idempotency token</i>. A <code>ClientToken</code> expires after 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.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.SimSpaceWeaver.Model.StartSimulationResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.StartSimulationResponse 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.SSW.StartSSWSimulationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.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.SSW.StopSSWAppCmdlet"> <summary> Stops the given custom app and shuts down all of its allocated compute resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.App"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.Domain"> <summary> <para> <para>The name of the domain of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.Simulation"> <summary> <para> <para>The name of the simulation of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.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.SimSpaceWeaver.Model.StopAppResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the App parameter. The -PassThru parameter is deprecated, use -Select '^App' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.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.SSW.StopSSWClockCmdlet"> <summary> Stops the simulation clock. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWClockCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWClockCmdlet.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.SimSpaceWeaver.Model.StopClockResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWClockCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Simulation parameter. The -PassThru parameter is deprecated, use -Select '^Simulation' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWClockCmdlet.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.SSW.StopSSWSimulationCmdlet"> <summary> Stops the given simulation. <important><para> You can't restart a simulation after you stop it. If you want to restart a simulation, then you must stop it, delete it, and start a new instance of it. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWSimulationCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWSimulationCmdlet.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.SimSpaceWeaver.Model.StopSimulationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWSimulationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Simulation parameter. The -PassThru parameter is deprecated, use -Select '^Simulation' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWSimulationCmdlet.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> |