Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Batch
Policy Information about the batch policy.
- Compute
Compute information for the simulation job.
- Compute
Response Compute information for the simulation job
- Data
Source Information about a data source.
- Data
Source Config Information about a data source.
- Deployment
Application Config Information about a deployment application configuration.
- Deployment
Config Information about a deployment configuration.
- Deployment
Job Information about a deployment job.
- Deployment
Launch Config Configuration information for a deployment launch.
- Environment
The object that contains the Docker image URI for either your robot or simulation applications.
- Failed
Create Simulation JobRequest Information about a failed create simulation job request.
- Failure
Summary Information about worlds that failed.
- Filter
Information about a filter.
- Finished
Worlds Summary Information about worlds that finished.
- Fleet
Information about a fleet.
- Launch
Config Information about a launch configuration.
- Logging
Config The logging configuration.
- Network
Interface Describes a network interface.
- Output
Location The output location.
- Port
Forwarding Config Configuration information for port forwarding.
- Port
Mapping An object representing a port mapping.
- Progress
Detail Information about the progress of a deployment job.
- Rendering
Engine Information about a rendering engine.
- Robot
Information about a robot.
- Robot
Application Config Application configuration information for a robot.
- Robot
Application Summary Summary information for a robot application.
- Robot
Deployment Information about a robot deployment.
- Robot
Software Suite Information about a robot software suite.
- S3Key
Output Information about S3 keys.
- S3Object
Information about an S3 object.
- Simulation
Application Config Information about a simulation application configuration.
- Simulation
Application Summary Summary information for a simulation application.
- Simulation
Job Information about a simulation job.
- Simulation
JobBatch Summary Information about a simulation job batch.
- Simulation
JobRequest Information about a simulation job request.
- Simulation
JobSummary Summary information for a simulation job.
- Simulation
Software Suite Information about a simulation software suite.
- Source
Information about a source.
- Source
Config Information about a source configuration.
- Template
Location Information about a template location.
- Template
Summary Summary information for a template.
- Tool
Information about a tool. Tools are used in a simulation job.
- Upload
Configuration Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
- VpcConfig
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.
- VpcConfig
Response VPC configuration associated with your simulation job.
- World
Config Configuration information for a world.
- World
Count 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
floorplanCount = 1
andinteriorCountPerFloorplan = 20
. This will result in 20 worlds (floorplanCount
*interiorCountPerFloorplan)
.If you set
floorplanCount = 4
andinteriorCountPerFloorplan = 5
, there will be 20 worlds with 5 unique floor plans.- World
Export JobSummary Information about a world export job.
- World
Failure Information about a failed world.
- World
Generation JobSummary Information about a world generator job.
- World
Summary Information about a world.
Enums§
- Architecture
- When writing a match expression against
Architecture
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Compute
Type - When writing a match expression against
ComputeType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Data
Source Type - When writing a match expression against
DataSourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Deployment
JobError Code - When writing a match expression against
DeploymentJobErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Deployment
Status - When writing a match expression against
DeploymentStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Exit
Behavior - When writing a match expression against
ExitBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Failure
Behavior - When writing a match expression against
FailureBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Rendering
Engine Type - When writing a match expression against
RenderingEngineType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Robot
Deployment Step - When writing a match expression against
RobotDeploymentStep
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Robot
Software Suite Type - When writing a match expression against
RobotSoftwareSuiteType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Robot
Software Suite Version Type - When writing a match expression against
RobotSoftwareSuiteVersionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Robot
Status - When writing a match expression against
RobotStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Simulation
JobBatch Error Code - When writing a match expression against
SimulationJobBatchErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Simulation
JobBatch Status - When writing a match expression against
SimulationJobBatchStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Simulation
JobError Code - When writing a match expression against
SimulationJobErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Simulation
JobStatus - When writing a match expression against
SimulationJobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Simulation
Software Suite Type - When writing a match expression against
SimulationSoftwareSuiteType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Upload
Behavior - When writing a match expression against
UploadBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - World
Export JobError Code - When writing a match expression against
WorldExportJobErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - World
Export JobStatus - When writing a match expression against
WorldExportJobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - World
Generation JobError Code - When writing a match expression against
WorldGenerationJobErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - World
Generation JobStatus - When writing a match expression against
WorldGenerationJobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.