"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 simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximim value provided. The default is 15. </p>"
"documentation":"<p>The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximim value provided. The default is 15. </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 status of the world export job.</p> <dl> <dt>Pending</dt> <dd> <p>The world export job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world export job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world export job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world export job failed. See <code>failureCode</code> for more information. </p> </dd> <dt>Canceled</dt> <dd> <p>The world export job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world export job is being cancelled.</p> </dd> </dl>"
"documentation":"<p>The time, in milliseconds since the epoch, when the world export job was created.</p>"
},
"failureCode":{
"shape":"WorldExportJobErrorCode",
"documentation":"<p>The failure code of the world export job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>LimitExceeded</dt> <dd> <p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p> </dd> <dt>ResourceNotFound</dt> <dd> <p>The specified resource could not be found. </p> </dd> <dt>RequestThrottled</dt> <dd> <p>The request was throttled.</p> </dd> <dt>InvalidInput</dt> <dd> <p>An input parameter in the request is not valid.</p> </dd> <dt>AllWorldGenerationFailed</dt> <dd> <p>All of the worlds in the world generation job failed. This can happen if your <code>worldCount</code> is greater than 50 or less than 1. </p> </dd> </dl> <p>For more information about troubleshooting WorldForge, see <a href=\"https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting-worldforge.html\">Troubleshooting Simulation WorldForge</a>. </p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"outputLocation":{"shape":"OutputLocation"},
"iamRole":{
"shape":"IamRole",
"documentation":"<p>The IAM role that the world export process uses to access the Amazon S3 bucket and put the export. </p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the world export job.</p>"
}
}
},
"CreateWorldGenerationJobRequest":{
"type":"structure",
"required":[
"template",
"worldCount"
],
"members":{
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"idempotencyToken":true
},
"template":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world template describing the worlds you want to create.</p>"
},
"worldCount":{
"shape":"WorldCount",
"documentation":"<p>Information about the world count.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the world generator job.</p>"
},
"worldTags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the generated worlds.</p>"
}
}
},
"CreateWorldGenerationJobResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the world generator job.</p>"
},
"status":{
"shape":"WorldGenerationJobStatus",
"documentation":"<p>The status of the world generator job.</p> <dl> <dt>Pending</dt> <dd> <p>The world generator job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world generator job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world generator job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world generator job failed. See <code>failureCode</code> for more information. </p> </dd> <dt>PartialFailed</dt> <dd> <p>Some worlds did not generate.</p> </dd> <dt>Canceled</dt> <dd> <p>The world generator job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world generator job is being cancelled.</p> </dd> </dl>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world generator job was created.</p>"
},
"failureCode":{
"shape":"WorldGenerationJobErrorCode",
"documentation":"<p>The failure code of the world generator job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>LimitExceeded</dt> <dd> <p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p> </dd> <dt>ResourceNotFound</dt> <dd> <p>The specified resource could not be found. </p> </dd> <dt>RequestThrottled</dt> <dd> <p>The request was throttled.</p> </dd> <dt>InvalidInput</dt> <dd> <p>An input parameter in the request is not valid.</p> </dd> </dl>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"template":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world template.</p>"
},
"worldCount":{
"shape":"WorldCount",
"documentation":"<p>Information about the world count. </p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the world generator job.</p>"
},
"worldTags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the generated worlds.</p>"
}
}
},
"CreateWorldTemplateRequest":{
"type":"structure",
"members":{
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"name":{
"shape":"TemplateName",
"documentation":"<p>The name of the world template.</p>"
},
"templateBody":{
"shape":"Json",
"documentation":"<p>The world template body.</p>"
},
"templateLocation":{
"shape":"TemplateLocation",
"documentation":"<p>The location of the world template.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the world template.</p>"
}
}
},
"CreateWorldTemplateResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the world template.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world template was created.</p>"
},
"name":{
"shape":"TemplateName",
"documentation":"<p>The name of the world template.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the world template.</p>"
}
}
},
"CreatedAt":{"type":"timestamp"},
"DataSource":{
"type":"structure",
"members":{
"name":{
"shape":"Name",
"documentation":"<p>The name of the data source.</p>"
},
"s3Bucket":{
"shape":"S3Bucket",
"documentation":"<p>The S3 bucket where the data files are located.</p>"
},
"s3Keys":{
"shape":"S3KeyOutputs",
"documentation":"<p>The list of S3 keys identifying the data source files.</p>"
}
},
"documentation":"<p>Information about a data source.</p>"
},
"DataSourceConfig":{
"type":"structure",
"required":[
"name",
"s3Bucket",
"s3Keys"
],
"members":{
"name":{
"shape":"Name",
"documentation":"<p>The name of the data source.</p>"
},
"s3Bucket":{
"shape":"S3Bucket",
"documentation":"<p>The S3 bucket where the data files are located.</p>"
},
"s3Keys":{
"shape":"S3Keys",
"documentation":"<p>The list of S3 keys identifying the data source files.</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 Amazon Resource Name (arn) of the world export job to describe.</p>"
}
}
},
"DescribeWorldExportJobResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the world export job.</p>"
},
"status":{
"shape":"WorldExportJobStatus",
"documentation":"<p>The status of the world export job.</p> <dl> <dt>Pending</dt> <dd> <p>The world export job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world export job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world export job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world export job failed. See <code>failureCode</code> and <code>failureReason</code> for more information. </p> </dd> <dt>Canceled</dt> <dd> <p>The world export job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world export job is being cancelled.</p> </dd> </dl>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world export job was created.</p>"
},
"failureCode":{
"shape":"WorldExportJobErrorCode",
"documentation":"<p>The failure code of the world export job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>LimitExceeded</dt> <dd> <p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p> </dd> <dt>ResourceNotFound</dt> <dd> <p>The specified resource could not be found. </p> </dd> <dt>RequestThrottled</dt> <dd> <p>The request was throttled.</p> </dd> <dt>InvalidInput</dt> <dd> <p>An input parameter in the request is not valid.</p> </dd> </dl>"
},
"failureReason":{
"shape":"GenericString",
"documentation":"<p>The reason why the world export job failed.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"worlds":{
"shape":"Arns",
"documentation":"<p>A list of Amazon Resource Names (arns) that correspond to worlds to be exported.</p>"
},
"outputLocation":{"shape":"OutputLocation"},
"iamRole":{
"shape":"IamRole",
"documentation":"<p>The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the world export job.</p>"
}
}
},
"DescribeWorldGenerationJobRequest":{
"type":"structure",
"required":["job"],
"members":{
"job":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world generation job to describe.</p>"
}
}
},
"DescribeWorldGenerationJobResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the world generation job.</p>"
},
"status":{
"shape":"WorldGenerationJobStatus",
"documentation":"<p>The status of the world generation job:</p> <dl> <dt>Pending</dt> <dd> <p>The world generation job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world generation job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world generation job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world generation job failed. See <code>failureCode</code> for more information. </p> </dd> <dt>PartialFailed</dt> <dd> <p>Some worlds did not generate.</p> </dd> <dt>Canceled</dt> <dd> <p>The world generation job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world generation job is being cancelled.</p> </dd> </dl>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world generation job was created.</p>"
},
"failureCode":{
"shape":"WorldGenerationJobErrorCode",
"documentation":"<p>The failure code of the world generation job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>LimitExceeded</dt> <dd> <p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p> </dd> <dt>ResourceNotFound</dt> <dd> <p>The specified resource could not be found. </p> </dd> <dt>RequestThrottled</dt> <dd> <p>The request was throttled.</p> </dd> <dt>InvalidInput</dt> <dd> <p>An input parameter in the request is not valid.</p> </dd> </dl>"
},
"failureReason":{
"shape":"GenericString",
"documentation":"<p>The reason why the world generation job failed.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"template":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world template.</p>"
},
"worldCount":{
"shape":"WorldCount",
"documentation":"<p>Information about the world count.</p>"
},
"finishedWorldsSummary":{
"shape":"FinishedWorldsSummary",
"documentation":"<p>Summary information about finished worlds.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the world generation job.</p>"
},
"worldTags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the generated worlds.</p>"
}
}
},
"DescribeWorldRequest":{
"type":"structure",
"required":["world"],
"members":{
"world":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world you want to describe.</p>"
}
}
},
"DescribeWorldResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world.</p>"
},
"generationJob":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world generation job that generated the world.</p>"
},
"template":{
"shape":"Arn",
"documentation":"<p>The world template.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world was created.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the world.</p>"
}
}
},
"DescribeWorldTemplateRequest":{
"type":"structure",
"required":["template"],
"members":{
"template":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world template you want to describe.</p>"
}
}
},
"DescribeWorldTemplateResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the world template.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"name":{
"shape":"TemplateName",
"documentation":"<p>The name of the world template.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world template was created.</p>"
},
"lastUpdatedAt":{
"shape":"LastUpdatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world template was last updated.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the world template.</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>Boolean indicating whether a streaming session will be configured for the application. If <code>True</code>, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface. </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>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListDeploymentJobs</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </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>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListDeploymentJobs</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListFleets</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </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>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListFleets</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListRobotApplications</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </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>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListRobotApplications</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
}
}
},
"ListRobotsRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListRobots</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
},
"maxResults":{
"shape":"MaxResults",
"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>"
},
"filters":{
"shape":"Filters",
"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>"
}
}
},
"ListRobotsResponse":{
"type":"structure",
"members":{
"robots":{
"shape":"Robots",
"documentation":"<p>A list of robots that meet the criteria of the request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListRobots</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
}
}
},
"ListSimulationApplicationsRequest":{
"type":"structure",
"members":{
"versionQualifier":{
"shape":"VersionQualifier",
"documentation":"<p>The version qualifier of the simulation application.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationApplications</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
},
"maxResults":{
"shape":"MaxResults",
"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>"
},
"filters":{
"shape":"Filters",
"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>"
}
}
},
"ListSimulationApplicationsResponse":{
"type":"structure",
"members":{
"simulationApplicationSummaries":{
"shape":"SimulationApplicationSummaries",
"documentation":"<p>A list of simulation application summaries that meet the criteria of the request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationApplications</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
}
}
},
"ListSimulationJobBatchesRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationJobBatches</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </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>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationJobBatches</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
}
}
},
"ListSimulationJobsRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationJobs</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
},
"maxResults":{
"shape":"MaxResults",
"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>"
},
"filters":{
"shape":"Filters",
"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>"
}
}
},
"ListSimulationJobsResponse":{
"type":"structure",
"required":["simulationJobSummaries"],
"members":{
"simulationJobSummaries":{
"shape":"SimulationJobSummaries",
"documentation":"<p>A list of simulation job summaries that meet the criteria of the request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListSimulationJobs</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.</p>",
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorldExportJobs</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
"documentation":"<p>When this parameter is used, <code>ListWorldExportJobs</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>ListWorldExportJobs</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>ListWorldExportJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorldExportJobsRequest</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorldGenerationJobsRequest</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
"documentation":"<p>When this parameter is used, <code>ListWorldGeneratorJobs</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>ListWorldGeneratorJobs</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>ListWorldGeneratorJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorldGeneratorJobsRequest</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorldTemplates</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
"documentation":"<p>When this parameter is used, <code>ListWorldTemplates</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>ListWorldTemplates</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>ListWorldTemplates</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorldTemplates</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorlds</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </p>"
"documentation":"<p>When this parameter is used, <code>ListWorlds</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>ListWorlds</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>ListWorlds</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorlds</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. </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 upload configurations for the robot application.</p>"
},
"useDefaultUploadConfigurations":{
"shape":"BoxedBoolean",
"documentation":"<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>. </p>"
"documentation":"<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>. </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>"
"documentation":"<p>A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access. </p>"
"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>"
"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>A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path. </p> <p> For example, if your simulation output location is <code>s3://my-bucket</code> and your upload configuration name is <code>robot-test</code>, your files will be uploaded to <code>s3://my-bucket/<simid>/<runid>/robot-test</code>. </p>"
},
"path":{
"shape":"Path",
"documentation":"<p> Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of <code>**</code> as a <i>super asterisk</i>. For example, specifying <code>/var/log/**.log</code> causes all .log files in the <code>/var/log</code> directory tree to be collected. For more examples, see <a href=\"https://github.com/gobwas/glob\">Glob Library</a>. </p>"
},
"uploadBehavior":{
"shape":"UploadBehavior",
"documentation":"<p>Specifies how to upload the files:</p> <dl> <dt>UPLOAD_ON_TERMINATE</dt> <dd> <p>Matching files are uploaded once the simulation enters the <code>TERMINATING</code> state. Matching files are not uploaded until all of your code (including tools) have stopped. </p> <p>If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.</p> </dd> <dt>UPLOAD_ROLLING_AUTO_REMOVE</dt> <dd> <p>Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped. </p> </dd> </dl>"
}
},
"documentation":"<p>Provides upload configuration information. Files are uploaded from the simulation job to a location you specify. </p>"
"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>"
"documentation":"<p>The world generated by Simulation WorldForge.</p>"
}
},
"documentation":"<p>Configuration information for a world.</p>"
},
"WorldConfigs":{
"type":"list",
"member":{"shape":"WorldConfig"},
"max":1,
"min":0
},
"WorldCount":{
"type":"structure",
"members":{
"floorplanCount":{
"shape":"FloorplanCount",
"documentation":"<p>The number of unique floorplans.</p>"
},
"interiorCountPerFloorplan":{
"shape":"InteriorCountPerFloorplan",
"documentation":"<p>The number of unique interiors per floorplan.</p>"
}
},
"documentation":"<p>The number of worlds that will be created. You can configure the number of unique floorplans and the number of unique interiors for each floor plan. For example, if you want 1 world with 20 unique interiors, you set <code>floorplanCount = 1</code> and <code>interiorCountPerFloorplan = 20</code>. This will result in 20 worlds (<code>floorplanCount</code> * <code>interiorCountPerFloorplan)</code>. </p> <p>If you set <code>floorplanCount = 4</code> and <code>interiorCountPerFloorplan = 5</code>, there will be 20 worlds with 5 unique floor plans. </p>"
},
"WorldExportJobErrorCode":{
"type":"string",
"enum":[
"InternalServiceError",
"LimitExceeded",
"ResourceNotFound",
"RequestThrottled",
"InvalidInput",
"AccessDenied"
]
},
"WorldExportJobStatus":{
"type":"string",
"enum":[
"Pending",
"Running",
"Completed",
"Failed",
"Canceling",
"Canceled"
]
},
"WorldExportJobSummaries":{
"type":"list",
"member":{"shape":"WorldExportJobSummary"},
"max":100,
"min":0
},
"WorldExportJobSummary":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the world export job.</p>"
},
"status":{
"shape":"WorldExportJobStatus",
"documentation":"<p>The status of the world export job.</p> <dl> <dt>Pending</dt> <dd> <p>The world export job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world export job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world export job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world export job failed. See <code>failureCode</code> for more information. </p> </dd> <dt>Canceled</dt> <dd> <p>The world export job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world export job is being cancelled.</p> </dd> </dl>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world export job was created.</p>"
},
"worlds":{
"shape":"Arns",
"documentation":"<p>A list of worlds.</p>"
}
},
"documentation":"<p>Information about a world export job.</p>"
},
"WorldFailure":{
"type":"structure",
"members":{
"failureCode":{
"shape":"WorldGenerationJobErrorCode",
"documentation":"<p>The failure code of the world export job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>LimitExceeded</dt> <dd> <p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p> </dd> <dt>ResourceNotFound</dt> <dd> <p>The specified resource could not be found. </p> </dd> <dt>RequestThrottled</dt> <dd> <p>The request was throttled.</p> </dd> <dt>InvalidInput</dt> <dd> <p>An input parameter in the request is not valid.</p> </dd> </dl>"
},
"sampleFailureReason":{
"shape":"GenericString",
"documentation":"<p>The sample reason why the world failed. World errors are aggregated. A sample is used as the <code>sampleFailureReason</code>. </p>"
},
"failureCount":{
"shape":"Integer",
"documentation":"<p>The number of failed worlds.</p>"
}
},
"documentation":"<p>Information about a failed world.</p>"
},
"WorldFailures":{
"type":"list",
"member":{"shape":"WorldFailure"},
"max":100,
"min":0
},
"WorldGenerationJobErrorCode":{
"type":"string",
"enum":[
"InternalServiceError",
"LimitExceeded",
"ResourceNotFound",
"RequestThrottled",
"InvalidInput",
"AllWorldGenerationFailed"
]
},
"WorldGenerationJobStatus":{
"type":"string",
"enum":[
"Pending",
"Running",
"Completed",
"Failed",
"PartialFailed",
"Canceling",
"Canceled"
]
},
"WorldGenerationJobSummaries":{
"type":"list",
"member":{"shape":"WorldGenerationJobSummary"},
"max":100,
"min":0
},
"WorldGenerationJobSummary":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the world generator job.</p>"
},
"template":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world template.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world generator job was created.</p>"
},
"status":{
"shape":"WorldGenerationJobStatus",
"documentation":"<p>The status of the world generator job:</p> <dl> <dt>Pending</dt> <dd> <p>The world generator job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world generator job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world generator job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world generator job failed. See <code>failureCode</code> for more information. </p> </dd> <dt>PartialFailed</dt> <dd> <p>Some worlds did not generate.</p> </dd> <dt>Canceled</dt> <dd> <p>The world generator job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world generator job is being cancelled.</p> </dd> </dl>"
},
"worldCount":{
"shape":"WorldCount",
"documentation":"<p>Information about the world count.</p>"
},
"succeededWorldCount":{
"shape":"Integer",
"documentation":"<p>The number of worlds that were generated.</p>"
},
"failedWorldCount":{
"shape":"Integer",
"documentation":"<p>The number of worlds that failed.</p>"
}
},
"documentation":"<p>Information about a world generator job.</p>"
},
"WorldSummaries":{
"type":"list",
"member":{"shape":"WorldSummary"}
},
"WorldSummary":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the world.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the world was created.</p>"
},
"generationJob":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world generation job.</p>"
},
"template":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the world template.</p>"
}
},
"documentation":"<p>Information about a world.</p>"