AWS.Tools.RoboMaker.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.RoboMaker</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.AddROBOResourceTagCmdlet"> <summary> Adds or edits tags for a AWS RoboMaker resource. <para> Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings. </para><para> For information about the rules that apply to tag keys and tag values, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.AddROBOResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.AddROBOResourceTagCmdlet.Tag"> <summary> <para> <para>A map that contains tag keys and tag values that are attached to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.AddROBOResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.AddROBOResourceTagCmdlet.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.ROBO.GetROBODeploymentJobCmdlet"> <summary> Describes a deployment job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBODeploymentJobCmdlet.Job"> <summary> <para> <para>The Amazon Resource Name (ARN) of the deployment job.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBODeploymentJobListCmdlet"> <summary> Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs. <note><para></para></note><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBODeploymentJobListCmdlet.Filter"> <summary> <para> <para>Optional filters to limit results.</para><para>The filter names <code>status</code> and <code>fleetName</code> are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status <code>InProgress</code> or the status <code>Pending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBODeploymentJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of deployment job results returned by <code>ListDeploymentJobs</code> in paginated output. When this parameter is used, <code>ListDeploymentJobs</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListDeploymentJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListDeploymentJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBODeploymentJobListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListDeploymentJobs</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBOFleetCmdlet"> <summary> Describes a fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOFleetCmdlet.Fleet"> <summary> <para> <para>The Amazon Resource Name (ARN) of the fleet.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBOFleetListCmdlet"> <summary> Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOFleetListCmdlet.Filter"> <summary> <para> <para>Optional filters to limit results.</para><para>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOFleetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of deployment job results returned by <code>ListFleets</code> in paginated output. When this parameter is used, <code>ListFleets</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListFleets</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListFleets</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOFleetListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListFleets</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBOResourceTagCmdlet"> <summary> Lists all tags on a AWS RoboMaker resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotCmdlet"> <summary> Describes a robot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotCmdlet.Robot"> <summary> <para> <para>The Amazon Resource Name (ARN) of the robot to be described.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotApplicationCmdlet"> <summary> Describes a robot application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotApplicationCmdlet.Application"> <summary> <para> <para>The Amazon Resource Name (ARN) of the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotApplicationCmdlet.ApplicationVersion"> <summary> <para> <para>The version of the robot application to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotApplicationListCmdlet"> <summary> Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotApplicationListCmdlet.Filter"> <summary> <para> <para>Optional filters to limit results.</para><para>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotApplicationListCmdlet.VersionQualifier"> <summary> <para> <para>The version qualifier of the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotApplicationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of deployment job results returned by <code>ListRobotApplications</code> in paginated output. When this parameter is used, <code>ListRobotApplications</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListRobotApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListRobotApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotApplicationListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListRobotApplications</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotListCmdlet"> <summary> Returns a list of robots. You can optionally provide filters to retrieve specific robots.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotListCmdlet.Filter"> <summary> <para> <para>Optional filters to limit results.</para><para>The filter names <code>status</code> and <code>fleetName</code> are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status <code>Registered</code> or the status <code>Available</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of deployment job results returned by <code>ListRobots</code> in paginated output. When this parameter is used, <code>ListRobots</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListRobots</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListRobots</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBORobotListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListRobots</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationApplicationCmdlet"> <summary> Describes a simulation application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationApplicationCmdlet.Application"> <summary> <para> <para>The application information for the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationApplicationCmdlet.ApplicationVersion"> <summary> <para> <para>The version of the simulation application to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationApplicationListCmdlet"> <summary> Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationApplicationListCmdlet.Filter"> <summary> <para> <para>Optional list of filters to limit results.</para><para>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationApplicationListCmdlet.VersionQualifier"> <summary> <para> <para>The version qualifier of the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationApplicationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of deployment job results returned by <code>ListSimulationApplications</code> in paginated output. When this parameter is used, <code>ListSimulationApplications</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListSimulationApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListSimulationApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationApplicationListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListSimulationApplications</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationJobCmdlet"> <summary> Describes a simulation job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationJobCmdlet.Job"> <summary> <para> <para>The Amazon Resource Name (ARN) of the simulation job to be described.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationJobListCmdlet"> <summary> Describes one or more simulation jobs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationJobListCmdlet.Job"> <summary> <para> <para>A list of Amazon Resource Names (ARNs) of simulation jobs to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationJobSummaryCmdlet"> <summary> Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationJobSummaryCmdlet.Filter"> <summary> <para> <para>Optional filters to limit results.</para><para>The filter names <code>status</code> and <code>simulationApplicationName</code> and <code>robotApplicationName</code> are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status <code>Preparing</code> or the status <code>Running</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationJobSummaryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of deployment job results returned by <code>ListSimulationJobs</code> in paginated output. When this parameter is used, <code>ListSimulationJobs</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListSimulationJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListSimulationJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.GetROBOSimulationJobSummaryCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListSimulationJobs</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ROBO.NewROBODeploymentJobCmdlet"> <summary> Deploys a specific version of a robot application to robots in a fleet. <para> The robot application must have a numbered <code>applicationVersion</code> for consistency reasons. To create a new version, use <code>CreateRobotApplicationVersion</code> or see <a href="https://docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html">Creating a Robot Application Version</a>. </para><note><para> After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBODeploymentJobCmdlet.ClientRequestToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBODeploymentJobCmdlet.DeploymentApplicationConfig"> <summary> <para> <para>The deployment application configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBODeploymentJobCmdlet.DeploymentConfig"> <summary> <para> <para>The requested deployment configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBODeploymentJobCmdlet.Fleet"> <summary> <para> <para>The Amazon Resource Name (ARN) of the fleet to deploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBODeploymentJobCmdlet.Tag"> <summary> <para> <para>A map that contains tag keys and tag values that are attached to the deployment job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBODeploymentJobCmdlet.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.ROBO.NewROBOFleetCmdlet"> <summary> Creates a fleet, a logical group of robots running the same robot application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOFleetCmdlet.Name"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOFleetCmdlet.Tag"> <summary> <para> <para>A map that contains tag keys and tag values that are attached to the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOFleetCmdlet.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.ROBO.NewROBORobotCmdlet"> <summary> Creates a robot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotCmdlet.Architecture"> <summary> <para> <para>The target architecture of the robot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotCmdlet.GreengrassGroupId"> <summary> <para> <para>The Greengrass group id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotCmdlet.Name"> <summary> <para> <para>The name for the robot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotCmdlet.Tag"> <summary> <para> <para>A map that contains tag keys and tag values that are attached to the robot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotCmdlet.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.ROBO.NewROBORobotApplicationCmdlet"> <summary> Creates a robot application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotApplicationCmdlet.Name"> <summary> <para> <para>The name of the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotApplicationCmdlet.RobotSoftwareSuite"> <summary> <para> <para>The robot software suite used by the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotApplicationCmdlet.Source"> <summary> <para> <para>The sources of the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotApplicationCmdlet.Tag"> <summary> <para> <para>A map that contains tag keys and tag values that are attached to the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotApplicationCmdlet.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.ROBO.NewROBORobotApplicationVersionCmdlet"> <summary> Creates a version of a robot application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotApplicationVersionCmdlet.Application"> <summary> <para> <para>The application information for the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotApplicationVersionCmdlet.CurrentRevisionId"> <summary> <para> <para>The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBORobotApplicationVersionCmdlet.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.ROBO.NewROBOSimulationApplicationCmdlet"> <summary> Creates a simulation application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationCmdlet.Name"> <summary> <para> <para>The name of the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationCmdlet.RenderingEngine_Name"> <summary> <para> <para>The name of the rendering engine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationCmdlet.RobotSoftwareSuite"> <summary> <para> <para>The robot software suite of the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationCmdlet.SimulationSoftwareSuite"> <summary> <para> <para>The simulation software suite used by the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationCmdlet.Source"> <summary> <para> <para>The sources of the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationCmdlet.Tag"> <summary> <para> <para>A map that contains tag keys and tag values that are attached to the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationCmdlet.RenderingEngine_Version"> <summary> <para> <para>The version of the rendering engine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationCmdlet.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.ROBO.NewROBOSimulationApplicationVersionCmdlet"> <summary> Creates a simulation application with a specific revision id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationVersionCmdlet.Application"> <summary> <para> <para>The application information for the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationVersionCmdlet.CurrentRevisionId"> <summary> <para> <para>The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationApplicationVersionCmdlet.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.ROBO.NewROBOSimulationJobCmdlet"> <summary> Creates a simulation job. <note><para> After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.ClientRequestToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.FailureBehavior"> <summary> <para> <para>The failure behavior the simulation job.</para><dl><dt>Continue</dt><dd><para>Restart the simulation job in the same host instance.</para></dd><dt>Fail</dt><dd><para>Stop the simulation job and terminate the instance.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.IamRole"> <summary> <para> <para>The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.MaxJobDurationInSecond"> <summary> <para> <para>The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When <code>maxJobDurationInSeconds</code> is reached, the simulation job will status will transition to <code>Completed</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.OutputLocation"> <summary> <para> <para>Location for output files generated by the simulation job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.RobotApplication"> <summary> <para> <para>The robot application to use in the simulation job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.SimulationApplication"> <summary> <para> <para>The simulation application to use in the simulation job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.Tag"> <summary> <para> <para>A map that contains tag keys and tag values that are attached to the simulation job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.VpcConfig"> <summary> <para> <para>If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.NewROBOSimulationJobCmdlet.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.ROBO.RegisterROBORobotCmdlet"> <summary> Registers a robot with a fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RegisterROBORobotCmdlet.Fleet"> <summary> <para> <para>The Amazon Resource Name (ARN) of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RegisterROBORobotCmdlet.Robot"> <summary> <para> <para>The Amazon Resource Name (ARN) of the robot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RegisterROBORobotCmdlet.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.ROBO.RemoveROBOFleetCmdlet"> <summary> Deletes a fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOFleetCmdlet.Fleet"> <summary> <para> <para>The Amazon Resource Name (ARN) of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOFleetCmdlet.PassThru"> <summary> Returns the value passed to the Fleet parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOFleetCmdlet.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.ROBO.RemoveROBOResourceTagCmdlet"> <summary> Removes the specified tags from the specified AWS RoboMaker resource. <para> To remove a tag, specify the tag key. To change the tag value of an existing tag key, use <a href="https://docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html"><code>TagResource</code></a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOResourceTagCmdlet.TagKey"> <summary> <para> <para>A map that contains tag keys and tag values that will be unattached from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOResourceTagCmdlet.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.ROBO.RemoveROBORobotCmdlet"> <summary> Deletes a robot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBORobotCmdlet.Robot"> <summary> <para> <para>The Amazon Resource Name (ARN) of the robot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBORobotCmdlet.PassThru"> <summary> Returns the value passed to the Robot parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBORobotCmdlet.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.ROBO.RemoveROBORobotApplicationCmdlet"> <summary> Deletes a robot application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBORobotApplicationCmdlet.Application"> <summary> <para> <para>The Amazon Resource Name (ARN) of the the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBORobotApplicationCmdlet.ApplicationVersion"> <summary> <para> <para>The version of the robot application to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBORobotApplicationCmdlet.PassThru"> <summary> Returns the value passed to the Application parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBORobotApplicationCmdlet.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.ROBO.RemoveROBOSimulationApplicationCmdlet"> <summary> Deletes a simulation application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOSimulationApplicationCmdlet.Application"> <summary> <para> <para>The application information for the simulation application to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOSimulationApplicationCmdlet.ApplicationVersion"> <summary> <para> <para>The version of the simulation application to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOSimulationApplicationCmdlet.PassThru"> <summary> Returns the value passed to the Application parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RemoveROBOSimulationApplicationCmdlet.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.ROBO.RestartROBOSimulationJobCmdlet"> <summary> Restarts a running simulation job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RestartROBOSimulationJobCmdlet.Job"> <summary> <para> <para>The Amazon Resource Name (ARN) of the simulation job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RestartROBOSimulationJobCmdlet.PassThru"> <summary> Returns the value passed to the Job parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.RestartROBOSimulationJobCmdlet.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.ROBO.StopROBODeploymentJobCmdlet"> <summary> Cancels the specified deployment job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.StopROBODeploymentJobCmdlet.Job"> <summary> <para> <para>The deployment job ARN to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.StopROBODeploymentJobCmdlet.PassThru"> <summary> Returns the value passed to the Job parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.StopROBODeploymentJobCmdlet.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.ROBO.StopROBOSimulationJobCmdlet"> <summary> Cancels the specified simulation job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.StopROBOSimulationJobCmdlet.Job"> <summary> <para> <para>The simulation job ARN to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.StopROBOSimulationJobCmdlet.PassThru"> <summary> Returns the value passed to the Job parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.StopROBOSimulationJobCmdlet.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.ROBO.SyncROBODeploymentJobCmdlet"> <summary> Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.SyncROBODeploymentJobCmdlet.ClientRequestToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.SyncROBODeploymentJobCmdlet.Fleet"> <summary> <para> <para>The target fleet for the synchronization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.SyncROBODeploymentJobCmdlet.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.ROBO.UnregisterROBORobotCmdlet"> <summary> Deregisters a robot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UnregisterROBORobotCmdlet.Fleet"> <summary> <para> <para>The Amazon Resource Name (ARN) of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UnregisterROBORobotCmdlet.Robot"> <summary> <para> <para>The Amazon Resource Name (ARN) of the robot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UnregisterROBORobotCmdlet.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.ROBO.UpdateROBORobotApplicationCmdlet"> <summary> Updates a robot application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBORobotApplicationCmdlet.Application"> <summary> <para> <para>The application information for the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBORobotApplicationCmdlet.CurrentRevisionId"> <summary> <para> <para>The revision id for the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBORobotApplicationCmdlet.RobotSoftwareSuite"> <summary> <para> <para>The robot software suite used by the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBORobotApplicationCmdlet.Source"> <summary> <para> <para>The sources of the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBORobotApplicationCmdlet.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.ROBO.UpdateROBOSimulationApplicationCmdlet"> <summary> Updates a simulation application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBOSimulationApplicationCmdlet.Application"> <summary> <para> <para>The application information for the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBOSimulationApplicationCmdlet.CurrentRevisionId"> <summary> <para> <para>The revision id for the robot application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBOSimulationApplicationCmdlet.RenderingEngine_Name"> <summary> <para> <para>The name of the rendering engine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBOSimulationApplicationCmdlet.RobotSoftwareSuite"> <summary> <para> <para>Information about the robot software suite.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBOSimulationApplicationCmdlet.SimulationSoftwareSuite"> <summary> <para> <para>The simulation software suite used by the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBOSimulationApplicationCmdlet.Source"> <summary> <para> <para>The sources of the simulation application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBOSimulationApplicationCmdlet.RenderingEngine_Version"> <summary> <para> <para>The version of the rendering engine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ROBO.UpdateROBOSimulationApplicationCmdlet.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> |