"documentation":"<p>Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch. </p>"
"documentation":"<p>Deploys a specific version of a robot application to robots in a fleet.</p> <p>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>. </p> <note> <p>After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible. </p> </note>"
"documentation":"<p>Creates a simulation job.</p> <note> <p>After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible. </p> </note>"
"documentation":"<p>Adds or edits tags for a AWS RoboMaker resource.</p> <p>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. </p> <p>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>. </p>"
"documentation":"<p>Removes the specified tags from the specified AWS RoboMaker resource.</p> <p>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>. </p>"
"documentation":"<p>The amount of time, in seconds, to wait for the batch to complete. </p> <p>If a batch times out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), they will be moved to the failed list and the batch status will be <code>Failed</code>. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be <code>TimedOut</code>. </p>"
},
"maxConcurrency":{
"shape":"MaxConcurrency",
"documentation":"<p>The number of active simulation jobs create as part of the batch that can be in an active state at the same time. </p> <p>Active states include: <code>Pending</code>,<code>Preparing</code>, <code>Running</code>, <code>Restarting</code>, <code>RunningFailed</code> and <code>Terminating</code>. All other states are terminal states. </p>"
}
},
"documentation":"<p>Information about the batch policy.</p>"
"documentation":"<p>The failure code of the simulation job if it failed:</p> <dl> <dt>BadPermissionError</dt> <dd> <p>AWS Greengrass requires a service-level role permission to access other services. The role must include the <a href=\"https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor\"> <code>AWSGreengrassResourceAccessRolePolicy</code> managed policy</a>. </p> </dd> <dt>ExtractingBundleFailure</dt> <dd> <p>The robot application could not be extracted from the bundle.</p> </dd> <dt>FailureThresholdBreached</dt> <dd> <p>The percentage of robots that could not be updated exceeded the percentage set for the deployment.</p> </dd> <dt>GreengrassDeploymentFailed</dt> <dd> <p>The robot application could not be deployed to the robot.</p> </dd> <dt>GreengrassGroupVersionDoesNotExist</dt> <dd> <p>The AWS Greengrass group or version associated with a robot is missing.</p> </dd> <dt>InternalServerError</dt> <dd> <p>An internal error has occurred. Retry your request, but if the problem persists, contact us with details.</p> </dd> <dt>MissingRobotApplicationArchitecture</dt> <dd> <p>The robot application does not have a source that matches the architecture of the robot.</p> </dd> <dt>MissingRobotDeploymentResource</dt> <dd> <p>One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?</p> </dd> <dt>PostLaunchFileFailure</dt> <dd> <p>The post-launch script failed.</p> </dd> <dt>PreLaunchFileFailure</dt> <dd> <p>The pre-launch script failed.</p> </dd> <dt>ResourceNotFound</dt> <dd> <p>One or more deployment resources are missing. For example, do robot application source bundles still exist? </p> </dd> <dt>RobotDeploymentNoResponse</dt> <dd> <p>There is no response from the robot. It might not be powered on or connected to the internet.</p> </dd> </dl>"
"documentation":"<p>The application information for the robot application.</p>"
},
"currentRevisionId":{
"shape":"RevisionId",
"documentation":"<p>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.</p>"
}
}
},
"CreateRobotApplicationVersionResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the robot application.</p>"
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the robot application.</p>"
},
"version":{
"shape":"Version",
"documentation":"<p>The version of the robot application.</p>"
},
"sources":{
"shape":"Sources",
"documentation":"<p>The sources of the robot application.</p>"
"documentation":"<p>The application information for the simulation application.</p>"
},
"currentRevisionId":{
"shape":"RevisionId",
"documentation":"<p>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.</p>"
}
}
},
"CreateSimulationApplicationVersionResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the simulation application.</p>"
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the simulation application.</p>"
},
"version":{
"shape":"Version",
"documentation":"<p>The version of the simulation application.</p>"
},
"sources":{
"shape":"Sources",
"documentation":"<p>The sources of the simulation application.</p>"
},
"simulationSoftwareSuite":{
"shape":"SimulationSoftwareSuite",
"documentation":"<p>The simulation software suite used by the simulation application.</p>"
"documentation":"<p>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>.</p>"
"documentation":"<p>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. </p>"
"documentation":"<p>The failure behavior the simulation job.</p> <dl> <dt>Continue</dt> <dd> <p>Restart the simulation job in the same host instance.</p> </dd> <dt>Fail</dt> <dd> <p>Stop the simulation job and terminate the instance.</p> </dd> </dl>"
},
"robotApplications":{
"shape":"RobotApplicationConfigs",
"documentation":"<p>The robot application to use in the simulation job.</p>"
},
"simulationApplications":{
"shape":"SimulationApplicationConfigs",
"documentation":"<p>The simulation application to use in the simulation job.</p>"
"documentation":"<p>Specify data sources to mount read-only files from S3 into your simulation. These files are available under <code>/opt/robomaker/datasources/data_source_name</code>. </p> <note> <p>There is a limit of 100 files and a combined size of 25GB for all <code>DataSourceConfig</code> objects. </p> </note>"
"documentation":"<p>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. </p>"
"documentation":"<p>The failure code of the simulation job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>RobotApplicationCrash</dt> <dd> <p>Robot application exited abnormally.</p> </dd> <dt>SimulationApplicationCrash</dt> <dd> <p> Simulation application exited abnormally.</p> </dd> <dt>BadPermissionsRobotApplication</dt> <dd> <p>Robot application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsSimulationApplication</dt> <dd> <p>Simulation application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsS3Output</dt> <dd> <p>Unable to publish outputs to customer-provided S3 bucket.</p> </dd> <dt>BadPermissionsCloudwatchLogs</dt> <dd> <p>Unable to publish logs to customer-provided CloudWatch Logs resource.</p> </dd> <dt>SubnetIpLimitExceeded</dt> <dd> <p>Subnet IP limit exceeded.</p> </dd> <dt>ENILimitExceeded</dt> <dd> <p>ENI limit exceeded.</p> </dd> <dt>BadPermissionsUserCredentials</dt> <dd> <p>Unable to use the Role provided.</p> </dd> <dt>InvalidBundleRobotApplication</dt> <dd> <p>Robot bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>InvalidBundleSimulationApplication</dt> <dd> <p>Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>RobotApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for RobotApplication does not match value during version creation.</p> </dd> <dt>SimulationApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for SimulationApplication does not match value during version creation.</p> </dd> </dl>"
"documentation":"<p>The simulation job execution duration in milliseconds.</p>"
},
"iamRole":{
"shape":"IamRole",
"documentation":"<p>The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.</p>"
},
"robotApplications":{
"shape":"RobotApplicationConfigs",
"documentation":"<p>The robot application used by the simulation job.</p>"
},
"simulationApplications":{
"shape":"SimulationApplicationConfigs",
"documentation":"<p>The simulation application used by the simulation job.</p>"
"documentation":"<p>The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.</p>"
"documentation":"<p>The id of the batch to describe.</p>"
}
}
},
"DescribeSimulationJobBatchResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the batch.</p>"
},
"status":{
"shape":"SimulationJobBatchStatus",
"documentation":"<p>The status of the batch.</p> <dl> <dt>Pending</dt> <dd> <p>The simulation job batch request is pending.</p> </dd> <dt>InProgress</dt> <dd> <p>The simulation job batch is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like <code>InternalServiceError</code>). See <code>failureCode</code> and <code>failureReason</code> for more information.</p> </dd> <dt>Completed</dt> <dd> <p>The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to <code>InternalServiceError</code> and (2) when all created simulation jobs have reached a terminal state (for example, <code>Completed</code> or <code>Failed</code>). </p> </dd> <dt>Canceled</dt> <dd> <p>The simulation batch job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The simulation batch job is being cancelled.</p> </dd> <dt>Completing</dt> <dd> <p>The simulation batch job is completing.</p> </dd> <dt>TimingOut</dt> <dd> <p>The simulation job batch is timing out.</p> <p>If a batch timing out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), the batch status will be <code>Failed</code>. If there are no such failing request, the batch status will be <code>TimedOut</code>. </p> </dd> <dt>TimedOut</dt> <dd> <p>The simulation batch job timed out.</p> </dd> </dl>"
},
"lastUpdatedAt":{
"shape":"LastUpdatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was last updated.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was created.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"batchPolicy":{
"shape":"BatchPolicy",
"documentation":"<p>The batch policy.</p>"
},
"failureCode":{
"shape":"SimulationJobBatchErrorCode",
"documentation":"<p>The failure code of the simulation job batch.</p>"
},
"failureReason":{
"shape":"GenericString",
"documentation":"<p>The reason the simulation job batch failed.</p>"
},
"failedRequests":{
"shape":"FailedCreateSimulationJobRequests",
"documentation":"<p>A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID. </p>"
},
"pendingRequests":{
"shape":"CreateSimulationJobRequests",
"documentation":"<p>A list of pending simulation job requests. These requests have not yet been created into simulation jobs.</p>"
},
"createdRequests":{
"shape":"SimulationJobSummaries",
"documentation":"<p>A list of created simulation job summaries.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the simulation job batch.</p>"
"documentation":"<p>The failure code of the simulation job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>RobotApplicationCrash</dt> <dd> <p>Robot application exited abnormally.</p> </dd> <dt>SimulationApplicationCrash</dt> <dd> <p> Simulation application exited abnormally.</p> </dd> <dt>BadPermissionsRobotApplication</dt> <dd> <p>Robot application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsSimulationApplication</dt> <dd> <p>Simulation application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsS3Output</dt> <dd> <p>Unable to publish outputs to customer-provided S3 bucket.</p> </dd> <dt>BadPermissionsCloudwatchLogs</dt> <dd> <p>Unable to publish logs to customer-provided CloudWatch Logs resource.</p> </dd> <dt>SubnetIpLimitExceeded</dt> <dd> <p>Subnet IP limit exceeded.</p> </dd> <dt>ENILimitExceeded</dt> <dd> <p>ENI limit exceeded.</p> </dd> <dt>BadPermissionsUserCredentials</dt> <dd> <p>Unable to use the Role provided.</p> </dd> <dt>InvalidBundleRobotApplication</dt> <dd> <p>Robot bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>InvalidBundleSimulationApplication</dt> <dd> <p>Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>RobotApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for RobotApplication does not match value during version creation.</p> </dd> <dt>SimulationApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for SimulationApplication does not match value during version creation.</p> </dd> </dl>"
},
"failureReason":{
"shape":"GenericString",
"documentation":"<p>Details about why the simulation job failed. For more information about troubleshooting, see <a href=\"https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html\">Troubleshooting</a>.</p>"
"documentation":"<p>The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.</p>"
},
"simulationTimeMillis":{
"shape":"SimulationTimeMillis",
"documentation":"<p>The simulation job execution duration in milliseconds.</p>"
},
"iamRole":{
"shape":"IamRole",
"documentation":"<p>The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.</p>"
},
"robotApplications":{
"shape":"RobotApplicationConfigs",
"documentation":"<p>A list of robot applications.</p>"
},
"simulationApplications":{
"shape":"SimulationApplicationConfigs",
"documentation":"<p>A list of simulation applications.</p>"
"documentation":"<p>The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. </p>",
"documentation":"<p>AWS RoboMaker experienced a service issue. Try your call again.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
},
"documentation":"<p>A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.</p>",
"documentation":"<p>Information about a launch configuration.</p>"
},
"LimitExceededException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
},
"documentation":"<p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p>",
"documentation":"<p>Optional filters to limit results.</p> <p>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>.</p>"
"documentation":"<p>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. </p>"
"documentation":"<p>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 200. If this parameter is not used, then <code>ListDeploymentJobs</code> returns up to 200 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>A list of deployment jobs that meet the criteria of the request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListDeploymentJobs</code> request. When the results of a <code>ListDeploymentJobs</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
}
}
},
"ListFleetsRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>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. </p> <note> <p>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.</p> </note>"
"documentation":"<p>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 200. If this parameter is not used, then <code>ListFleets</code> returns up to 200 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>Optional filters to limit results.</p> <p>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.</p>"
"documentation":"<p>A list of fleet details meeting the request criteria.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListDeploymentJobs</code> request. When the results of a <code>ListFleets</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
}
}
},
"ListRobotApplicationsRequest":{
"type":"structure",
"members":{
"versionQualifier":{
"shape":"VersionQualifier",
"documentation":"<p>The version qualifier of the robot application.</p>"
"documentation":"<p>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. </p>"
"documentation":"<p>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. </p>"
"documentation":"<p>Optional filters to limit results.</p> <p>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.</p>"
"documentation":"<p>A list of robot application summaries that meet the criteria of the request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListRobotApplications</code> request. When the results of a <code>ListRobotApplications</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
"documentation":"<p>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. </p>"
"documentation":"<p>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 200. If this parameter is not used, then <code>ListRobots</code> returns up to 200 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>Optional filters to limit results.</p> <p>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>.</p>"
"documentation":"<p>A list of robots that meet the criteria of the request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListRobots</code> request. When the results of a <code>ListRobot</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
}
}
},
"ListSimulationApplicationsRequest":{
"type":"structure",
"members":{
"versionQualifier":{
"shape":"VersionQualifier",
"documentation":"<p>The version qualifier of the simulation application.</p>"
"documentation":"<p>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. </p>"
"documentation":"<p>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. </p>"
"documentation":"<p>Optional list of filters to limit results.</p> <p>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.</p>"
"documentation":"<p>A list of simulation application summaries that meet the criteria of the request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListSimulationApplications</code> request. When the results of a <code>ListRobot</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListSimulationJobBatches</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. </p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>When this parameter is used, <code>ListSimulationJobBatches</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>ListSimulationJobBatches</code> request with the returned <code>nextToken</code> value. </p>"
},
"filters":{
"shape":"Filters",
"documentation":"<p>Optional filters to limit results.</p>"
}
}
},
"ListSimulationJobBatchesResponse":{
"type":"structure",
"members":{
"simulationJobBatchSummaries":{
"shape":"SimulationJobBatchSummaries",
"documentation":"<p>A list of simulation job batch summaries.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListSimulationJobBatches</code> request. When the results of a <code>ListSimulationJobBatches</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
"documentation":"<p>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. </p> <note> <p>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.</p> </note>"
"documentation":"<p>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 1000. If this parameter is not used, then <code>ListSimulationJobs</code> returns up to 1000 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>Optional filters to limit results.</p> <p>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>.</p>"
"documentation":"<p>A list of simulation job summaries that meet the criteria of the request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListSimulationJobs</code> request. When the results of a <code>ListRobot</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
"documentation":"<p>The current progress status.</p> <dl> <dt>Validating</dt> <dd> <p>Validating the deployment.</p> </dd> <dt>DownloadingExtracting</dt> <dd> <p>Downloading and extracting the bundle on the robot.</p> </dd> <dt>ExecutingPreLaunch</dt> <dd> <p>Executing pre-launch script(s) if provided.</p> </dd> <dt>Launching</dt> <dd> <p>Launching the robot application.</p> </dd> <dt>ExecutingPostLaunch</dt> <dd> <p>Executing post-launch script(s) if provided.</p> </dd> <dt>Finished</dt> <dd> <p>Deployment is complete.</p> </dd> </dl>"
},
"percentDone":{
"shape":"PercentDone",
"documentation":"<p>Precentage of the step that is done. This currently only applies to the <code>Downloading/Extracting</code> step of the deployment. It is empty for other steps.</p>"
},
"estimatedTimeRemainingSeconds":{
"shape":"GenericInteger",
"documentation":"<p>Estimated amount of time in seconds remaining in the step. This currently only applies to the <code>Downloading/Extracting</code> step of the deployment. It is empty for other steps.</p>"
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job was last updated.</p>"
},
"failureBehavior":{
"shape":"FailureBehavior",
"documentation":"<p>The failure behavior the simulation job.</p> <dl> <dt>Continue</dt> <dd> <p>Restart the simulation job in the same host instance.</p> </dd> <dt>Fail</dt> <dd> <p>Stop the simulation job and terminate the instance.</p> </dd> </dl>"
},
"failureCode":{
"shape":"SimulationJobErrorCode",
"documentation":"<p>The failure code of the simulation job if it failed.</p>"
"documentation":"<p>The IAM role 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. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the batch.</p>"
},
"lastUpdatedAt":{
"shape":"LastUpdatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was last updated.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was created.</p>"
},
"status":{
"shape":"SimulationJobBatchStatus",
"documentation":"<p>The status of the simulation job batch.</p> <dl> <dt>Pending</dt> <dd> <p>The simulation job batch request is pending.</p> </dd> <dt>InProgress</dt> <dd> <p>The simulation job batch is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like <code>InternalServiceError</code>). See <code>failureCode</code> and <code>failureReason</code> for more information.</p> </dd> <dt>Completed</dt> <dd> <p>The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to <code>InternalServiceError</code> and (2) when all created simulation jobs have reached a terminal state (for example, <code>Completed</code> or <code>Failed</code>). </p> </dd> <dt>Canceled</dt> <dd> <p>The simulation batch job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The simulation batch job is being cancelled.</p> </dd> <dt>Completing</dt> <dd> <p>The simulation batch job is completing.</p> </dd> <dt>TimingOut</dt> <dd> <p>The simulation job batch is timing out.</p> <p>If a batch timing out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), the batch status will be <code>Failed</code>. If there are no such failing request, the batch status will be <code>TimedOut</code>. </p> </dd> <dt>TimedOut</dt> <dd> <p>The simulation batch job timed out.</p> </dd> </dl>"
},
"failedRequestCount":{
"shape":"Integer",
"documentation":"<p>The number of failed simulation job requests.</p>"
},
"pendingRequestCount":{
"shape":"Integer",
"documentation":"<p>The number of pending simulation job requests.</p>"
},
"createdRequestCount":{
"shape":"Integer",
"documentation":"<p>The number of created simulation job requests.</p>"
}
},
"documentation":"<p>Information about a simulation job batch.</p>"
"documentation":"<p>The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.</p>"
},
"iamRole":{
"shape":"IamRole",
"documentation":"<p>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. </p>"
},
"failureBehavior":{
"shape":"FailureBehavior",
"documentation":"<p>The failure behavior the simulation job.</p> <dl> <dt>Continue</dt> <dd> <p>Restart the simulation job in the same host instance.</p> </dd> <dt>Fail</dt> <dd> <p>Stop the simulation job and terminate the instance.</p> </dd> </dl>"
},
"useDefaultApplications":{
"shape":"BoxedBoolean",
"documentation":"<p>Boolean indicating whether to use default simulation tool applications.</p>"
},
"robotApplications":{
"shape":"RobotApplicationConfigs",
"documentation":"<p>The robot applications to use in the simulation job.</p>"
},
"simulationApplications":{
"shape":"SimulationApplicationConfigs",
"documentation":"<p>The simulation applications to use in the simulation job.</p>"
},
"dataSources":{
"shape":"DataSourceConfigs",
"documentation":"<p>Specify data sources to mount read-only files from S3 into your simulation. These files are available under <code>/opt/robomaker/datasources/data_source_name</code>. </p> <note> <p>There is a limit of 100 files and a combined size of 25GB for all <code>DataSourceConfig</code> objects. </p> </note>"
},
"vpcConfig":{"shape":"VPCConfig"},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the simulation job request.</p>"
}
},
"documentation":"<p>Information about a simulation job request.</p>"
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"batchPolicy":{
"shape":"BatchPolicy",
"documentation":"<p>The batch policy.</p>"
},
"createSimulationJobRequests":{
"shape":"CreateSimulationJobRequests",
"documentation":"<p>A list of simulation job requests to create in the batch.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the deployment job batch.</p>"
}
}
},
"StartSimulationJobBatchResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the batch.</p>"
},
"status":{
"shape":"SimulationJobBatchStatus",
"documentation":"<p>The status of the simulation job batch.</p> <dl> <dt>Pending</dt> <dd> <p>The simulation job batch request is pending.</p> </dd> <dt>InProgress</dt> <dd> <p>The simulation job batch is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like <code>InternalServiceError</code>). See <code>failureCode</code> and <code>failureReason</code> for more information.</p> </dd> <dt>Completed</dt> <dd> <p>The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to <code>InternalServiceError</code> and (2) when all created simulation jobs have reached a terminal state (for example, <code>Completed</code> or <code>Failed</code>). </p> </dd> <dt>Canceled</dt> <dd> <p>The simulation batch job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The simulation batch job is being cancelled.</p> </dd> <dt>Completing</dt> <dd> <p>The simulation batch job is completing.</p> </dd> <dt>TimingOut</dt> <dd> <p>The simulation job batch is timing out.</p> <p>If a batch timing out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), the batch status will be <code>Failed</code>. If there are no such failing request, the batch status will be <code>TimedOut</code>. </p> </dd> <dt>TimedOut</dt> <dd> <p>The simulation batch job timed out.</p> </dd> </dl>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was created.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"batchPolicy":{
"shape":"BatchPolicy",
"documentation":"<p>The batch policy.</p>"
},
"failureCode":{
"shape":"SimulationJobBatchErrorCode",
"documentation":"<p>The failure code if the simulation job batch failed.</p>"
},
"failureReason":{
"shape":"GenericString",
"documentation":"<p>The reason the simulation job batch failed.</p>"
},
"failedRequests":{
"shape":"FailedCreateSimulationJobRequests",
"documentation":"<p>A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID. </p>"
},
"pendingRequests":{
"shape":"CreateSimulationJobRequests",
"documentation":"<p>A list of pending simulation job requests. These requests have not yet been created into simulation jobs.</p>"
},
"createdRequests":{
"shape":"SimulationJobSummaries",
"documentation":"<p>A list of created simulation job request summaries.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the deployment job batch.</p>"
"documentation":"<p>The failure code if the job fails:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>RobotApplicationCrash</dt> <dd> <p>Robot application exited abnormally.</p> </dd> <dt>SimulationApplicationCrash</dt> <dd> <p> Simulation application exited abnormally.</p> </dd> <dt>BadPermissionsRobotApplication</dt> <dd> <p>Robot application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsSimulationApplication</dt> <dd> <p>Simulation application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsS3Output</dt> <dd> <p>Unable to publish outputs to customer-provided S3 bucket.</p> </dd> <dt>BadPermissionsCloudwatchLogs</dt> <dd> <p>Unable to publish logs to customer-provided CloudWatch Logs resource.</p> </dd> <dt>SubnetIpLimitExceeded</dt> <dd> <p>Subnet IP limit exceeded.</p> </dd> <dt>ENILimitExceeded</dt> <dd> <p>ENI limit exceeded.</p> </dd> <dt>BadPermissionsUserCredentials</dt> <dd> <p>Unable to use the Role provided.</p> </dd> <dt>InvalidBundleRobotApplication</dt> <dd> <p>Robot bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>InvalidBundleSimulationApplication</dt> <dd> <p>Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>RobotApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for RobotApplication does not match value during version creation.</p> </dd> <dt>SimulationApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for SimulationApplication does not match value during version creation.</p> </dd> </dl>"
"documentation":"<p>The rendering engine for the simulation application.</p>"
},
"lastUpdatedAt":{
"shape":"LastUpdatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation application was last updated.</p>"
},
"revisionId":{
"shape":"RevisionId",
"documentation":"<p>The revision id of the simulation application.</p>"
}
}
},
"VPCConfig":{
"type":"structure",
"required":["subnets"],
"members":{
"subnets":{
"shape":"Subnets",
"documentation":"<p>A list of one or more subnet IDs in your VPC.</p>"
},
"securityGroups":{
"shape":"SecurityGroups",
"documentation":"<p>A list of one or more security groups IDs in your VPC.</p>"
},
"assignPublicIp":{
"shape":"Boolean",
"documentation":"<p>A boolean indicating whether to assign a public IP address.</p>"
}
},
"documentation":"<p>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 two subnet IDs.</p>"
},
"VPCConfigResponse":{
"type":"structure",
"members":{
"subnets":{
"shape":"Subnets",
"documentation":"<p>A list of subnet IDs associated with the simulation job.</p>"
},
"securityGroups":{
"shape":"SecurityGroups",
"documentation":"<p>A list of security group IDs associated with the simulation job.</p>"
},
"vpcId":{
"shape":"GenericString",
"documentation":"<p>The VPC ID associated with your simulation job.</p>"
},
"assignPublicIp":{
"shape":"Boolean",
"documentation":"<p>A boolean indicating if a public IP was assigned.</p>"
}
},
"documentation":"<p>VPC configuration associated with your simulation job.</p>"