Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- BatchDeleteWorlds
- BatchDescribeSimulationJob
- CancelSimulationJob
- CancelSimulationJobBatch
- CancelWorldExportJob
- CancelWorldGenerationJob
- CreateRobotApplication
- CreateRobotApplicationVersion
- CreateSimulationApplication
- CreateSimulationApplicationVersion
- CreateSimulationJob
- CreateWorldExportJob
- CreateWorldGenerationJob
- CreateWorldTemplate
- DeleteRobotApplication
- DeleteSimulationApplication
- DeleteWorldTemplate
- DescribeRobotApplication
- DescribeSimulationApplication
- DescribeSimulationJob
- DescribeSimulationJobBatch
- DescribeWorld
- DescribeWorldExportJob
- DescribeWorldGenerationJob
- DescribeWorldTemplate
- GetWorldTemplateBody
- ListRobotApplications (Paginated)
- ListSimulationApplications (Paginated)
- ListSimulationJobBatches (Paginated)
- ListSimulationJobs (Paginated)
- ListTagsForResource
- ListWorldExportJobs (Paginated)
- ListWorldGenerationJobs (Paginated)
- ListWorldTemplates (Paginated)
- ListWorlds (Paginated)
- RestartSimulationJob
- StartSimulationJobBatch
- TagResource
- UntagResource
- UpdateRobotApplication
- UpdateSimulationApplication
- UpdateWorldTemplate
- Types
- Architecture
- ComputeType
- DataSourceType
- ExitBehavior
- FailureBehavior
- RenderingEngineType
- RobotSoftwareSuiteType
- RobotSoftwareSuiteVersionType
- SimulationJobBatchErrorCode
- SimulationJobBatchStatus
- SimulationJobErrorCode
- SimulationJobStatus
- SimulationSoftwareSuiteType
- UploadBehavior
- WorldExportJobErrorCode
- WorldExportJobStatus
- WorldGenerationJobErrorCode
- WorldGenerationJobStatus
- BatchPolicy
- Compute
- ComputeResponse
- DataSource
- DataSourceConfig
- Environment
- FailedCreateSimulationJobRequest
- FailureSummary
- Filter
- FinishedWorldsSummary
- LaunchConfig
- LoggingConfig
- NetworkInterface
- OutputLocation
- PortForwardingConfig
- PortMapping
- RenderingEngine
- RobotApplicationConfig
- RobotApplicationSummary
- RobotSoftwareSuite
- S3KeyOutput
- SimulationApplicationConfig
- SimulationApplicationSummary
- SimulationJob
- SimulationJobBatchSummary
- SimulationJobRequest
- SimulationJobSummary
- SimulationSoftwareSuite
- Source
- SourceConfig
- TemplateLocation
- TemplateSummary
- Tool
- UploadConfiguration
- VPCConfig
- VPCConfigResponse
- WorldConfig
- WorldCount
- WorldExportJobSummary
- WorldFailure
- WorldGenerationJobSummary
- WorldSummary
Derived from API version 2018-06-29
of the AWS service descriptions, licensed under Apache 2.0.
This section provides documentation for the AWS RoboMaker API operations.
Synopsis
- defaultService :: Service
- _ConcurrentDeploymentException :: AsError a => Fold a ServiceError
- _IdempotentParameterMismatchException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- data BatchDeleteWorlds = BatchDeleteWorlds' (NonEmpty Text)
- newBatchDeleteWorlds :: NonEmpty Text -> BatchDeleteWorlds
- data BatchDeleteWorldsResponse = BatchDeleteWorldsResponse' (Maybe (NonEmpty Text)) Int
- newBatchDeleteWorldsResponse :: Int -> BatchDeleteWorldsResponse
- data BatchDescribeSimulationJob = BatchDescribeSimulationJob' (NonEmpty Text)
- newBatchDescribeSimulationJob :: NonEmpty Text -> BatchDescribeSimulationJob
- data BatchDescribeSimulationJobResponse = BatchDescribeSimulationJobResponse' (Maybe [SimulationJob]) (Maybe (NonEmpty Text)) Int
- newBatchDescribeSimulationJobResponse :: Int -> BatchDescribeSimulationJobResponse
- data CancelSimulationJob = CancelSimulationJob' Text
- newCancelSimulationJob :: Text -> CancelSimulationJob
- data CancelSimulationJobResponse = CancelSimulationJobResponse' Int
- newCancelSimulationJobResponse :: Int -> CancelSimulationJobResponse
- data CancelSimulationJobBatch = CancelSimulationJobBatch' Text
- newCancelSimulationJobBatch :: Text -> CancelSimulationJobBatch
- data CancelSimulationJobBatchResponse = CancelSimulationJobBatchResponse' Int
- newCancelSimulationJobBatchResponse :: Int -> CancelSimulationJobBatchResponse
- data CancelWorldExportJob = CancelWorldExportJob' Text
- newCancelWorldExportJob :: Text -> CancelWorldExportJob
- data CancelWorldExportJobResponse = CancelWorldExportJobResponse' Int
- newCancelWorldExportJobResponse :: Int -> CancelWorldExportJobResponse
- data CancelWorldGenerationJob = CancelWorldGenerationJob' Text
- newCancelWorldGenerationJob :: Text -> CancelWorldGenerationJob
- data CancelWorldGenerationJobResponse = CancelWorldGenerationJobResponse' Int
- newCancelWorldGenerationJobResponse :: Int -> CancelWorldGenerationJobResponse
- data CreateRobotApplication = CreateRobotApplication' (Maybe Environment) (Maybe [SourceConfig]) (Maybe (HashMap Text Text)) Text RobotSoftwareSuite
- newCreateRobotApplication :: Text -> RobotSoftwareSuite -> CreateRobotApplication
- data CreateRobotApplicationResponse = CreateRobotApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe [Source]) (Maybe (HashMap Text Text)) (Maybe Text) Int
- newCreateRobotApplicationResponse :: Int -> CreateRobotApplicationResponse
- data CreateRobotApplicationVersion = CreateRobotApplicationVersion' (Maybe Text) (Maybe Text) (Maybe [Text]) Text
- newCreateRobotApplicationVersion :: Text -> CreateRobotApplicationVersion
- data CreateRobotApplicationVersionResponse = CreateRobotApplicationVersionResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe [Source]) (Maybe Text) Int
- newCreateRobotApplicationVersionResponse :: Int -> CreateRobotApplicationVersionResponse
- data CreateSimulationApplication = CreateSimulationApplication' (Maybe Environment) (Maybe RenderingEngine) (Maybe [SourceConfig]) (Maybe (HashMap Text Text)) Text SimulationSoftwareSuite RobotSoftwareSuite
- newCreateSimulationApplication :: Text -> SimulationSoftwareSuite -> RobotSoftwareSuite -> CreateSimulationApplication
- data CreateSimulationApplicationResponse = CreateSimulationApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe RenderingEngine) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe SimulationSoftwareSuite) (Maybe [Source]) (Maybe (HashMap Text Text)) (Maybe Text) Int
- newCreateSimulationApplicationResponse :: Int -> CreateSimulationApplicationResponse
- data CreateSimulationApplicationVersion = CreateSimulationApplicationVersion' (Maybe Text) (Maybe Text) (Maybe [Text]) Text
- newCreateSimulationApplicationVersion :: Text -> CreateSimulationApplicationVersion
- data CreateSimulationApplicationVersionResponse = CreateSimulationApplicationVersionResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe RenderingEngine) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe SimulationSoftwareSuite) (Maybe [Source]) (Maybe Text) Int
- newCreateSimulationApplicationVersionResponse :: Int -> CreateSimulationApplicationVersionResponse
- data CreateSimulationJob = CreateSimulationJob' (Maybe Text) (Maybe Compute) (Maybe (NonEmpty DataSourceConfig)) (Maybe FailureBehavior) (Maybe LoggingConfig) (Maybe OutputLocation) (Maybe (NonEmpty RobotApplicationConfig)) (Maybe (NonEmpty SimulationApplicationConfig)) (Maybe (HashMap Text Text)) (Maybe VPCConfig) Integer Text
- newCreateSimulationJob :: Integer -> Text -> CreateSimulationJob
- data CreateSimulationJobResponse = CreateSimulationJobResponse' (Maybe Text) (Maybe Text) (Maybe ComputeResponse) (Maybe [DataSource]) (Maybe FailureBehavior) (Maybe SimulationJobErrorCode) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe LoggingConfig) (Maybe Integer) (Maybe OutputLocation) (Maybe (NonEmpty RobotApplicationConfig)) (Maybe (NonEmpty SimulationApplicationConfig)) (Maybe Integer) (Maybe SimulationJobStatus) (Maybe (HashMap Text Text)) (Maybe VPCConfigResponse) Int
- newCreateSimulationJobResponse :: Int -> CreateSimulationJobResponse
- data CreateWorldExportJob = CreateWorldExportJob' (Maybe Text) (Maybe (HashMap Text Text)) (NonEmpty Text) OutputLocation Text
- newCreateWorldExportJob :: NonEmpty Text -> OutputLocation -> Text -> CreateWorldExportJob
- data CreateWorldExportJobResponse = CreateWorldExportJobResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe WorldExportJobErrorCode) (Maybe Text) (Maybe OutputLocation) (Maybe WorldExportJobStatus) (Maybe (HashMap Text Text)) Int
- newCreateWorldExportJobResponse :: Int -> CreateWorldExportJobResponse
- data CreateWorldGenerationJob = CreateWorldGenerationJob' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text WorldCount
- newCreateWorldGenerationJob :: Text -> WorldCount -> CreateWorldGenerationJob
- data CreateWorldGenerationJobResponse = CreateWorldGenerationJobResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe WorldGenerationJobErrorCode) (Maybe WorldGenerationJobStatus) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe WorldCount) (Maybe (HashMap Text Text)) Int
- newCreateWorldGenerationJobResponse :: Int -> CreateWorldGenerationJobResponse
- data CreateWorldTemplate = CreateWorldTemplate' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe TemplateLocation)
- newCreateWorldTemplate :: CreateWorldTemplate
- data CreateWorldTemplateResponse = CreateWorldTemplateResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newCreateWorldTemplateResponse :: Int -> CreateWorldTemplateResponse
- data DeleteRobotApplication = DeleteRobotApplication' (Maybe Text) Text
- newDeleteRobotApplication :: Text -> DeleteRobotApplication
- data DeleteRobotApplicationResponse = DeleteRobotApplicationResponse' Int
- newDeleteRobotApplicationResponse :: Int -> DeleteRobotApplicationResponse
- data DeleteSimulationApplication = DeleteSimulationApplication' (Maybe Text) Text
- newDeleteSimulationApplication :: Text -> DeleteSimulationApplication
- data DeleteSimulationApplicationResponse = DeleteSimulationApplicationResponse' Int
- newDeleteSimulationApplicationResponse :: Int -> DeleteSimulationApplicationResponse
- data DeleteWorldTemplate = DeleteWorldTemplate' Text
- newDeleteWorldTemplate :: Text -> DeleteWorldTemplate
- data DeleteWorldTemplateResponse = DeleteWorldTemplateResponse' Int
- newDeleteWorldTemplateResponse :: Int -> DeleteWorldTemplateResponse
- data DescribeRobotApplication = DescribeRobotApplication' (Maybe Text) Text
- newDescribeRobotApplication :: Text -> DescribeRobotApplication
- data DescribeRobotApplicationResponse = DescribeRobotApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe [Source]) (Maybe (HashMap Text Text)) (Maybe Text) Int
- newDescribeRobotApplicationResponse :: Int -> DescribeRobotApplicationResponse
- data DescribeSimulationApplication = DescribeSimulationApplication' (Maybe Text) Text
- newDescribeSimulationApplication :: Text -> DescribeSimulationApplication
- data DescribeSimulationApplicationResponse = DescribeSimulationApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe RenderingEngine) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe SimulationSoftwareSuite) (Maybe [Source]) (Maybe (HashMap Text Text)) (Maybe Text) Int
- newDescribeSimulationApplicationResponse :: Int -> DescribeSimulationApplicationResponse
- data DescribeSimulationJob = DescribeSimulationJob' Text
- newDescribeSimulationJob :: Text -> DescribeSimulationJob
- data DescribeSimulationJobResponse = DescribeSimulationJobResponse' (Maybe Text) (Maybe Text) (Maybe ComputeResponse) (Maybe [DataSource]) (Maybe FailureBehavior) (Maybe SimulationJobErrorCode) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe LoggingConfig) (Maybe Integer) (Maybe Text) (Maybe NetworkInterface) (Maybe OutputLocation) (Maybe (NonEmpty RobotApplicationConfig)) (Maybe (NonEmpty SimulationApplicationConfig)) (Maybe Integer) (Maybe SimulationJobStatus) (Maybe (HashMap Text Text)) (Maybe VPCConfigResponse) Int
- newDescribeSimulationJobResponse :: Int -> DescribeSimulationJobResponse
- data DescribeSimulationJobBatch = DescribeSimulationJobBatch' Text
- newDescribeSimulationJobBatch :: Text -> DescribeSimulationJobBatch
- data DescribeSimulationJobBatchResponse = DescribeSimulationJobBatchResponse' (Maybe Text) (Maybe BatchPolicy) (Maybe Text) (Maybe POSIX) (Maybe [SimulationJobSummary]) (Maybe [FailedCreateSimulationJobRequest]) (Maybe SimulationJobBatchErrorCode) (Maybe Text) (Maybe POSIX) (Maybe (NonEmpty SimulationJobRequest)) (Maybe SimulationJobBatchStatus) (Maybe (HashMap Text Text)) Int
- newDescribeSimulationJobBatchResponse :: Int -> DescribeSimulationJobBatchResponse
- data DescribeWorld = DescribeWorld' Text
- newDescribeWorld :: Text -> DescribeWorld
- data DescribeWorldResponse = DescribeWorldResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) Int
- newDescribeWorldResponse :: Int -> DescribeWorldResponse
- data DescribeWorldExportJob = DescribeWorldExportJob' Text
- newDescribeWorldExportJob :: Text -> DescribeWorldExportJob
- data DescribeWorldExportJobResponse = DescribeWorldExportJobResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe WorldExportJobErrorCode) (Maybe Text) (Maybe Text) (Maybe OutputLocation) (Maybe WorldExportJobStatus) (Maybe (HashMap Text Text)) (Maybe (NonEmpty Text)) Int
- newDescribeWorldExportJobResponse :: Int -> DescribeWorldExportJobResponse
- data DescribeWorldGenerationJob = DescribeWorldGenerationJob' Text
- newDescribeWorldGenerationJob :: Text -> DescribeWorldGenerationJob
- data DescribeWorldGenerationJobResponse = DescribeWorldGenerationJobResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe WorldGenerationJobErrorCode) (Maybe Text) (Maybe FinishedWorldsSummary) (Maybe WorldGenerationJobStatus) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe WorldCount) (Maybe (HashMap Text Text)) Int
- newDescribeWorldGenerationJobResponse :: Int -> DescribeWorldGenerationJobResponse
- data DescribeWorldTemplate = DescribeWorldTemplate' Text
- newDescribeWorldTemplate :: Text -> DescribeWorldTemplate
- data DescribeWorldTemplateResponse = DescribeWorldTemplateResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Int
- newDescribeWorldTemplateResponse :: Int -> DescribeWorldTemplateResponse
- data GetWorldTemplateBody = GetWorldTemplateBody' (Maybe Text) (Maybe Text)
- newGetWorldTemplateBody :: GetWorldTemplateBody
- data GetWorldTemplateBodyResponse = GetWorldTemplateBodyResponse' (Maybe Text) Int
- newGetWorldTemplateBodyResponse :: Int -> GetWorldTemplateBodyResponse
- data ListRobotApplications = ListRobotApplications' (Maybe (NonEmpty Filter)) (Maybe Int) (Maybe Text) (Maybe Text)
- newListRobotApplications :: ListRobotApplications
- data ListRobotApplicationsResponse = ListRobotApplicationsResponse' (Maybe Text) (Maybe [RobotApplicationSummary]) Int
- newListRobotApplicationsResponse :: Int -> ListRobotApplicationsResponse
- data ListSimulationApplications = ListSimulationApplications' (Maybe (NonEmpty Filter)) (Maybe Int) (Maybe Text) (Maybe Text)
- newListSimulationApplications :: ListSimulationApplications
- data ListSimulationApplicationsResponse = ListSimulationApplicationsResponse' (Maybe Text) (Maybe [SimulationApplicationSummary]) Int
- newListSimulationApplicationsResponse :: Int -> ListSimulationApplicationsResponse
- data ListSimulationJobBatches = ListSimulationJobBatches' (Maybe (NonEmpty Filter)) (Maybe Int) (Maybe Text)
- newListSimulationJobBatches :: ListSimulationJobBatches
- data ListSimulationJobBatchesResponse = ListSimulationJobBatchesResponse' (Maybe Text) (Maybe [SimulationJobBatchSummary]) Int
- newListSimulationJobBatchesResponse :: Int -> ListSimulationJobBatchesResponse
- data ListSimulationJobs = ListSimulationJobs' (Maybe (NonEmpty Filter)) (Maybe Int) (Maybe Text)
- newListSimulationJobs :: ListSimulationJobs
- data ListSimulationJobsResponse = ListSimulationJobsResponse' (Maybe Text) Int [SimulationJobSummary]
- newListSimulationJobsResponse :: Int -> ListSimulationJobsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListWorldExportJobs = ListWorldExportJobs' (Maybe (NonEmpty Filter)) (Maybe Int) (Maybe Text)
- newListWorldExportJobs :: ListWorldExportJobs
- data ListWorldExportJobsResponse = ListWorldExportJobsResponse' (Maybe Text) Int [WorldExportJobSummary]
- newListWorldExportJobsResponse :: Int -> ListWorldExportJobsResponse
- data ListWorldGenerationJobs = ListWorldGenerationJobs' (Maybe (NonEmpty Filter)) (Maybe Int) (Maybe Text)
- newListWorldGenerationJobs :: ListWorldGenerationJobs
- data ListWorldGenerationJobsResponse = ListWorldGenerationJobsResponse' (Maybe Text) Int [WorldGenerationJobSummary]
- newListWorldGenerationJobsResponse :: Int -> ListWorldGenerationJobsResponse
- data ListWorldTemplates = ListWorldTemplates' (Maybe Int) (Maybe Text)
- newListWorldTemplates :: ListWorldTemplates
- data ListWorldTemplatesResponse = ListWorldTemplatesResponse' (Maybe Text) (Maybe [TemplateSummary]) Int
- newListWorldTemplatesResponse :: Int -> ListWorldTemplatesResponse
- data ListWorlds = ListWorlds' (Maybe (NonEmpty Filter)) (Maybe Int) (Maybe Text)
- newListWorlds :: ListWorlds
- data ListWorldsResponse = ListWorldsResponse' (Maybe Text) (Maybe [WorldSummary]) Int
- newListWorldsResponse :: Int -> ListWorldsResponse
- data RestartSimulationJob = RestartSimulationJob' Text
- newRestartSimulationJob :: Text -> RestartSimulationJob
- data RestartSimulationJobResponse = RestartSimulationJobResponse' Int
- newRestartSimulationJobResponse :: Int -> RestartSimulationJobResponse
- data StartSimulationJobBatch = StartSimulationJobBatch' (Maybe BatchPolicy) (Maybe Text) (Maybe (HashMap Text Text)) (NonEmpty SimulationJobRequest)
- newStartSimulationJobBatch :: NonEmpty SimulationJobRequest -> StartSimulationJobBatch
- data StartSimulationJobBatchResponse = StartSimulationJobBatchResponse' (Maybe Text) (Maybe BatchPolicy) (Maybe Text) (Maybe POSIX) (Maybe [SimulationJobSummary]) (Maybe [FailedCreateSimulationJobRequest]) (Maybe SimulationJobBatchErrorCode) (Maybe Text) (Maybe (NonEmpty SimulationJobRequest)) (Maybe SimulationJobBatchStatus) (Maybe (HashMap Text Text)) Int
- newStartSimulationJobBatchResponse :: Int -> StartSimulationJobBatchResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateRobotApplication = UpdateRobotApplication' (Maybe Text) (Maybe Environment) (Maybe [SourceConfig]) Text RobotSoftwareSuite
- newUpdateRobotApplication :: Text -> RobotSoftwareSuite -> UpdateRobotApplication
- data UpdateRobotApplicationResponse = UpdateRobotApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe [Source]) (Maybe Text) Int
- newUpdateRobotApplicationResponse :: Int -> UpdateRobotApplicationResponse
- data UpdateSimulationApplication = UpdateSimulationApplication' (Maybe Text) (Maybe Environment) (Maybe RenderingEngine) (Maybe [SourceConfig]) Text SimulationSoftwareSuite RobotSoftwareSuite
- newUpdateSimulationApplication :: Text -> SimulationSoftwareSuite -> RobotSoftwareSuite -> UpdateSimulationApplication
- data UpdateSimulationApplicationResponse = UpdateSimulationApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe RenderingEngine) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe SimulationSoftwareSuite) (Maybe [Source]) (Maybe Text) Int
- newUpdateSimulationApplicationResponse :: Int -> UpdateSimulationApplicationResponse
- data UpdateWorldTemplate = UpdateWorldTemplate' (Maybe Text) (Maybe Text) (Maybe TemplateLocation) Text
- newUpdateWorldTemplate :: Text -> UpdateWorldTemplate
- data UpdateWorldTemplateResponse = UpdateWorldTemplateResponse' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) Int
- newUpdateWorldTemplateResponse :: Int -> UpdateWorldTemplateResponse
- newtype Architecture where
- Architecture' { }
- pattern Architecture_ARM64 :: Architecture
- pattern Architecture_ARMHF :: Architecture
- pattern Architecture_X86_64 :: Architecture
- newtype ComputeType where
- ComputeType' { }
- pattern ComputeType_CPU :: ComputeType
- pattern ComputeType_GPU_AND_CPU :: ComputeType
- newtype DataSourceType where
- DataSourceType' { }
- pattern DataSourceType_Archive :: DataSourceType
- pattern DataSourceType_File :: DataSourceType
- pattern DataSourceType_Prefix :: DataSourceType
- newtype ExitBehavior where
- ExitBehavior' { }
- pattern ExitBehavior_FAIL :: ExitBehavior
- pattern ExitBehavior_RESTART :: ExitBehavior
- newtype FailureBehavior where
- FailureBehavior' { }
- pattern FailureBehavior_Continue :: FailureBehavior
- pattern FailureBehavior_Fail :: FailureBehavior
- newtype RenderingEngineType where
- newtype RobotSoftwareSuiteType where
- newtype RobotSoftwareSuiteVersionType where
- RobotSoftwareSuiteVersionType' { }
- pattern RobotSoftwareSuiteVersionType_Dashing :: RobotSoftwareSuiteVersionType
- pattern RobotSoftwareSuiteVersionType_Foxy :: RobotSoftwareSuiteVersionType
- pattern RobotSoftwareSuiteVersionType_Kinetic :: RobotSoftwareSuiteVersionType
- pattern RobotSoftwareSuiteVersionType_Melodic :: RobotSoftwareSuiteVersionType
- newtype SimulationJobBatchErrorCode where
- newtype SimulationJobBatchStatus where
- SimulationJobBatchStatus' { }
- pattern SimulationJobBatchStatus_Canceled :: SimulationJobBatchStatus
- pattern SimulationJobBatchStatus_Canceling :: SimulationJobBatchStatus
- pattern SimulationJobBatchStatus_Completed :: SimulationJobBatchStatus
- pattern SimulationJobBatchStatus_Completing :: SimulationJobBatchStatus
- pattern SimulationJobBatchStatus_Failed :: SimulationJobBatchStatus
- pattern SimulationJobBatchStatus_InProgress :: SimulationJobBatchStatus
- pattern SimulationJobBatchStatus_Pending :: SimulationJobBatchStatus
- pattern SimulationJobBatchStatus_TimedOut :: SimulationJobBatchStatus
- pattern SimulationJobBatchStatus_TimingOut :: SimulationJobBatchStatus
- newtype SimulationJobErrorCode where
- SimulationJobErrorCode' { }
- pattern SimulationJobErrorCode_BadPermissionsCloudwatchLogs :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_BadPermissionsRobotApplication :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_BadPermissionsS3Object :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_BadPermissionsS3Output :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_BadPermissionsSimulationApplication :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_BadPermissionsUserCredentials :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_BatchCanceled :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_BatchTimedOut :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_ENILimitExceeded :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_InternalServiceError :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_InvalidBundleRobotApplication :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_InvalidBundleSimulationApplication :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_InvalidInput :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_InvalidS3Resource :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_LimitExceeded :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_MismatchedEtag :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_RequestThrottled :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_ResourceNotFound :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_RobotApplicationCrash :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_RobotApplicationHealthCheckFailure :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_RobotApplicationVersionMismatchedEtag :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_SimulationApplicationCrash :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_SimulationApplicationHealthCheckFailure :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_SimulationApplicationVersionMismatchedEtag :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_SubnetIpLimitExceeded :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_ThrottlingError :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_UploadContentMismatchError :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_WrongRegionRobotApplication :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_WrongRegionS3Bucket :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_WrongRegionS3Output :: SimulationJobErrorCode
- pattern SimulationJobErrorCode_WrongRegionSimulationApplication :: SimulationJobErrorCode
- newtype SimulationJobStatus where
- SimulationJobStatus' { }
- pattern SimulationJobStatus_Canceled :: SimulationJobStatus
- pattern SimulationJobStatus_Completed :: SimulationJobStatus
- pattern SimulationJobStatus_Failed :: SimulationJobStatus
- pattern SimulationJobStatus_Pending :: SimulationJobStatus
- pattern SimulationJobStatus_Preparing :: SimulationJobStatus
- pattern SimulationJobStatus_Restarting :: SimulationJobStatus
- pattern SimulationJobStatus_Running :: SimulationJobStatus
- pattern SimulationJobStatus_RunningFailed :: SimulationJobStatus
- pattern SimulationJobStatus_Terminated :: SimulationJobStatus
- pattern SimulationJobStatus_Terminating :: SimulationJobStatus
- newtype SimulationSoftwareSuiteType where
- newtype UploadBehavior where
- newtype WorldExportJobErrorCode where
- WorldExportJobErrorCode' { }
- pattern WorldExportJobErrorCode_AccessDenied :: WorldExportJobErrorCode
- pattern WorldExportJobErrorCode_InternalServiceError :: WorldExportJobErrorCode
- pattern WorldExportJobErrorCode_InvalidInput :: WorldExportJobErrorCode
- pattern WorldExportJobErrorCode_LimitExceeded :: WorldExportJobErrorCode
- pattern WorldExportJobErrorCode_RequestThrottled :: WorldExportJobErrorCode
- pattern WorldExportJobErrorCode_ResourceNotFound :: WorldExportJobErrorCode
- newtype WorldExportJobStatus where
- WorldExportJobStatus' { }
- pattern WorldExportJobStatus_Canceled :: WorldExportJobStatus
- pattern WorldExportJobStatus_Canceling :: WorldExportJobStatus
- pattern WorldExportJobStatus_Completed :: WorldExportJobStatus
- pattern WorldExportJobStatus_Failed :: WorldExportJobStatus
- pattern WorldExportJobStatus_Pending :: WorldExportJobStatus
- pattern WorldExportJobStatus_Running :: WorldExportJobStatus
- newtype WorldGenerationJobErrorCode where
- WorldGenerationJobErrorCode' { }
- pattern WorldGenerationJobErrorCode_AllWorldGenerationFailed :: WorldGenerationJobErrorCode
- pattern WorldGenerationJobErrorCode_InternalServiceError :: WorldGenerationJobErrorCode
- pattern WorldGenerationJobErrorCode_InvalidInput :: WorldGenerationJobErrorCode
- pattern WorldGenerationJobErrorCode_LimitExceeded :: WorldGenerationJobErrorCode
- pattern WorldGenerationJobErrorCode_RequestThrottled :: WorldGenerationJobErrorCode
- pattern WorldGenerationJobErrorCode_ResourceNotFound :: WorldGenerationJobErrorCode
- newtype WorldGenerationJobStatus where
- WorldGenerationJobStatus' { }
- pattern WorldGenerationJobStatus_Canceled :: WorldGenerationJobStatus
- pattern WorldGenerationJobStatus_Canceling :: WorldGenerationJobStatus
- pattern WorldGenerationJobStatus_Completed :: WorldGenerationJobStatus
- pattern WorldGenerationJobStatus_Failed :: WorldGenerationJobStatus
- pattern WorldGenerationJobStatus_PartialFailed :: WorldGenerationJobStatus
- pattern WorldGenerationJobStatus_Pending :: WorldGenerationJobStatus
- pattern WorldGenerationJobStatus_Running :: WorldGenerationJobStatus
- data BatchPolicy = BatchPolicy' (Maybe Int) (Maybe Integer)
- newBatchPolicy :: BatchPolicy
- data Compute = Compute' (Maybe ComputeType) (Maybe Natural) (Maybe Natural)
- newCompute :: Compute
- data ComputeResponse = ComputeResponse' (Maybe ComputeType) (Maybe Natural) (Maybe Natural)
- newComputeResponse :: ComputeResponse
- data DataSource = DataSource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [S3KeyOutput]) (Maybe DataSourceType)
- newDataSource :: DataSource
- data DataSourceConfig = DataSourceConfig' (Maybe Text) (Maybe DataSourceType) Text Text (NonEmpty Text)
- newDataSourceConfig :: Text -> Text -> NonEmpty Text -> DataSourceConfig
- data Environment = Environment' (Maybe Text)
- newEnvironment :: Environment
- data FailedCreateSimulationJobRequest = FailedCreateSimulationJobRequest' (Maybe POSIX) (Maybe SimulationJobErrorCode) (Maybe Text) (Maybe SimulationJobRequest)
- newFailedCreateSimulationJobRequest :: FailedCreateSimulationJobRequest
- data FailureSummary = FailureSummary' (Maybe [WorldFailure]) (Maybe Int)
- newFailureSummary :: FailureSummary
- data Filter = Filter' (Maybe Text) (Maybe (NonEmpty Text))
- newFilter :: Filter
- data FinishedWorldsSummary = FinishedWorldsSummary' (Maybe FailureSummary) (Maybe Int) (Maybe (NonEmpty Text))
- newFinishedWorldsSummary :: FinishedWorldsSummary
- data LaunchConfig = LaunchConfig' (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe PortForwardingConfig) (Maybe Bool)
- newLaunchConfig :: LaunchConfig
- data LoggingConfig = LoggingConfig' (Maybe Bool)
- newLoggingConfig :: LoggingConfig
- data NetworkInterface = NetworkInterface' (Maybe Text) (Maybe Text) (Maybe Text)
- newNetworkInterface :: NetworkInterface
- data OutputLocation = OutputLocation' (Maybe Text) (Maybe Text)
- newOutputLocation :: OutputLocation
- data PortForwardingConfig = PortForwardingConfig' (Maybe [PortMapping])
- newPortForwardingConfig :: PortForwardingConfig
- data PortMapping = PortMapping' (Maybe Bool) Natural Natural
- newPortMapping :: Natural -> Natural -> PortMapping
- data RenderingEngine = RenderingEngine' (Maybe RenderingEngineType) (Maybe Text)
- newRenderingEngine :: RenderingEngine
- data RobotApplicationConfig = RobotApplicationConfig' (Maybe Text) (Maybe [Tool]) (Maybe [UploadConfiguration]) (Maybe Bool) (Maybe Bool) Text LaunchConfig
- newRobotApplicationConfig :: Text -> LaunchConfig -> RobotApplicationConfig
- data RobotApplicationSummary = RobotApplicationSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe Text)
- newRobotApplicationSummary :: RobotApplicationSummary
- data RobotSoftwareSuite = RobotSoftwareSuite' (Maybe RobotSoftwareSuiteType) (Maybe RobotSoftwareSuiteVersionType)
- newRobotSoftwareSuite :: RobotSoftwareSuite
- data S3KeyOutput = S3KeyOutput' (Maybe Text) (Maybe Text)
- newS3KeyOutput :: S3KeyOutput
- data SimulationApplicationConfig = SimulationApplicationConfig' (Maybe Text) (Maybe [Tool]) (Maybe [UploadConfiguration]) (Maybe Bool) (Maybe Bool) (Maybe [WorldConfig]) Text LaunchConfig
- newSimulationApplicationConfig :: Text -> LaunchConfig -> SimulationApplicationConfig
- data SimulationApplicationSummary = SimulationApplicationSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe SimulationSoftwareSuite) (Maybe Text)
- newSimulationApplicationSummary :: SimulationApplicationSummary
- data SimulationJob = SimulationJob' (Maybe Text) (Maybe Text) (Maybe ComputeResponse) (Maybe [DataSource]) (Maybe FailureBehavior) (Maybe SimulationJobErrorCode) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe LoggingConfig) (Maybe Integer) (Maybe Text) (Maybe NetworkInterface) (Maybe OutputLocation) (Maybe (NonEmpty RobotApplicationConfig)) (Maybe (NonEmpty SimulationApplicationConfig)) (Maybe Integer) (Maybe SimulationJobStatus) (Maybe (HashMap Text Text)) (Maybe VPCConfigResponse)
- newSimulationJob :: SimulationJob
- data SimulationJobBatchSummary = SimulationJobBatchSummary' (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Int) (Maybe POSIX) (Maybe Int) (Maybe SimulationJobBatchStatus)
- newSimulationJobBatchSummary :: SimulationJobBatchSummary
- data SimulationJobRequest = SimulationJobRequest' (Maybe Compute) (Maybe (NonEmpty DataSourceConfig)) (Maybe FailureBehavior) (Maybe Text) (Maybe LoggingConfig) (Maybe OutputLocation) (Maybe (NonEmpty RobotApplicationConfig)) (Maybe (NonEmpty SimulationApplicationConfig)) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe VPCConfig) Integer
- newSimulationJobRequest :: Integer -> SimulationJobRequest
- data SimulationJobSummary = SimulationJobSummary' (Maybe Text) (Maybe ComputeType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe SimulationJobStatus)
- newSimulationJobSummary :: SimulationJobSummary
- data SimulationSoftwareSuite = SimulationSoftwareSuite' (Maybe SimulationSoftwareSuiteType) (Maybe Text)
- newSimulationSoftwareSuite :: SimulationSoftwareSuite
- data Source = Source' (Maybe Architecture) (Maybe Text) (Maybe Text) (Maybe Text)
- newSource :: Source
- data SourceConfig = SourceConfig' (Maybe Architecture) (Maybe Text) (Maybe Text)
- newSourceConfig :: SourceConfig
- data TemplateLocation = TemplateLocation' Text Text
- newTemplateLocation :: Text -> Text -> TemplateLocation
- data TemplateSummary = TemplateSummary' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newTemplateSummary :: TemplateSummary
- data Tool = Tool' (Maybe ExitBehavior) (Maybe Bool) (Maybe Bool) Text Text
- newTool :: Text -> Text -> Tool
- data UploadConfiguration = UploadConfiguration' Text Text UploadBehavior
- newUploadConfiguration :: Text -> Text -> UploadBehavior -> UploadConfiguration
- data VPCConfig = VPCConfig' (Maybe Bool) (Maybe (NonEmpty Text)) (NonEmpty Text)
- newVPCConfig :: NonEmpty Text -> VPCConfig
- data VPCConfigResponse = VPCConfigResponse' (Maybe Bool) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe Text)
- newVPCConfigResponse :: VPCConfigResponse
- data WorldConfig = WorldConfig' (Maybe Text)
- newWorldConfig :: WorldConfig
- data WorldCount = WorldCount' (Maybe Int) (Maybe Int)
- newWorldCount :: WorldCount
- data WorldExportJobSummary = WorldExportJobSummary' (Maybe Text) (Maybe POSIX) (Maybe OutputLocation) (Maybe WorldExportJobStatus) (Maybe (NonEmpty Text))
- newWorldExportJobSummary :: WorldExportJobSummary
- data WorldFailure = WorldFailure' (Maybe WorldGenerationJobErrorCode) (Maybe Int) (Maybe Text)
- newWorldFailure :: WorldFailure
- data WorldGenerationJobSummary = WorldGenerationJobSummary' (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe WorldGenerationJobStatus) (Maybe Int) (Maybe Text) (Maybe WorldCount)
- newWorldGenerationJobSummary :: WorldGenerationJobSummary
- data WorldSummary = WorldSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newWorldSummary :: WorldSummary
Service Configuration
defaultService :: Service Source #
API version 2018-06-29
of the Amazon RoboMaker SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by RobOMaker
.
ConcurrentDeploymentException
_ConcurrentDeploymentException :: AsError a => Fold a ServiceError Source #
The failure percentage threshold percentage was met.
IdempotentParameterMismatchException
_IdempotentParameterMismatchException :: AsError a => Fold a ServiceError Source #
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.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
AWS RoboMaker experienced a service issue. Try your call again.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
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.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified resource already exists.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource does not exist.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The request has failed due to a temporary failure of the server.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
AWS RoboMaker is temporarily unable to process the request. Try your call again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchDeleteWorlds
data BatchDeleteWorlds Source #
See: newBatchDeleteWorlds
smart constructor.
Instances
Create a value of BatchDeleteWorlds
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchDeleteWorlds
, batchDeleteWorlds_worlds
- A list of Amazon Resource Names (arns) that correspond to worlds to
delete.
data BatchDeleteWorldsResponse Source #
See: newBatchDeleteWorldsResponse
smart constructor.
Instances
newBatchDeleteWorldsResponse Source #
Create a value of BatchDeleteWorldsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unprocessedWorlds:BatchDeleteWorldsResponse'
, batchDeleteWorldsResponse_unprocessedWorlds
- A list of unprocessed worlds associated with the call. These worlds were
not deleted.
$sel:httpStatus:BatchDeleteWorldsResponse'
, batchDeleteWorldsResponse_httpStatus
- The response's http status code.
BatchDescribeSimulationJob
data BatchDescribeSimulationJob Source #
See: newBatchDescribeSimulationJob
smart constructor.
Instances
newBatchDescribeSimulationJob Source #
Create a value of BatchDescribeSimulationJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchDescribeSimulationJob
, batchDescribeSimulationJob_jobs
- A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
data BatchDescribeSimulationJobResponse Source #
See: newBatchDescribeSimulationJobResponse
smart constructor.
Instances
newBatchDescribeSimulationJobResponse Source #
Create a value of BatchDescribeSimulationJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchDescribeSimulationJob
, batchDescribeSimulationJobResponse_jobs
- A list of simulation jobs.
$sel:unprocessedJobs:BatchDescribeSimulationJobResponse'
, batchDescribeSimulationJobResponse_unprocessedJobs
- A list of unprocessed simulation job Amazon Resource Names (ARNs).
$sel:httpStatus:BatchDescribeSimulationJobResponse'
, batchDescribeSimulationJobResponse_httpStatus
- The response's http status code.
CancelSimulationJob
data CancelSimulationJob Source #
See: newCancelSimulationJob
smart constructor.
Instances
newCancelSimulationJob Source #
Create a value of CancelSimulationJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:job:CancelSimulationJob'
, cancelSimulationJob_job
- The simulation job ARN to cancel.
data CancelSimulationJobResponse Source #
See: newCancelSimulationJobResponse
smart constructor.
Instances
newCancelSimulationJobResponse Source #
Create a value of CancelSimulationJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelSimulationJobResponse'
, cancelSimulationJobResponse_httpStatus
- The response's http status code.
CancelSimulationJobBatch
data CancelSimulationJobBatch Source #
See: newCancelSimulationJobBatch
smart constructor.
Instances
newCancelSimulationJobBatch Source #
Create a value of CancelSimulationJobBatch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batch:CancelSimulationJobBatch'
, cancelSimulationJobBatch_batch
- The id of the batch to cancel.
data CancelSimulationJobBatchResponse Source #
See: newCancelSimulationJobBatchResponse
smart constructor.
Instances
Generic CancelSimulationJobBatchResponse Source # | |
Read CancelSimulationJobBatchResponse Source # | |
Show CancelSimulationJobBatchResponse Source # | |
NFData CancelSimulationJobBatchResponse Source # | |
Defined in Amazonka.RobOMaker.CancelSimulationJobBatch rnf :: CancelSimulationJobBatchResponse -> () # | |
Eq CancelSimulationJobBatchResponse Source # | |
type Rep CancelSimulationJobBatchResponse Source # | |
Defined in Amazonka.RobOMaker.CancelSimulationJobBatch type Rep CancelSimulationJobBatchResponse = D1 ('MetaData "CancelSimulationJobBatchResponse" "Amazonka.RobOMaker.CancelSimulationJobBatch" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "CancelSimulationJobBatchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCancelSimulationJobBatchResponse Source #
Create a value of CancelSimulationJobBatchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelSimulationJobBatchResponse'
, cancelSimulationJobBatchResponse_httpStatus
- The response's http status code.
CancelWorldExportJob
data CancelWorldExportJob Source #
See: newCancelWorldExportJob
smart constructor.
Instances
newCancelWorldExportJob Source #
Create a value of CancelWorldExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:job:CancelWorldExportJob'
, cancelWorldExportJob_job
- The Amazon Resource Name (arn) of the world export job to cancel.
data CancelWorldExportJobResponse Source #
See: newCancelWorldExportJobResponse
smart constructor.
Instances
newCancelWorldExportJobResponse Source #
Create a value of CancelWorldExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelWorldExportJobResponse'
, cancelWorldExportJobResponse_httpStatus
- The response's http status code.
CancelWorldGenerationJob
data CancelWorldGenerationJob Source #
See: newCancelWorldGenerationJob
smart constructor.
Instances
newCancelWorldGenerationJob Source #
Create a value of CancelWorldGenerationJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:job:CancelWorldGenerationJob'
, cancelWorldGenerationJob_job
- The Amazon Resource Name (arn) of the world generator job to cancel.
data CancelWorldGenerationJobResponse Source #
See: newCancelWorldGenerationJobResponse
smart constructor.
Instances
Generic CancelWorldGenerationJobResponse Source # | |
Read CancelWorldGenerationJobResponse Source # | |
Show CancelWorldGenerationJobResponse Source # | |
NFData CancelWorldGenerationJobResponse Source # | |
Defined in Amazonka.RobOMaker.CancelWorldGenerationJob rnf :: CancelWorldGenerationJobResponse -> () # | |
Eq CancelWorldGenerationJobResponse Source # | |
type Rep CancelWorldGenerationJobResponse Source # | |
Defined in Amazonka.RobOMaker.CancelWorldGenerationJob type Rep CancelWorldGenerationJobResponse = D1 ('MetaData "CancelWorldGenerationJobResponse" "Amazonka.RobOMaker.CancelWorldGenerationJob" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "CancelWorldGenerationJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCancelWorldGenerationJobResponse Source #
Create a value of CancelWorldGenerationJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelWorldGenerationJobResponse'
, cancelWorldGenerationJobResponse_httpStatus
- The response's http status code.
CreateRobotApplication
data CreateRobotApplication Source #
See: newCreateRobotApplication
smart constructor.
CreateRobotApplication' (Maybe Environment) (Maybe [SourceConfig]) (Maybe (HashMap Text Text)) Text RobotSoftwareSuite |
Instances
newCreateRobotApplication Source #
Create a value of CreateRobotApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateRobotApplication
, createRobotApplication_environment
- The object that contains that URI of the Docker image that you use for
your robot application.
CreateRobotApplication
, createRobotApplication_sources
- The sources of the robot application.
CreateRobotApplication
, createRobotApplication_tags
- A map that contains tag keys and tag values that are attached to the
robot application.
CreateRobotApplication
, createRobotApplication_name
- The name of the robot application.
CreateRobotApplication
, createRobotApplication_robotSoftwareSuite
- The robot software suite (ROS distribuition) used by the robot
application.
data CreateRobotApplicationResponse Source #
See: newCreateRobotApplicationResponse
smart constructor.
CreateRobotApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe [Source]) (Maybe (HashMap Text Text)) (Maybe Text) Int |
Instances
newCreateRobotApplicationResponse Source #
Create a value of CreateRobotApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateRobotApplicationResponse
, createRobotApplicationResponse_arn
- The Amazon Resource Name (ARN) of the robot application.
CreateRobotApplication
, createRobotApplicationResponse_environment
- An object that contains the Docker image URI used to a create your robot
application.
CreateRobotApplicationResponse
, createRobotApplicationResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the robot application
was last updated.
CreateRobotApplication
, createRobotApplicationResponse_name
- The name of the robot application.
$sel:revisionId:CreateRobotApplicationResponse'
, createRobotApplicationResponse_revisionId
- The revision id of the robot application.
CreateRobotApplication
, createRobotApplicationResponse_robotSoftwareSuite
- The robot software suite (ROS distribution) used by the robot
application.
CreateRobotApplication
, createRobotApplicationResponse_sources
- The sources of the robot application.
CreateRobotApplication
, createRobotApplicationResponse_tags
- The list of all tags added to the robot application.
CreateRobotApplicationResponse
, createRobotApplicationResponse_version
- The version of the robot application.
$sel:httpStatus:CreateRobotApplicationResponse'
, createRobotApplicationResponse_httpStatus
- The response's http status code.
CreateRobotApplicationVersion
data CreateRobotApplicationVersion Source #
See: newCreateRobotApplicationVersion
smart constructor.
Instances
newCreateRobotApplicationVersion Source #
Create a value of CreateRobotApplicationVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:currentRevisionId:CreateRobotApplicationVersion'
, createRobotApplicationVersion_currentRevisionId
- 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.
$sel:imageDigest:CreateRobotApplicationVersion'
, createRobotApplicationVersion_imageDigest
- A SHA256 identifier for the Docker image that you use for your robot
application.
$sel:s3Etags:CreateRobotApplicationVersion'
, createRobotApplicationVersion_s3Etags
- The Amazon S3 identifier for the zip file bundle that you use for your
robot application.
CreateRobotApplicationVersion
, createRobotApplicationVersion_application
- The application information for the robot application.
data CreateRobotApplicationVersionResponse Source #
See: newCreateRobotApplicationVersionResponse
smart constructor.
CreateRobotApplicationVersionResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe [Source]) (Maybe Text) Int |
Instances
newCreateRobotApplicationVersionResponse Source #
Create a value of CreateRobotApplicationVersionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateRobotApplicationVersionResponse
, createRobotApplicationVersionResponse_arn
- The Amazon Resource Name (ARN) of the robot application.
$sel:environment:CreateRobotApplicationVersionResponse'
, createRobotApplicationVersionResponse_environment
- The object that contains the Docker image URI used to create your robot
application.
CreateRobotApplicationVersionResponse
, createRobotApplicationVersionResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the robot application
was last updated.
CreateRobotApplicationVersionResponse
, createRobotApplicationVersionResponse_name
- The name of the robot application.
$sel:revisionId:CreateRobotApplicationVersionResponse'
, createRobotApplicationVersionResponse_revisionId
- The revision id of the robot application.
CreateRobotApplicationVersionResponse
, createRobotApplicationVersionResponse_robotSoftwareSuite
- The robot software suite (ROS distribution) used by the robot
application.
$sel:sources:CreateRobotApplicationVersionResponse'
, createRobotApplicationVersionResponse_sources
- The sources of the robot application.
CreateRobotApplicationVersionResponse
, createRobotApplicationVersionResponse_version
- The version of the robot application.
$sel:httpStatus:CreateRobotApplicationVersionResponse'
, createRobotApplicationVersionResponse_httpStatus
- The response's http status code.
CreateSimulationApplication
data CreateSimulationApplication Source #
See: newCreateSimulationApplication
smart constructor.
CreateSimulationApplication' (Maybe Environment) (Maybe RenderingEngine) (Maybe [SourceConfig]) (Maybe (HashMap Text Text)) Text SimulationSoftwareSuite RobotSoftwareSuite |
Instances
newCreateSimulationApplication Source #
Create a value of CreateSimulationApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSimulationApplication
, createSimulationApplication_environment
- The object that contains the Docker image URI used to create your
simulation application.
CreateSimulationApplication
, createSimulationApplication_renderingEngine
- The rendering engine for the simulation application.
CreateSimulationApplication
, createSimulationApplication_sources
- The sources of the simulation application.
CreateSimulationApplication
, createSimulationApplication_tags
- A map that contains tag keys and tag values that are attached to the
simulation application.
CreateSimulationApplication
, createSimulationApplication_name
- The name of the simulation application.
CreateSimulationApplication
, createSimulationApplication_simulationSoftwareSuite
- The simulation software suite used by the simulation application.
CreateSimulationApplication
, createSimulationApplication_robotSoftwareSuite
- The robot software suite (ROS distribution) used by the simulation
application.
data CreateSimulationApplicationResponse Source #
See: newCreateSimulationApplicationResponse
smart constructor.
CreateSimulationApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe RenderingEngine) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe SimulationSoftwareSuite) (Maybe [Source]) (Maybe (HashMap Text Text)) (Maybe Text) Int |
Instances
newCreateSimulationApplicationResponse Source #
Create a value of CreateSimulationApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSimulationApplicationResponse
, createSimulationApplicationResponse_arn
- The Amazon Resource Name (ARN) of the simulation application.
CreateSimulationApplication
, createSimulationApplicationResponse_environment
- The object that contains the Docker image URI that you used to create
your simulation application.
CreateSimulationApplicationResponse
, createSimulationApplicationResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation
application was last updated.
CreateSimulationApplication
, createSimulationApplicationResponse_name
- The name of the simulation application.
CreateSimulationApplication
, createSimulationApplicationResponse_renderingEngine
- The rendering engine for the simulation application.
$sel:revisionId:CreateSimulationApplicationResponse'
, createSimulationApplicationResponse_revisionId
- The revision id of the simulation application.
CreateSimulationApplication
, createSimulationApplicationResponse_robotSoftwareSuite
- Information about the robot software suite (ROS distribution).
CreateSimulationApplication
, createSimulationApplicationResponse_simulationSoftwareSuite
- The simulation software suite used by the simulation application.
CreateSimulationApplication
, createSimulationApplicationResponse_sources
- The sources of the simulation application.
CreateSimulationApplication
, createSimulationApplicationResponse_tags
- The list of all tags added to the simulation application.
CreateSimulationApplicationResponse
, createSimulationApplicationResponse_version
- The version of the simulation application.
$sel:httpStatus:CreateSimulationApplicationResponse'
, createSimulationApplicationResponse_httpStatus
- The response's http status code.
CreateSimulationApplicationVersion
data CreateSimulationApplicationVersion Source #
See: newCreateSimulationApplicationVersion
smart constructor.
Instances
newCreateSimulationApplicationVersion Source #
Create a value of CreateSimulationApplicationVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:currentRevisionId:CreateSimulationApplicationVersion'
, createSimulationApplicationVersion_currentRevisionId
- 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.
$sel:imageDigest:CreateSimulationApplicationVersion'
, createSimulationApplicationVersion_imageDigest
- The SHA256 digest used to identify the Docker image URI used to created
the simulation application.
$sel:s3Etags:CreateSimulationApplicationVersion'
, createSimulationApplicationVersion_s3Etags
- The Amazon S3 eTag identifier for the zip file bundle that you use to
create the simulation application.
CreateSimulationApplicationVersion
, createSimulationApplicationVersion_application
- The application information for the simulation application.
data CreateSimulationApplicationVersionResponse Source #
See: newCreateSimulationApplicationVersionResponse
smart constructor.
Instances
newCreateSimulationApplicationVersionResponse Source #
Create a value of CreateSimulationApplicationVersionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSimulationApplicationVersionResponse
, createSimulationApplicationVersionResponse_arn
- The Amazon Resource Name (ARN) of the simulation application.
$sel:environment:CreateSimulationApplicationVersionResponse'
, createSimulationApplicationVersionResponse_environment
- The object that contains the Docker image URI used to create the
simulation application.
CreateSimulationApplicationVersionResponse
, createSimulationApplicationVersionResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation
application was last updated.
CreateSimulationApplicationVersionResponse
, createSimulationApplicationVersionResponse_name
- The name of the simulation application.
$sel:renderingEngine:CreateSimulationApplicationVersionResponse'
, createSimulationApplicationVersionResponse_renderingEngine
- The rendering engine for the simulation application.
$sel:revisionId:CreateSimulationApplicationVersionResponse'
, createSimulationApplicationVersionResponse_revisionId
- The revision ID of the simulation application.
CreateSimulationApplicationVersionResponse
, createSimulationApplicationVersionResponse_robotSoftwareSuite
- Information about the robot software suite (ROS distribution).
CreateSimulationApplicationVersionResponse
, createSimulationApplicationVersionResponse_simulationSoftwareSuite
- The simulation software suite used by the simulation application.
$sel:sources:CreateSimulationApplicationVersionResponse'
, createSimulationApplicationVersionResponse_sources
- The sources of the simulation application.
CreateSimulationApplicationVersionResponse
, createSimulationApplicationVersionResponse_version
- The version of the simulation application.
$sel:httpStatus:CreateSimulationApplicationVersionResponse'
, createSimulationApplicationVersionResponse_httpStatus
- The response's http status code.
CreateSimulationJob
data CreateSimulationJob Source #
See: newCreateSimulationJob
smart constructor.
Instances
newCreateSimulationJob Source #
Create a value of CreateSimulationJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSimulationJob
, createSimulationJob_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateSimulationJob
, createSimulationJob_compute
- Compute information for the simulation job.
CreateSimulationJob
, createSimulationJob_dataSources
- Specify data sources to mount read-only files from S3 into your
simulation. These files are available under
/opt/robomaker/datasources/data_source_name
.
There is a limit of 100 files and a combined size of 25GB for all
DataSourceConfig
objects.
CreateSimulationJob
, createSimulationJob_failureBehavior
- The failure behavior the simulation job.
- Continue
- Leaves the instance running for its maximum timeout duration after a
4XX
error code. - Fail
- Stop the simulation job and terminate the instance.
CreateSimulationJob
, createSimulationJob_loggingConfig
- The logging configuration.
CreateSimulationJob
, createSimulationJob_outputLocation
- Location for output files generated by the simulation job.
CreateSimulationJob
, createSimulationJob_robotApplications
- The robot application to use in the simulation job.
CreateSimulationJob
, createSimulationJob_simulationApplications
- The simulation application to use in the simulation job.
CreateSimulationJob
, createSimulationJob_tags
- A map that contains tag keys and tag values that are attached to the
simulation job.
CreateSimulationJob
, createSimulationJob_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 one subnet ID.
CreateSimulationJob
, createSimulationJob_maxJobDurationInSeconds
- The maximum simulation job duration in seconds (up to 14 days or
1,209,600 seconds. When maxJobDurationInSeconds
is reached, the
simulation job will status will transition to Completed
.
CreateSimulationJob
, createSimulationJob_iamRole
- 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.
data CreateSimulationJobResponse Source #
See: newCreateSimulationJobResponse
smart constructor.
Instances
newCreateSimulationJobResponse Source #
Create a value of CreateSimulationJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSimulationJobResponse
, createSimulationJobResponse_arn
- The Amazon Resource Name (ARN) of the simulation job.
CreateSimulationJob
, createSimulationJobResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateSimulationJob
, createSimulationJobResponse_compute
- Compute information for the simulation job.
CreateSimulationJob
, createSimulationJobResponse_dataSources
- The data sources for the simulation job.
CreateSimulationJob
, createSimulationJobResponse_failureBehavior
- the failure behavior for the simulation job.
CreateSimulationJobResponse
, createSimulationJobResponse_failureCode
- The failure code of the simulation job if it failed:
- InternalServiceError
- Internal service error.
- RobotApplicationCrash
- Robot application exited abnormally.
- SimulationApplicationCrash
- Simulation application exited abnormally.
- BadPermissionsRobotApplication
- Robot application bundle could not be downloaded.
- BadPermissionsSimulationApplication
- Simulation application bundle could not be downloaded.
- BadPermissionsS3Output
- Unable to publish outputs to customer-provided S3 bucket.
- BadPermissionsCloudwatchLogs
- Unable to publish logs to customer-provided CloudWatch Logs resource.
- SubnetIpLimitExceeded
- Subnet IP limit exceeded.
- ENILimitExceeded
- ENI limit exceeded.
- BadPermissionsUserCredentials
- Unable to use the Role provided.
- InvalidBundleRobotApplication
- Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
- InvalidBundleSimulationApplication
- Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
- RobotApplicationVersionMismatchedEtag
- Etag for RobotApplication does not match value during version creation.
- SimulationApplicationVersionMismatchedEtag
- Etag for SimulationApplication does not match value during version creation.
CreateSimulationJob
, createSimulationJobResponse_iamRole
- The IAM role that allows the simulation job to call the AWS APIs that
are specified in its associated policies on your behalf.
CreateSimulationJobResponse
, createSimulationJobResponse_lastStartedAt
- The time, in milliseconds since the epoch, when the simulation job was
last started.
CreateSimulationJobResponse
, createSimulationJobResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation job was
last updated.
CreateSimulationJob
, createSimulationJobResponse_loggingConfig
- The logging configuration.
CreateSimulationJob
, createSimulationJobResponse_maxJobDurationInSeconds
- The maximum simulation job duration in seconds.
CreateSimulationJob
, createSimulationJobResponse_outputLocation
- Simulation job output files location.
CreateSimulationJob
, createSimulationJobResponse_robotApplications
- The robot application used by the simulation job.
CreateSimulationJob
, createSimulationJobResponse_simulationApplications
- The simulation application used by the simulation job.
CreateSimulationJobResponse
, createSimulationJobResponse_simulationTimeMillis
- The simulation job execution duration in milliseconds.
CreateSimulationJobResponse
, createSimulationJobResponse_status
- The status of the simulation job.
CreateSimulationJob
, createSimulationJobResponse_tags
- The list of all tags added to the simulation job.
CreateSimulationJob
, createSimulationJobResponse_vpcConfig
- Information about the vpc configuration.
$sel:httpStatus:CreateSimulationJobResponse'
, createSimulationJobResponse_httpStatus
- The response's http status code.
CreateWorldExportJob
data CreateWorldExportJob Source #
See: newCreateWorldExportJob
smart constructor.
Instances
newCreateWorldExportJob Source #
:: NonEmpty Text | |
-> OutputLocation | |
-> Text | |
-> CreateWorldExportJob |
Create a value of CreateWorldExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorldExportJob
, createWorldExportJob_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateWorldExportJob
, createWorldExportJob_tags
- A map that contains tag keys and tag values that are attached to the
world export job.
CreateWorldExportJob
, createWorldExportJob_worlds
- A list of Amazon Resource Names (arns) that correspond to worlds to
export.
CreateWorldExportJob
, createWorldExportJob_outputLocation
- Undocumented member.
CreateWorldExportJob
, createWorldExportJob_iamRole
- The IAM role that the world export process uses to access the Amazon S3
bucket and put the export.
data CreateWorldExportJobResponse Source #
See: newCreateWorldExportJobResponse
smart constructor.
CreateWorldExportJobResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe WorldExportJobErrorCode) (Maybe Text) (Maybe OutputLocation) (Maybe WorldExportJobStatus) (Maybe (HashMap Text Text)) Int |
Instances
newCreateWorldExportJobResponse Source #
Create a value of CreateWorldExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorldExportJobResponse
, createWorldExportJobResponse_arn
- The Amazon Resource Name (ARN) of the world export job.
CreateWorldExportJob
, createWorldExportJobResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateWorldExportJobResponse
, createWorldExportJobResponse_createdAt
- The time, in milliseconds since the epoch, when the world export job was
created.
CreateWorldExportJobResponse
, createWorldExportJobResponse_failureCode
- The failure code of the world export job if it failed:
- InternalServiceError
- Internal service error.
- LimitExceeded
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
- The specified resource could not be found.
- RequestThrottled
- The request was throttled.
- InvalidInput
- An input parameter in the request is not valid.
- AllWorldGenerationFailed
- All of the worlds in the world generation job failed. This can
happen if your
worldCount
is greater than 50 or less than 1.
For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.
CreateWorldExportJob
, createWorldExportJobResponse_iamRole
- The IAM role that the world export process uses to access the Amazon S3
bucket and put the export.
CreateWorldExportJob
, createWorldExportJobResponse_outputLocation
- Undocumented member.
CreateWorldExportJobResponse
, createWorldExportJobResponse_status
- The status of the world export job.
- Pending
- The world export job request is pending.
- Running
- The world export job is running.
- Completed
- The world export job completed.
- Failed
- The world export job failed. See
failureCode
for more information. - Canceled
- The world export job was cancelled.
- Canceling
- The world export job is being cancelled.
CreateWorldExportJob
, createWorldExportJobResponse_tags
- A map that contains tag keys and tag values that are attached to the
world export job.
$sel:httpStatus:CreateWorldExportJobResponse'
, createWorldExportJobResponse_httpStatus
- The response's http status code.
CreateWorldGenerationJob
data CreateWorldGenerationJob Source #
See: newCreateWorldGenerationJob
smart constructor.
CreateWorldGenerationJob' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text WorldCount |
Instances
newCreateWorldGenerationJob Source #
Create a value of CreateWorldGenerationJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorldGenerationJob
, createWorldGenerationJob_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateWorldGenerationJob
, createWorldGenerationJob_tags
- A map that contains tag keys and tag values that are attached to the
world generator job.
CreateWorldGenerationJob
, createWorldGenerationJob_worldTags
- A map that contains tag keys and tag values that are attached to the
generated worlds.
CreateWorldGenerationJob
, createWorldGenerationJob_template
- The Amazon Resource Name (arn) of the world template describing the
worlds you want to create.
CreateWorldGenerationJob
, createWorldGenerationJob_worldCount
- Information about the world count.
data CreateWorldGenerationJobResponse Source #
See: newCreateWorldGenerationJobResponse
smart constructor.
Instances
newCreateWorldGenerationJobResponse Source #
Create a value of CreateWorldGenerationJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorldGenerationJobResponse
, createWorldGenerationJobResponse_arn
- The Amazon Resource Name (ARN) of the world generator job.
CreateWorldGenerationJob
, createWorldGenerationJobResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateWorldGenerationJobResponse
, createWorldGenerationJobResponse_createdAt
- The time, in milliseconds since the epoch, when the world generator job
was created.
CreateWorldGenerationJobResponse
, createWorldGenerationJobResponse_failureCode
- The failure code of the world generator job if it failed:
- InternalServiceError
- Internal service error.
- LimitExceeded
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
- The specified resource could not be found.
- RequestThrottled
- The request was throttled.
- InvalidInput
- An input parameter in the request is not valid.
CreateWorldGenerationJobResponse
, createWorldGenerationJobResponse_status
- The status of the world generator job.
- Pending
- The world generator job request is pending.
- Running
- The world generator job is running.
- Completed
- The world generator job completed.
- Failed
- The world generator job failed. See
failureCode
for more information. - PartialFailed
- Some worlds did not generate.
- Canceled
- The world generator job was cancelled.
- Canceling
- The world generator job is being cancelled.
CreateWorldGenerationJob
, createWorldGenerationJobResponse_tags
- A map that contains tag keys and tag values that are attached to the
world generator job.
CreateWorldGenerationJob
, createWorldGenerationJobResponse_template
- The Amazon Resource Name (arn) of the world template.
CreateWorldGenerationJob
, createWorldGenerationJobResponse_worldCount
- Information about the world count.
CreateWorldGenerationJob
, createWorldGenerationJobResponse_worldTags
- A map that contains tag keys and tag values that are attached to the
generated worlds.
$sel:httpStatus:CreateWorldGenerationJobResponse'
, createWorldGenerationJobResponse_httpStatus
- The response's http status code.
CreateWorldTemplate
data CreateWorldTemplate Source #
See: newCreateWorldTemplate
smart constructor.
CreateWorldTemplate' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe TemplateLocation) |
Instances
newCreateWorldTemplate :: CreateWorldTemplate Source #
Create a value of CreateWorldTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorldTemplate
, createWorldTemplate_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateWorldTemplate
, createWorldTemplate_name
- The name of the world template.
CreateWorldTemplate
, createWorldTemplate_tags
- A map that contains tag keys and tag values that are attached to the
world template.
$sel:templateBody:CreateWorldTemplate'
, createWorldTemplate_templateBody
- The world template body.
$sel:templateLocation:CreateWorldTemplate'
, createWorldTemplate_templateLocation
- The location of the world template.
data CreateWorldTemplateResponse Source #
See: newCreateWorldTemplateResponse
smart constructor.
CreateWorldTemplateResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newCreateWorldTemplateResponse Source #
Create a value of CreateWorldTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorldTemplateResponse
, createWorldTemplateResponse_arn
- The Amazon Resource Name (ARN) of the world template.
CreateWorldTemplate
, createWorldTemplateResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateWorldTemplateResponse
, createWorldTemplateResponse_createdAt
- The time, in milliseconds since the epoch, when the world template was
created.
CreateWorldTemplate
, createWorldTemplateResponse_name
- The name of the world template.
CreateWorldTemplate
, createWorldTemplateResponse_tags
- A map that contains tag keys and tag values that are attached to the
world template.
$sel:httpStatus:CreateWorldTemplateResponse'
, createWorldTemplateResponse_httpStatus
- The response's http status code.
DeleteRobotApplication
data DeleteRobotApplication Source #
See: newDeleteRobotApplication
smart constructor.
Instances
newDeleteRobotApplication Source #
Create a value of DeleteRobotApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteRobotApplication
, deleteRobotApplication_applicationVersion
- The version of the robot application to delete.
DeleteRobotApplication
, deleteRobotApplication_application
- The Amazon Resource Name (ARN) of the the robot application.
data DeleteRobotApplicationResponse Source #
See: newDeleteRobotApplicationResponse
smart constructor.
Instances
Generic DeleteRobotApplicationResponse Source # | |
Read DeleteRobotApplicationResponse Source # | |
Show DeleteRobotApplicationResponse Source # | |
Defined in Amazonka.RobOMaker.DeleteRobotApplication | |
NFData DeleteRobotApplicationResponse Source # | |
Defined in Amazonka.RobOMaker.DeleteRobotApplication rnf :: DeleteRobotApplicationResponse -> () # | |
Eq DeleteRobotApplicationResponse Source # | |
type Rep DeleteRobotApplicationResponse Source # | |
Defined in Amazonka.RobOMaker.DeleteRobotApplication type Rep DeleteRobotApplicationResponse = D1 ('MetaData "DeleteRobotApplicationResponse" "Amazonka.RobOMaker.DeleteRobotApplication" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "DeleteRobotApplicationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteRobotApplicationResponse Source #
Create a value of DeleteRobotApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteRobotApplicationResponse'
, deleteRobotApplicationResponse_httpStatus
- The response's http status code.
DeleteSimulationApplication
data DeleteSimulationApplication Source #
See: newDeleteSimulationApplication
smart constructor.
Instances
newDeleteSimulationApplication Source #
Create a value of DeleteSimulationApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSimulationApplication
, deleteSimulationApplication_applicationVersion
- The version of the simulation application to delete.
DeleteSimulationApplication
, deleteSimulationApplication_application
- The application information for the simulation application to delete.
data DeleteSimulationApplicationResponse Source #
See: newDeleteSimulationApplicationResponse
smart constructor.
Instances
Generic DeleteSimulationApplicationResponse Source # | |
Read DeleteSimulationApplicationResponse Source # | |
Show DeleteSimulationApplicationResponse Source # | |
NFData DeleteSimulationApplicationResponse Source # | |
Defined in Amazonka.RobOMaker.DeleteSimulationApplication rnf :: DeleteSimulationApplicationResponse -> () # | |
Eq DeleteSimulationApplicationResponse Source # | |
type Rep DeleteSimulationApplicationResponse Source # | |
Defined in Amazonka.RobOMaker.DeleteSimulationApplication type Rep DeleteSimulationApplicationResponse = D1 ('MetaData "DeleteSimulationApplicationResponse" "Amazonka.RobOMaker.DeleteSimulationApplication" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "DeleteSimulationApplicationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteSimulationApplicationResponse Source #
Create a value of DeleteSimulationApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteSimulationApplicationResponse'
, deleteSimulationApplicationResponse_httpStatus
- The response's http status code.
DeleteWorldTemplate
data DeleteWorldTemplate Source #
See: newDeleteWorldTemplate
smart constructor.
Instances
newDeleteWorldTemplate Source #
Create a value of DeleteWorldTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWorldTemplate
, deleteWorldTemplate_template
- The Amazon Resource Name (arn) of the world template you want to delete.
data DeleteWorldTemplateResponse Source #
See: newDeleteWorldTemplateResponse
smart constructor.
Instances
newDeleteWorldTemplateResponse Source #
Create a value of DeleteWorldTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteWorldTemplateResponse'
, deleteWorldTemplateResponse_httpStatus
- The response's http status code.
DescribeRobotApplication
data DescribeRobotApplication Source #
See: newDescribeRobotApplication
smart constructor.
Instances
newDescribeRobotApplication Source #
Create a value of DescribeRobotApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeRobotApplication
, describeRobotApplication_applicationVersion
- The version of the robot application to describe.
DescribeRobotApplication
, describeRobotApplication_application
- The Amazon Resource Name (ARN) of the robot application.
data DescribeRobotApplicationResponse Source #
See: newDescribeRobotApplicationResponse
smart constructor.
DescribeRobotApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe [Source]) (Maybe (HashMap Text Text)) (Maybe Text) Int |
Instances
newDescribeRobotApplicationResponse Source #
Create a value of DescribeRobotApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeRobotApplicationResponse
, describeRobotApplicationResponse_arn
- The Amazon Resource Name (ARN) of the robot application.
$sel:environment:DescribeRobotApplicationResponse'
, describeRobotApplicationResponse_environment
- The object that contains the Docker image URI used to create the robot
application.
$sel:imageDigest:DescribeRobotApplicationResponse'
, describeRobotApplicationResponse_imageDigest
- A SHA256 identifier for the Docker image that you use for your robot
application.
DescribeRobotApplicationResponse
, describeRobotApplicationResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the robot application
was last updated.
DescribeRobotApplicationResponse
, describeRobotApplicationResponse_name
- The name of the robot application.
$sel:revisionId:DescribeRobotApplicationResponse'
, describeRobotApplicationResponse_revisionId
- The revision id of the robot application.
DescribeRobotApplicationResponse
, describeRobotApplicationResponse_robotSoftwareSuite
- The robot software suite (ROS distribution) used by the robot
application.
$sel:sources:DescribeRobotApplicationResponse'
, describeRobotApplicationResponse_sources
- The sources of the robot application.
DescribeRobotApplicationResponse
, describeRobotApplicationResponse_tags
- The list of all tags added to the specified robot application.
DescribeRobotApplicationResponse
, describeRobotApplicationResponse_version
- The version of the robot application.
$sel:httpStatus:DescribeRobotApplicationResponse'
, describeRobotApplicationResponse_httpStatus
- The response's http status code.
DescribeSimulationApplication
data DescribeSimulationApplication Source #
See: newDescribeSimulationApplication
smart constructor.
Instances
newDescribeSimulationApplication Source #
Create a value of DescribeSimulationApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSimulationApplication
, describeSimulationApplication_applicationVersion
- The version of the simulation application to describe.
DescribeSimulationApplication
, describeSimulationApplication_application
- The application information for the simulation application.
data DescribeSimulationApplicationResponse Source #
See: newDescribeSimulationApplicationResponse
smart constructor.
DescribeSimulationApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe RenderingEngine) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe SimulationSoftwareSuite) (Maybe [Source]) (Maybe (HashMap Text Text)) (Maybe Text) Int |
Instances
newDescribeSimulationApplicationResponse Source #
Create a value of DescribeSimulationApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSimulationApplicationResponse
, describeSimulationApplicationResponse_arn
- The Amazon Resource Name (ARN) of the robot simulation application.
$sel:environment:DescribeSimulationApplicationResponse'
, describeSimulationApplicationResponse_environment
- The object that contains the Docker image URI used to create the
simulation application.
$sel:imageDigest:DescribeSimulationApplicationResponse'
, describeSimulationApplicationResponse_imageDigest
- A SHA256 identifier for the Docker image that you use for your
simulation application.
DescribeSimulationApplicationResponse
, describeSimulationApplicationResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation
application was last updated.
DescribeSimulationApplicationResponse
, describeSimulationApplicationResponse_name
- The name of the simulation application.
$sel:renderingEngine:DescribeSimulationApplicationResponse'
, describeSimulationApplicationResponse_renderingEngine
- The rendering engine for the simulation application.
$sel:revisionId:DescribeSimulationApplicationResponse'
, describeSimulationApplicationResponse_revisionId
- The revision id of the simulation application.
DescribeSimulationApplicationResponse
, describeSimulationApplicationResponse_robotSoftwareSuite
- Information about the robot software suite (ROS distribution).
DescribeSimulationApplicationResponse
, describeSimulationApplicationResponse_simulationSoftwareSuite
- The simulation software suite used by the simulation application.
$sel:sources:DescribeSimulationApplicationResponse'
, describeSimulationApplicationResponse_sources
- The sources of the simulation application.
DescribeSimulationApplicationResponse
, describeSimulationApplicationResponse_tags
- The list of all tags added to the specified simulation application.
DescribeSimulationApplicationResponse
, describeSimulationApplicationResponse_version
- The version of the simulation application.
$sel:httpStatus:DescribeSimulationApplicationResponse'
, describeSimulationApplicationResponse_httpStatus
- The response's http status code.
DescribeSimulationJob
data DescribeSimulationJob Source #
See: newDescribeSimulationJob
smart constructor.
Instances
newDescribeSimulationJob Source #
Create a value of DescribeSimulationJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:job:DescribeSimulationJob'
, describeSimulationJob_job
- The Amazon Resource Name (ARN) of the simulation job to be described.
data DescribeSimulationJobResponse Source #
See: newDescribeSimulationJobResponse
smart constructor.
Instances
newDescribeSimulationJobResponse Source #
Create a value of DescribeSimulationJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSimulationJobResponse
, describeSimulationJobResponse_arn
- The Amazon Resource Name (ARN) of the simulation job.
DescribeSimulationJobResponse
, describeSimulationJobResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
DescribeSimulationJobResponse
, describeSimulationJobResponse_compute
- Compute information for the simulation job.
DescribeSimulationJobResponse
, describeSimulationJobResponse_dataSources
- The data sources for the simulation job.
DescribeSimulationJobResponse
, describeSimulationJobResponse_failureBehavior
- The failure behavior for the simulation job.
DescribeSimulationJobResponse
, describeSimulationJobResponse_failureCode
- The failure code of the simulation job if it failed:
- InternalServiceError
- Internal service error.
- RobotApplicationCrash
- Robot application exited abnormally.
- SimulationApplicationCrash
- Simulation application exited abnormally.
- BadPermissionsRobotApplication
- Robot application bundle could not be downloaded.
- BadPermissionsSimulationApplication
- Simulation application bundle could not be downloaded.
- BadPermissionsS3Output
- Unable to publish outputs to customer-provided S3 bucket.
- BadPermissionsCloudwatchLogs
- Unable to publish logs to customer-provided CloudWatch Logs resource.
- SubnetIpLimitExceeded
- Subnet IP limit exceeded.
- ENILimitExceeded
- ENI limit exceeded.
- BadPermissionsUserCredentials
- Unable to use the Role provided.
- InvalidBundleRobotApplication
- Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
- InvalidBundleSimulationApplication
- Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
- RobotApplicationVersionMismatchedEtag
- Etag for RobotApplication does not match value during version creation.
- SimulationApplicationVersionMismatchedEtag
- Etag for SimulationApplication does not match value during version creation.
DescribeSimulationJobResponse
, describeSimulationJobResponse_failureReason
- Details about why the simulation job failed. For more information about
troubleshooting, see
Troubleshooting.
DescribeSimulationJobResponse
, describeSimulationJobResponse_iamRole
- The IAM role that allows the simulation instance to call the AWS APIs
that are specified in its associated policies on your behalf.
DescribeSimulationJobResponse
, describeSimulationJobResponse_lastStartedAt
- The time, in milliseconds since the epoch, when the simulation job was
last started.
DescribeSimulationJobResponse
, describeSimulationJobResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation job was
last updated.
DescribeSimulationJobResponse
, describeSimulationJobResponse_loggingConfig
- The logging configuration.
DescribeSimulationJobResponse
, describeSimulationJobResponse_maxJobDurationInSeconds
- The maximum job duration in seconds. The value must be 8 days (691,200
seconds) or less.
DescribeSimulationJobResponse
, describeSimulationJobResponse_name
- The name of the simulation job.
DescribeSimulationJobResponse
, describeSimulationJobResponse_networkInterface
- The network interface information for the simulation job.
DescribeSimulationJobResponse
, describeSimulationJobResponse_outputLocation
- Location for output files generated by the simulation job.
DescribeSimulationJobResponse
, describeSimulationJobResponse_robotApplications
- A list of robot applications.
DescribeSimulationJobResponse
, describeSimulationJobResponse_simulationApplications
- A list of simulation applications.
DescribeSimulationJobResponse
, describeSimulationJobResponse_simulationTimeMillis
- The simulation job execution duration in milliseconds.
DescribeSimulationJobResponse
, describeSimulationJobResponse_status
- The status of the simulation job.
DescribeSimulationJobResponse
, describeSimulationJobResponse_tags
- The list of all tags added to the specified simulation job.
DescribeSimulationJobResponse
, describeSimulationJobResponse_vpcConfig
- The VPC configuration.
$sel:httpStatus:DescribeSimulationJobResponse'
, describeSimulationJobResponse_httpStatus
- The response's http status code.
DescribeSimulationJobBatch
data DescribeSimulationJobBatch Source #
See: newDescribeSimulationJobBatch
smart constructor.
Instances
newDescribeSimulationJobBatch Source #
Create a value of DescribeSimulationJobBatch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batch:DescribeSimulationJobBatch'
, describeSimulationJobBatch_batch
- The id of the batch to describe.
data DescribeSimulationJobBatchResponse Source #
See: newDescribeSimulationJobBatchResponse
smart constructor.
Instances
newDescribeSimulationJobBatchResponse Source #
Create a value of DescribeSimulationJobBatchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSimulationJobBatchResponse
, describeSimulationJobBatchResponse_arn
- The Amazon Resource Name (ARN) of the batch.
$sel:batchPolicy:DescribeSimulationJobBatchResponse'
, describeSimulationJobBatchResponse_batchPolicy
- The batch policy.
DescribeSimulationJobBatchResponse
, describeSimulationJobBatchResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
DescribeSimulationJobBatchResponse
, describeSimulationJobBatchResponse_createdAt
- The time, in milliseconds since the epoch, when the simulation job batch
was created.
$sel:createdRequests:DescribeSimulationJobBatchResponse'
, describeSimulationJobBatchResponse_createdRequests
- A list of created simulation job summaries.
$sel:failedRequests:DescribeSimulationJobBatchResponse'
, describeSimulationJobBatchResponse_failedRequests
- 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.
DescribeSimulationJobBatchResponse
, describeSimulationJobBatchResponse_failureCode
- The failure code of the simulation job batch.
DescribeSimulationJobBatchResponse
, describeSimulationJobBatchResponse_failureReason
- The reason the simulation job batch failed.
DescribeSimulationJobBatchResponse
, describeSimulationJobBatchResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation job batch
was last updated.
$sel:pendingRequests:DescribeSimulationJobBatchResponse'
, describeSimulationJobBatchResponse_pendingRequests
- A list of pending simulation job requests. These requests have not yet
been created into simulation jobs.
DescribeSimulationJobBatchResponse
, describeSimulationJobBatchResponse_status
- The status of the batch.
- Pending
- The simulation job batch request is pending.
- InProgress
- The simulation job batch is in progress.
- Failed
- The simulation job batch failed. One or more simulation job requests
could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
- 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
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
- The simulation batch job was cancelled.
- Canceling
- The simulation batch job is being cancelled.
- Completing
- The simulation batch job is completing.
- TimingOut
- The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
- The simulation batch job timed out.
DescribeSimulationJobBatchResponse
, describeSimulationJobBatchResponse_tags
- A map that contains tag keys and tag values that are attached to the
simulation job batch.
$sel:httpStatus:DescribeSimulationJobBatchResponse'
, describeSimulationJobBatchResponse_httpStatus
- The response's http status code.
DescribeWorld
data DescribeWorld Source #
See: newDescribeWorld
smart constructor.
Instances
Create a value of DescribeWorld
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWorld
, describeWorld_world
- The Amazon Resource Name (arn) of the world you want to describe.
data DescribeWorldResponse Source #
See: newDescribeWorldResponse
smart constructor.
DescribeWorldResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeWorldResponse Source #
Create a value of DescribeWorldResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWorldResponse
, describeWorldResponse_arn
- The Amazon Resource Name (arn) of the world.
DescribeWorldResponse
, describeWorldResponse_createdAt
- The time, in milliseconds since the epoch, when the world was created.
DescribeWorldResponse
, describeWorldResponse_generationJob
- The Amazon Resource Name (arn) of the world generation job that
generated the world.
DescribeWorldResponse
, describeWorldResponse_tags
- A map that contains tag keys and tag values that are attached to the
world.
DescribeWorldResponse
, describeWorldResponse_template
- The world template.
$sel:worldDescriptionBody:DescribeWorldResponse'
, describeWorldResponse_worldDescriptionBody
- Returns the JSON formatted string that describes the contents of your
world.
$sel:httpStatus:DescribeWorldResponse'
, describeWorldResponse_httpStatus
- The response's http status code.
DescribeWorldExportJob
data DescribeWorldExportJob Source #
See: newDescribeWorldExportJob
smart constructor.
Instances
newDescribeWorldExportJob Source #
Create a value of DescribeWorldExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:job:DescribeWorldExportJob'
, describeWorldExportJob_job
- The Amazon Resource Name (arn) of the world export job to describe.
data DescribeWorldExportJobResponse Source #
See: newDescribeWorldExportJobResponse
smart constructor.
DescribeWorldExportJobResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe WorldExportJobErrorCode) (Maybe Text) (Maybe Text) (Maybe OutputLocation) (Maybe WorldExportJobStatus) (Maybe (HashMap Text Text)) (Maybe (NonEmpty Text)) Int |
Instances
newDescribeWorldExportJobResponse Source #
Create a value of DescribeWorldExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_arn
- The Amazon Resource Name (ARN) of the world export job.
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_createdAt
- The time, in milliseconds since the epoch, when the world export job was
created.
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_failureCode
- The failure code of the world export job if it failed:
- InternalServiceError
- Internal service error.
- LimitExceeded
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
- The specified resource could not be found.
- RequestThrottled
- The request was throttled.
- InvalidInput
- An input parameter in the request is not valid.
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_failureReason
- The reason why the world export job failed.
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_iamRole
- The IAM role that the world export process uses to access the Amazon S3
bucket and put the export.
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_outputLocation
- Undocumented member.
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_status
- The status of the world export job.
- Pending
- The world export job request is pending.
- Running
- The world export job is running.
- Completed
- The world export job completed.
- Failed
- The world export job failed. See
failureCode
andfailureReason
for more information. - Canceled
- The world export job was cancelled.
- Canceling
- The world export job is being cancelled.
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_tags
- A map that contains tag keys and tag values that are attached to the
world export job.
DescribeWorldExportJobResponse
, describeWorldExportJobResponse_worlds
- A list of Amazon Resource Names (arns) that correspond to worlds to be
exported.
$sel:httpStatus:DescribeWorldExportJobResponse'
, describeWorldExportJobResponse_httpStatus
- The response's http status code.
DescribeWorldGenerationJob
data DescribeWorldGenerationJob Source #
See: newDescribeWorldGenerationJob
smart constructor.
Instances
newDescribeWorldGenerationJob Source #
Create a value of DescribeWorldGenerationJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:job:DescribeWorldGenerationJob'
, describeWorldGenerationJob_job
- The Amazon Resource Name (arn) of the world generation job to describe.
data DescribeWorldGenerationJobResponse Source #
See: newDescribeWorldGenerationJobResponse
smart constructor.
Instances
newDescribeWorldGenerationJobResponse Source #
Create a value of DescribeWorldGenerationJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWorldGenerationJobResponse
, describeWorldGenerationJobResponse_arn
- The Amazon Resource Name (ARN) of the world generation job.
DescribeWorldGenerationJobResponse
, describeWorldGenerationJobResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
DescribeWorldGenerationJobResponse
, describeWorldGenerationJobResponse_createdAt
- The time, in milliseconds since the epoch, when the world generation job
was created.
DescribeWorldGenerationJobResponse
, describeWorldGenerationJobResponse_failureCode
- The failure code of the world generation job if it failed:
- InternalServiceError
- Internal service error.
- LimitExceeded
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
- The specified resource could not be found.
- RequestThrottled
- The request was throttled.
- InvalidInput
- An input parameter in the request is not valid.
DescribeWorldGenerationJobResponse
, describeWorldGenerationJobResponse_failureReason
- The reason why the world generation job failed.
$sel:finishedWorldsSummary:DescribeWorldGenerationJobResponse'
, describeWorldGenerationJobResponse_finishedWorldsSummary
- Summary information about finished worlds.
DescribeWorldGenerationJobResponse
, describeWorldGenerationJobResponse_status
- The status of the world generation job:
- Pending
- The world generation job request is pending.
- Running
- The world generation job is running.
- Completed
- The world generation job completed.
- Failed
- The world generation job failed. See
failureCode
for more information. - PartialFailed
- Some worlds did not generate.
- Canceled
- The world generation job was cancelled.
- Canceling
- The world generation job is being cancelled.
DescribeWorldGenerationJobResponse
, describeWorldGenerationJobResponse_tags
- A map that contains tag keys and tag values that are attached to the
world generation job.
DescribeWorldGenerationJobResponse
, describeWorldGenerationJobResponse_template
- The Amazon Resource Name (arn) of the world template.
DescribeWorldGenerationJobResponse
, describeWorldGenerationJobResponse_worldCount
- Information about the world count.
$sel:worldTags:DescribeWorldGenerationJobResponse'
, describeWorldGenerationJobResponse_worldTags
- A map that contains tag keys and tag values that are attached to the
generated worlds.
$sel:httpStatus:DescribeWorldGenerationJobResponse'
, describeWorldGenerationJobResponse_httpStatus
- The response's http status code.
DescribeWorldTemplate
data DescribeWorldTemplate Source #
See: newDescribeWorldTemplate
smart constructor.
Instances
newDescribeWorldTemplate Source #
Create a value of DescribeWorldTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWorldTemplate
, describeWorldTemplate_template
- The Amazon Resource Name (arn) of the world template you want to
describe.
data DescribeWorldTemplateResponse Source #
See: newDescribeWorldTemplateResponse
smart constructor.
DescribeWorldTemplateResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Int |
Instances
newDescribeWorldTemplateResponse Source #
Create a value of DescribeWorldTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWorldTemplateResponse
, describeWorldTemplateResponse_arn
- The Amazon Resource Name (ARN) of the world template.
DescribeWorldTemplateResponse
, describeWorldTemplateResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
DescribeWorldTemplateResponse
, describeWorldTemplateResponse_createdAt
- The time, in milliseconds since the epoch, when the world template was
created.
DescribeWorldTemplateResponse
, describeWorldTemplateResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the world template was
last updated.
DescribeWorldTemplateResponse
, describeWorldTemplateResponse_name
- The name of the world template.
DescribeWorldTemplateResponse
, describeWorldTemplateResponse_tags
- A map that contains tag keys and tag values that are attached to the
world template.
DescribeWorldTemplateResponse
, describeWorldTemplateResponse_version
- The version of the world template that you're using.
$sel:httpStatus:DescribeWorldTemplateResponse'
, describeWorldTemplateResponse_httpStatus
- The response's http status code.
GetWorldTemplateBody
data GetWorldTemplateBody Source #
See: newGetWorldTemplateBody
smart constructor.
Instances
newGetWorldTemplateBody :: GetWorldTemplateBody Source #
Create a value of GetWorldTemplateBody
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWorldTemplateBody
, getWorldTemplateBody_generationJob
- The Amazon Resource Name (arn) of the world generator job.
GetWorldTemplateBody
, getWorldTemplateBody_template
- The Amazon Resource Name (arn) of the world template.
data GetWorldTemplateBodyResponse Source #
See: newGetWorldTemplateBodyResponse
smart constructor.
Instances
newGetWorldTemplateBodyResponse Source #
Create a value of GetWorldTemplateBodyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:templateBody:GetWorldTemplateBodyResponse'
, getWorldTemplateBodyResponse_templateBody
- The world template body.
$sel:httpStatus:GetWorldTemplateBodyResponse'
, getWorldTemplateBodyResponse_httpStatus
- The response's http status code.
ListRobotApplications (Paginated)
data ListRobotApplications Source #
See: newListRobotApplications
smart constructor.
Instances
newListRobotApplications :: ListRobotApplications Source #
Create a value of ListRobotApplications
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListRobotApplications'
, listRobotApplications_filters
- Optional filters to limit results.
The filter name name
is supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters.
$sel:maxResults:ListRobotApplications'
, listRobotApplications_maxResults
- When this parameter is used, ListRobotApplications
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListRobotApplications
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListRobotApplications
returns up to 100
results and a nextToken
value if applicable.
ListRobotApplications
, listRobotApplications_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListRobotApplications
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
$sel:versionQualifier:ListRobotApplications'
, listRobotApplications_versionQualifier
- The version qualifier of the robot application.
data ListRobotApplicationsResponse Source #
See: newListRobotApplicationsResponse
smart constructor.
Instances
newListRobotApplicationsResponse Source #
Create a value of ListRobotApplicationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRobotApplications
, listRobotApplicationsResponse_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListRobotApplications
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
$sel:robotApplicationSummaries:ListRobotApplicationsResponse'
, listRobotApplicationsResponse_robotApplicationSummaries
- A list of robot application summaries that meet the criteria of the
request.
$sel:httpStatus:ListRobotApplicationsResponse'
, listRobotApplicationsResponse_httpStatus
- The response's http status code.
ListSimulationApplications (Paginated)
data ListSimulationApplications Source #
See: newListSimulationApplications
smart constructor.
Instances
newListSimulationApplications :: ListSimulationApplications Source #
Create a value of ListSimulationApplications
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListSimulationApplications'
, listSimulationApplications_filters
- Optional list of filters to limit results.
The filter name name
is supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters.
$sel:maxResults:ListSimulationApplications'
, listSimulationApplications_maxResults
- When this parameter is used, ListSimulationApplications
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListSimulationApplications
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListSimulationApplications
returns up to
100 results and a nextToken
value if applicable.
ListSimulationApplications
, listSimulationApplications_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call
ListSimulationApplications
again and assign that token to the request
object's nextToken
parameter. If there are no remaining results, the
previous response object's NextToken parameter is set to null.
$sel:versionQualifier:ListSimulationApplications'
, listSimulationApplications_versionQualifier
- The version qualifier of the simulation application.
data ListSimulationApplicationsResponse Source #
See: newListSimulationApplicationsResponse
smart constructor.
Instances
newListSimulationApplicationsResponse Source #
Create a value of ListSimulationApplicationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSimulationApplications
, listSimulationApplicationsResponse_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call
ListSimulationApplications
again and assign that token to the request
object's nextToken
parameter. If there are no remaining results, the
previous response object's NextToken parameter is set to null.
$sel:simulationApplicationSummaries:ListSimulationApplicationsResponse'
, listSimulationApplicationsResponse_simulationApplicationSummaries
- A list of simulation application summaries that meet the criteria of the
request.
$sel:httpStatus:ListSimulationApplicationsResponse'
, listSimulationApplicationsResponse_httpStatus
- The response's http status code.
ListSimulationJobBatches (Paginated)
data ListSimulationJobBatches Source #
See: newListSimulationJobBatches
smart constructor.
Instances
newListSimulationJobBatches :: ListSimulationJobBatches Source #
Create a value of ListSimulationJobBatches
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListSimulationJobBatches'
, listSimulationJobBatches_filters
- Optional filters to limit results.
$sel:maxResults:ListSimulationJobBatches'
, listSimulationJobBatches_maxResults
- When this parameter is used, ListSimulationJobBatches
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListSimulationJobBatches
request with the returned
nextToken
value.
ListSimulationJobBatches
, listSimulationJobBatches_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call
ListSimulationJobBatches
again and assign that token to the request
object's nextToken
parameter. If there are no remaining results, the
previous response object's NextToken parameter is set to null.
data ListSimulationJobBatchesResponse Source #
See: newListSimulationJobBatchesResponse
smart constructor.
Instances
newListSimulationJobBatchesResponse Source #
Create a value of ListSimulationJobBatchesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSimulationJobBatches
, listSimulationJobBatchesResponse_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call
ListSimulationJobBatches
again and assign that token to the request
object's nextToken
parameter. If there are no remaining results, the
previous response object's NextToken parameter is set to null.
$sel:simulationJobBatchSummaries:ListSimulationJobBatchesResponse'
, listSimulationJobBatchesResponse_simulationJobBatchSummaries
- A list of simulation job batch summaries.
$sel:httpStatus:ListSimulationJobBatchesResponse'
, listSimulationJobBatchesResponse_httpStatus
- The response's http status code.
ListSimulationJobs (Paginated)
data ListSimulationJobs Source #
See: newListSimulationJobs
smart constructor.
Instances
newListSimulationJobs :: ListSimulationJobs Source #
Create a value of ListSimulationJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListSimulationJobs'
, listSimulationJobs_filters
- Optional filters to limit results.
The filter names status
and simulationApplicationName
and
robotApplicationName
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 Preparing
or the status Running
.
$sel:maxResults:ListSimulationJobs'
, listSimulationJobs_maxResults
- When this parameter is used, ListSimulationJobs
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListSimulationJobs
request with the returned
nextToken
value. This value can be between 1 and 1000. If this
parameter is not used, then ListSimulationJobs
returns up to 1000
results and a nextToken
value if applicable.
ListSimulationJobs
, listSimulationJobs_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListSimulationJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
data ListSimulationJobsResponse Source #
See: newListSimulationJobsResponse
smart constructor.
Instances
newListSimulationJobsResponse Source #
Create a value of ListSimulationJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSimulationJobs
, listSimulationJobsResponse_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListSimulationJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
$sel:httpStatus:ListSimulationJobsResponse'
, listSimulationJobsResponse_httpStatus
- The response's http status code.
$sel:simulationJobSummaries:ListSimulationJobsResponse'
, listSimulationJobsResponse_simulationJobSummaries
- A list of simulation job summaries that meet the criteria of the
request.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- The list of all tags added to the specified resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListWorldExportJobs (Paginated)
data ListWorldExportJobs Source #
See: newListWorldExportJobs
smart constructor.
Instances
newListWorldExportJobs :: ListWorldExportJobs Source #
Create a value of ListWorldExportJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListWorldExportJobs'
, listWorldExportJobs_filters
- Optional filters to limit results. You can use generationJobId
and
templateId
.
$sel:maxResults:ListWorldExportJobs'
, listWorldExportJobs_maxResults
- When this parameter is used, ListWorldExportJobs
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListWorldExportJobs
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListWorldExportJobs
returns up to 100
results and a nextToken
value if applicable.
ListWorldExportJobs
, listWorldExportJobs_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListWorldExportJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
data ListWorldExportJobsResponse Source #
See: newListWorldExportJobsResponse
smart constructor.
Instances
newListWorldExportJobsResponse Source #
Create a value of ListWorldExportJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorldExportJobs
, listWorldExportJobsResponse_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call
ListWorldExportJobsRequest
again and assign that token to the request
object's nextToken
parameter. If there are no remaining results, the
previous response object's NextToken parameter is set to null.
$sel:httpStatus:ListWorldExportJobsResponse'
, listWorldExportJobsResponse_httpStatus
- The response's http status code.
$sel:worldExportJobSummaries:ListWorldExportJobsResponse'
, listWorldExportJobsResponse_worldExportJobSummaries
- Summary information for world export jobs.
ListWorldGenerationJobs (Paginated)
data ListWorldGenerationJobs Source #
See: newListWorldGenerationJobs
smart constructor.
Instances
newListWorldGenerationJobs :: ListWorldGenerationJobs Source #
Create a value of ListWorldGenerationJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListWorldGenerationJobs'
, listWorldGenerationJobs_filters
- Optional filters to limit results. You can use status
and
templateId
.
$sel:maxResults:ListWorldGenerationJobs'
, listWorldGenerationJobs_maxResults
- When this parameter is used, ListWorldGeneratorJobs
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListWorldGeneratorJobs
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListWorldGeneratorJobs
returns up to 100
results and a nextToken
value if applicable.
ListWorldGenerationJobs
, listWorldGenerationJobs_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call
ListWorldGenerationJobsRequest
again and assign that token to the
request object's nextToken
parameter. If there are no remaining
results, the previous response object's NextToken parameter is set to
null.
data ListWorldGenerationJobsResponse Source #
See: newListWorldGenerationJobsResponse
smart constructor.
Instances
newListWorldGenerationJobsResponse Source #
Create a value of ListWorldGenerationJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorldGenerationJobs
, listWorldGenerationJobsResponse_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call
ListWorldGeneratorJobsRequest
again and assign that token to the
request object's nextToken
parameter. If there are no remaining
results, the previous response object's NextToken parameter is set to
null.
$sel:httpStatus:ListWorldGenerationJobsResponse'
, listWorldGenerationJobsResponse_httpStatus
- The response's http status code.
$sel:worldGenerationJobSummaries:ListWorldGenerationJobsResponse'
, listWorldGenerationJobsResponse_worldGenerationJobSummaries
- Summary information for world generator jobs.
ListWorldTemplates (Paginated)
data ListWorldTemplates Source #
See: newListWorldTemplates
smart constructor.
Instances
newListWorldTemplates :: ListWorldTemplates Source #
Create a value of ListWorldTemplates
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListWorldTemplates'
, listWorldTemplates_maxResults
- When this parameter is used, ListWorldTemplates
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListWorldTemplates
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListWorldTemplates
returns up to 100
results and a nextToken
value if applicable.
ListWorldTemplates
, listWorldTemplates_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListWorldTemplates
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
data ListWorldTemplatesResponse Source #
See: newListWorldTemplatesResponse
smart constructor.
Instances
newListWorldTemplatesResponse Source #
Create a value of ListWorldTemplatesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorldTemplates
, listWorldTemplatesResponse_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListWorldTemplates
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
$sel:templateSummaries:ListWorldTemplatesResponse'
, listWorldTemplatesResponse_templateSummaries
- Summary information for templates.
$sel:httpStatus:ListWorldTemplatesResponse'
, listWorldTemplatesResponse_httpStatus
- The response's http status code.
ListWorlds (Paginated)
data ListWorlds Source #
See: newListWorlds
smart constructor.
Instances
newListWorlds :: ListWorlds Source #
Create a value of ListWorlds
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListWorlds'
, listWorlds_filters
- Optional filters to limit results. You can use status
.
$sel:maxResults:ListWorlds'
, listWorlds_maxResults
- When this parameter is used, ListWorlds
only returns maxResults
results in a single page along with a nextToken
response element. The
remaining results of the initial request can be seen by sending another
ListWorlds
request with the returned nextToken
value. This value can
be between 1 and 100. If this parameter is not used, then ListWorlds
returns up to 100 results and a nextToken
value if applicable.
ListWorlds
, listWorlds_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListWorlds
again and
assign that token to the request object's nextToken
parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
data ListWorldsResponse Source #
See: newListWorldsResponse
smart constructor.
Instances
newListWorldsResponse Source #
Create a value of ListWorldsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorlds
, listWorldsResponse_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListWorlds
again and
assign that token to the request object's nextToken
parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
$sel:worldSummaries:ListWorldsResponse'
, listWorldsResponse_worldSummaries
- Summary information for worlds.
$sel:httpStatus:ListWorldsResponse'
, listWorldsResponse_httpStatus
- The response's http status code.
RestartSimulationJob
data RestartSimulationJob Source #
See: newRestartSimulationJob
smart constructor.
Instances
newRestartSimulationJob Source #
Create a value of RestartSimulationJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:job:RestartSimulationJob'
, restartSimulationJob_job
- The Amazon Resource Name (ARN) of the simulation job.
data RestartSimulationJobResponse Source #
See: newRestartSimulationJobResponse
smart constructor.
Instances
newRestartSimulationJobResponse Source #
Create a value of RestartSimulationJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RestartSimulationJobResponse'
, restartSimulationJobResponse_httpStatus
- The response's http status code.
StartSimulationJobBatch
data StartSimulationJobBatch Source #
See: newStartSimulationJobBatch
smart constructor.
StartSimulationJobBatch' (Maybe BatchPolicy) (Maybe Text) (Maybe (HashMap Text Text)) (NonEmpty SimulationJobRequest) |
Instances
newStartSimulationJobBatch Source #
Create a value of StartSimulationJobBatch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartSimulationJobBatch
, startSimulationJobBatch_batchPolicy
- The batch policy.
StartSimulationJobBatch
, startSimulationJobBatch_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
StartSimulationJobBatch
, startSimulationJobBatch_tags
- A map that contains tag keys and tag values that are attached to the
deployment job batch.
$sel:createSimulationJobRequests:StartSimulationJobBatch'
, startSimulationJobBatch_createSimulationJobRequests
- A list of simulation job requests to create in the batch.
data StartSimulationJobBatchResponse Source #
See: newStartSimulationJobBatchResponse
smart constructor.
Instances
newStartSimulationJobBatchResponse Source #
Create a value of StartSimulationJobBatchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartSimulationJobBatchResponse
, startSimulationJobBatchResponse_arn
- The Amazon Resource Name (arn) of the batch.
StartSimulationJobBatch
, startSimulationJobBatchResponse_batchPolicy
- The batch policy.
StartSimulationJobBatch
, startSimulationJobBatchResponse_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
StartSimulationJobBatchResponse
, startSimulationJobBatchResponse_createdAt
- The time, in milliseconds since the epoch, when the simulation job batch
was created.
$sel:createdRequests:StartSimulationJobBatchResponse'
, startSimulationJobBatchResponse_createdRequests
- A list of created simulation job request summaries.
$sel:failedRequests:StartSimulationJobBatchResponse'
, startSimulationJobBatchResponse_failedRequests
- 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.
StartSimulationJobBatchResponse
, startSimulationJobBatchResponse_failureCode
- The failure code if the simulation job batch failed.
StartSimulationJobBatchResponse
, startSimulationJobBatchResponse_failureReason
- The reason the simulation job batch failed.
$sel:pendingRequests:StartSimulationJobBatchResponse'
, startSimulationJobBatchResponse_pendingRequests
- A list of pending simulation job requests. These requests have not yet
been created into simulation jobs.
StartSimulationJobBatchResponse
, startSimulationJobBatchResponse_status
- The status of the simulation job batch.
- Pending
- The simulation job batch request is pending.
- InProgress
- The simulation job batch is in progress.
- Failed
- The simulation job batch failed. One or more simulation job requests
could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
- 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
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
- The simulation batch job was cancelled.
- Canceling
- The simulation batch job is being cancelled.
- Completing
- The simulation batch job is completing.
- TimingOut
- The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
- The simulation batch job timed out.
StartSimulationJobBatch
, startSimulationJobBatchResponse_tags
- A map that contains tag keys and tag values that are attached to the
deployment job batch.
$sel:httpStatus:StartSimulationJobBatchResponse'
, startSimulationJobBatchResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are
tagging.
TagResource
, tagResource_tags
- A map that contains tag keys and tag values that are attached to the
resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are
removing tags.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A map that contains tag keys and tag values that will be unattached from
the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateRobotApplication
data UpdateRobotApplication Source #
See: newUpdateRobotApplication
smart constructor.
UpdateRobotApplication' (Maybe Text) (Maybe Environment) (Maybe [SourceConfig]) Text RobotSoftwareSuite |
Instances
newUpdateRobotApplication Source #
Create a value of UpdateRobotApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:currentRevisionId:UpdateRobotApplication'
, updateRobotApplication_currentRevisionId
- The revision id for the robot application.
UpdateRobotApplication
, updateRobotApplication_environment
- The object that contains the Docker image URI for your robot
application.
UpdateRobotApplication
, updateRobotApplication_sources
- The sources of the robot application.
UpdateRobotApplication
, updateRobotApplication_application
- The application information for the robot application.
UpdateRobotApplication
, updateRobotApplication_robotSoftwareSuite
- The robot software suite (ROS distribution) used by the robot
application.
data UpdateRobotApplicationResponse Source #
See: newUpdateRobotApplicationResponse
smart constructor.
UpdateRobotApplicationResponse' (Maybe Text) (Maybe Environment) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe [Source]) (Maybe Text) Int |
Instances
newUpdateRobotApplicationResponse Source #
Create a value of UpdateRobotApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRobotApplicationResponse
, updateRobotApplicationResponse_arn
- The Amazon Resource Name (ARN) of the updated robot application.
UpdateRobotApplication
, updateRobotApplicationResponse_environment
- The object that contains the Docker image URI for your robot
application.
UpdateRobotApplicationResponse
, updateRobotApplicationResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the robot application
was last updated.
UpdateRobotApplicationResponse
, updateRobotApplicationResponse_name
- The name of the robot application.
$sel:revisionId:UpdateRobotApplicationResponse'
, updateRobotApplicationResponse_revisionId
- The revision id of the robot application.
UpdateRobotApplication
, updateRobotApplicationResponse_robotSoftwareSuite
- The robot software suite (ROS distribution) used by the robot
application.
UpdateRobotApplication
, updateRobotApplicationResponse_sources
- The sources of the robot application.
UpdateRobotApplicationResponse
, updateRobotApplicationResponse_version
- The version of the robot application.
$sel:httpStatus:UpdateRobotApplicationResponse'
, updateRobotApplicationResponse_httpStatus
- The response's http status code.
UpdateSimulationApplication
data UpdateSimulationApplication Source #
See: newUpdateSimulationApplication
smart constructor.
UpdateSimulationApplication' (Maybe Text) (Maybe Environment) (Maybe RenderingEngine) (Maybe [SourceConfig]) Text SimulationSoftwareSuite RobotSoftwareSuite |
Instances
newUpdateSimulationApplication Source #
Create a value of UpdateSimulationApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:currentRevisionId:UpdateSimulationApplication'
, updateSimulationApplication_currentRevisionId
- The revision id for the robot application.
UpdateSimulationApplication
, updateSimulationApplication_environment
- The object that contains the Docker image URI for your simulation
application.
UpdateSimulationApplication
, updateSimulationApplication_renderingEngine
- The rendering engine for the simulation application.
UpdateSimulationApplication
, updateSimulationApplication_sources
- The sources of the simulation application.
UpdateSimulationApplication
, updateSimulationApplication_application
- The application information for the simulation application.
UpdateSimulationApplication
, updateSimulationApplication_simulationSoftwareSuite
- The simulation software suite used by the simulation application.
UpdateSimulationApplication
, updateSimulationApplication_robotSoftwareSuite
- Information about the robot software suite (ROS distribution).
data UpdateSimulationApplicationResponse Source #
See: newUpdateSimulationApplicationResponse
smart constructor.
Instances
newUpdateSimulationApplicationResponse Source #
Create a value of UpdateSimulationApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSimulationApplicationResponse
, updateSimulationApplicationResponse_arn
- The Amazon Resource Name (ARN) of the updated simulation application.
UpdateSimulationApplication
, updateSimulationApplicationResponse_environment
- The object that contains the Docker image URI used for your simulation
application.
UpdateSimulationApplicationResponse
, updateSimulationApplicationResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation
application was last updated.
UpdateSimulationApplicationResponse
, updateSimulationApplicationResponse_name
- The name of the simulation application.
UpdateSimulationApplication
, updateSimulationApplicationResponse_renderingEngine
- The rendering engine for the simulation application.
$sel:revisionId:UpdateSimulationApplicationResponse'
, updateSimulationApplicationResponse_revisionId
- The revision id of the simulation application.
UpdateSimulationApplication
, updateSimulationApplicationResponse_robotSoftwareSuite
- Information about the robot software suite (ROS distribution).
UpdateSimulationApplication
, updateSimulationApplicationResponse_simulationSoftwareSuite
- The simulation software suite used by the simulation application.
UpdateSimulationApplication
, updateSimulationApplicationResponse_sources
- The sources of the simulation application.
UpdateSimulationApplicationResponse
, updateSimulationApplicationResponse_version
- The version of the robot application.
$sel:httpStatus:UpdateSimulationApplicationResponse'
, updateSimulationApplicationResponse_httpStatus
- The response's http status code.
UpdateWorldTemplate
data UpdateWorldTemplate Source #
See: newUpdateWorldTemplate
smart constructor.
Instances
newUpdateWorldTemplate Source #
Create a value of UpdateWorldTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorldTemplate
, updateWorldTemplate_name
- The name of the template.
$sel:templateBody:UpdateWorldTemplate'
, updateWorldTemplate_templateBody
- The world template body.
$sel:templateLocation:UpdateWorldTemplate'
, updateWorldTemplate_templateLocation
- The location of the world template.
UpdateWorldTemplate
, updateWorldTemplate_template
- The Amazon Resource Name (arn) of the world template to update.
data UpdateWorldTemplateResponse Source #
See: newUpdateWorldTemplateResponse
smart constructor.
Instances
newUpdateWorldTemplateResponse Source #
Create a value of UpdateWorldTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorldTemplateResponse
, updateWorldTemplateResponse_arn
- The Amazon Resource Name (arn) of the world template.
UpdateWorldTemplateResponse
, updateWorldTemplateResponse_createdAt
- The time, in milliseconds since the epoch, when the world template was
created.
UpdateWorldTemplateResponse
, updateWorldTemplateResponse_lastUpdatedAt
- The time, in milliseconds since the epoch, when the world template was
last updated.
UpdateWorldTemplate
, updateWorldTemplateResponse_name
- The name of the world template.
$sel:httpStatus:UpdateWorldTemplateResponse'
, updateWorldTemplateResponse_httpStatus
- The response's http status code.
Types
Architecture
newtype Architecture Source #
pattern Architecture_ARM64 :: Architecture | |
pattern Architecture_ARMHF :: Architecture | |
pattern Architecture_X86_64 :: Architecture |
Instances
ComputeType
newtype ComputeType Source #
pattern ComputeType_CPU :: ComputeType | |
pattern ComputeType_GPU_AND_CPU :: ComputeType |
Instances
DataSourceType
newtype DataSourceType Source #
pattern DataSourceType_Archive :: DataSourceType | |
pattern DataSourceType_File :: DataSourceType | |
pattern DataSourceType_Prefix :: DataSourceType |
Instances
ExitBehavior
newtype ExitBehavior Source #
pattern ExitBehavior_FAIL :: ExitBehavior | |
pattern ExitBehavior_RESTART :: ExitBehavior |
Instances
FailureBehavior
newtype FailureBehavior Source #
pattern FailureBehavior_Continue :: FailureBehavior | |
pattern FailureBehavior_Fail :: FailureBehavior |
Instances
RenderingEngineType
newtype RenderingEngineType Source #
pattern RenderingEngineType_OGRE :: RenderingEngineType |
Instances
RobotSoftwareSuiteType
newtype RobotSoftwareSuiteType Source #
pattern RobotSoftwareSuiteType_General :: RobotSoftwareSuiteType | |
pattern RobotSoftwareSuiteType_ROS :: RobotSoftwareSuiteType | |
pattern RobotSoftwareSuiteType_ROS2 :: RobotSoftwareSuiteType |
Instances
RobotSoftwareSuiteVersionType
newtype RobotSoftwareSuiteVersionType Source #
Instances
SimulationJobBatchErrorCode
newtype SimulationJobBatchErrorCode Source #
Instances
SimulationJobBatchStatus
newtype SimulationJobBatchStatus Source #
Instances
SimulationJobErrorCode
newtype SimulationJobErrorCode Source #
Instances
SimulationJobStatus
newtype SimulationJobStatus Source #
pattern SimulationJobStatus_Canceled :: SimulationJobStatus | |
pattern SimulationJobStatus_Completed :: SimulationJobStatus | |
pattern SimulationJobStatus_Failed :: SimulationJobStatus | |
pattern SimulationJobStatus_Pending :: SimulationJobStatus | |
pattern SimulationJobStatus_Preparing :: SimulationJobStatus | |
pattern SimulationJobStatus_Restarting :: SimulationJobStatus | |
pattern SimulationJobStatus_Running :: SimulationJobStatus | |
pattern SimulationJobStatus_RunningFailed :: SimulationJobStatus | |
pattern SimulationJobStatus_Terminated :: SimulationJobStatus | |
pattern SimulationJobStatus_Terminating :: SimulationJobStatus |
Instances
SimulationSoftwareSuiteType
newtype SimulationSoftwareSuiteType Source #
Instances
UploadBehavior
newtype UploadBehavior Source #
pattern UploadBehavior_UPLOAD_ON_TERMINATE :: UploadBehavior | |
pattern UploadBehavior_UPLOAD_ROLLING_AUTO_REMOVE :: UploadBehavior |
Instances
WorldExportJobErrorCode
newtype WorldExportJobErrorCode Source #
Instances
WorldExportJobStatus
newtype WorldExportJobStatus Source #
pattern WorldExportJobStatus_Canceled :: WorldExportJobStatus | |
pattern WorldExportJobStatus_Canceling :: WorldExportJobStatus | |
pattern WorldExportJobStatus_Completed :: WorldExportJobStatus | |
pattern WorldExportJobStatus_Failed :: WorldExportJobStatus | |
pattern WorldExportJobStatus_Pending :: WorldExportJobStatus | |
pattern WorldExportJobStatus_Running :: WorldExportJobStatus |
Instances
WorldGenerationJobErrorCode
newtype WorldGenerationJobErrorCode Source #
Instances
WorldGenerationJobStatus
newtype WorldGenerationJobStatus Source #
Instances
BatchPolicy
data BatchPolicy Source #
Information about the batch policy.
See: newBatchPolicy
smart constructor.
BatchPolicy' (Maybe Int) (Maybe Integer) |
Instances
newBatchPolicy :: BatchPolicy Source #
Create a value of BatchPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxConcurrency:BatchPolicy'
, batchPolicy_maxConcurrency
- The number of active simulation jobs create as part of the batch that
can be in an active state at the same time.
Active states include: Pending
,Preparing
, Running
, Restarting
,
RunningFailed
and Terminating
. All other states are terminal states.
$sel:timeoutInSeconds:BatchPolicy'
, batchPolicy_timeoutInSeconds
- The amount of time, in seconds, to wait for the batch to complete.
If a batch times out, and there are pending requests that were failing
due to an internal failure (like InternalServiceError
), they will be
moved to the failed list and the batch status will be Failed
. 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
TimedOut
.
Compute
Compute information for the simulation job.
See: newCompute
smart constructor.
Instances
FromJSON Compute Source # | |
ToJSON Compute Source # | |
Defined in Amazonka.RobOMaker.Types.Compute | |
Generic Compute Source # | |
Read Compute Source # | |
Show Compute Source # | |
NFData Compute Source # | |
Defined in Amazonka.RobOMaker.Types.Compute | |
Eq Compute Source # | |
Hashable Compute Source # | |
Defined in Amazonka.RobOMaker.Types.Compute | |
type Rep Compute Source # | |
Defined in Amazonka.RobOMaker.Types.Compute type Rep Compute = D1 ('MetaData "Compute" "Amazonka.RobOMaker.Types.Compute" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "Compute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComputeType)) :*: (S1 ('MetaSel ('Just "gpuUnitLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "simulationUnitLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) |
newCompute :: Compute Source #
Create a value of Compute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computeType:Compute'
, compute_computeType
- Compute type information for the simulation job.
$sel:gpuUnitLimit:Compute'
, compute_gpuUnitLimit
- Compute GPU unit limit for the simulation job. It is the same as the
number of GPUs allocated to the SimulationJob.
$sel:simulationUnitLimit:Compute'
, compute_simulationUnitLimit
- 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 maximum value provided. The default is 15.
ComputeResponse
data ComputeResponse Source #
Compute information for the simulation job
See: newComputeResponse
smart constructor.
Instances
newComputeResponse :: ComputeResponse Source #
Create a value of ComputeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computeType:ComputeResponse'
, computeResponse_computeType
- Compute type response information for the simulation job.
$sel:gpuUnitLimit:ComputeResponse'
, computeResponse_gpuUnitLimit
- Compute GPU unit limit for the simulation job. It is the same as the
number of GPUs allocated to the SimulationJob.
$sel:simulationUnitLimit:ComputeResponse'
, computeResponse_simulationUnitLimit
- 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 maximum value provided. The default is 15.
DataSource
data DataSource Source #
Information about a data source.
See: newDataSource
smart constructor.
DataSource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [S3KeyOutput]) (Maybe DataSourceType) |
Instances
newDataSource :: DataSource Source #
Create a value of DataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destination:DataSource'
, dataSource_destination
- The location where your files are mounted in the container image.
If you've specified the type
of the data source as an Archive
, you
must provide an Amazon S3 object key to your archive. The object key
must point to either a .zip
or .tar.gz
file.
If you've specified the type
of the data source as a Prefix
, you
provide the Amazon S3 prefix that points to the files that you are using
for your data source.
If you've specified the type
of the data source as a File
, you
provide the Amazon S3 path to the file that you're using as your data
source.
$sel:name:DataSource'
, dataSource_name
- The name of the data source.
$sel:s3Bucket:DataSource'
, dataSource_s3Bucket
- The S3 bucket where the data files are located.
$sel:s3Keys:DataSource'
, dataSource_s3Keys
- The list of S3 keys identifying the data source files.
$sel:type':DataSource'
, dataSource_type
- The data type for the data source that you're using for your container
image or simulation job. You can use this field to specify whether your
data source is an Archive, an Amazon S3 prefix, or a file.
If you don't specify a field, the default value is File
.
DataSourceConfig
data DataSourceConfig Source #
Information about a data source.
See: newDataSourceConfig
smart constructor.
Instances
:: Text | |
-> Text | |
-> NonEmpty Text | |
-> DataSourceConfig |
Create a value of DataSourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destination:DataSourceConfig'
, dataSourceConfig_destination
- The location where your files are mounted in the container image.
If you've specified the type
of the data source as an Archive
, you
must provide an Amazon S3 object key to your archive. The object key
must point to either a .zip
or .tar.gz
file.
If you've specified the type
of the data source as a Prefix
, you
provide the Amazon S3 prefix that points to the files that you are using
for your data source.
If you've specified the type
of the data source as a File
, you
provide the Amazon S3 path to the file that you're using as your data
source.
$sel:type':DataSourceConfig'
, dataSourceConfig_type
- The data type for the data source that you're using for your container
image or simulation job. You can use this field to specify whether your
data source is an Archive, an Amazon S3 prefix, or a file.
If you don't specify a field, the default value is File
.
$sel:name:DataSourceConfig'
, dataSourceConfig_name
- The name of the data source.
$sel:s3Bucket:DataSourceConfig'
, dataSourceConfig_s3Bucket
- The S3 bucket where the data files are located.
$sel:s3Keys:DataSourceConfig'
, dataSourceConfig_s3Keys
- The list of S3 keys identifying the data source files.
Environment
data Environment Source #
The object that contains the Docker image URI for either your robot or simulation applications.
See: newEnvironment
smart constructor.
Instances
newEnvironment :: Environment Source #
Create a value of Environment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:uri:Environment'
, environment_uri
- The Docker image URI for either your robot or simulation applications.
FailedCreateSimulationJobRequest
data FailedCreateSimulationJobRequest Source #
Information about a failed create simulation job request.
See: newFailedCreateSimulationJobRequest
smart constructor.
FailedCreateSimulationJobRequest' (Maybe POSIX) (Maybe SimulationJobErrorCode) (Maybe Text) (Maybe SimulationJobRequest) |
Instances
newFailedCreateSimulationJobRequest :: FailedCreateSimulationJobRequest Source #
Create a value of FailedCreateSimulationJobRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failedAt:FailedCreateSimulationJobRequest'
, failedCreateSimulationJobRequest_failedAt
- The time, in milliseconds since the epoch, when the simulation job batch
failed.
$sel:failureCode:FailedCreateSimulationJobRequest'
, failedCreateSimulationJobRequest_failureCode
- The failure code.
$sel:failureReason:FailedCreateSimulationJobRequest'
, failedCreateSimulationJobRequest_failureReason
- The failure reason of the simulation job request.
$sel:request:FailedCreateSimulationJobRequest'
, failedCreateSimulationJobRequest_request
- The simulation job request.
FailureSummary
data FailureSummary Source #
Information about worlds that failed.
See: newFailureSummary
smart constructor.
FailureSummary' (Maybe [WorldFailure]) (Maybe Int) |
Instances
newFailureSummary :: FailureSummary Source #
Create a value of FailureSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failures:FailureSummary'
, failureSummary_failures
- The worlds that failed.
$sel:totalFailureCount:FailureSummary'
, failureSummary_totalFailureCount
- The total number of failures.
Filter
Information about a filter.
See: newFilter
smart constructor.
Instances
ToJSON Filter Source # | |
Defined in Amazonka.RobOMaker.Types.Filter | |
Generic Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.RobOMaker.Types.Filter | |
Eq Filter Source # | |
Hashable Filter Source # | |
Defined in Amazonka.RobOMaker.Types.Filter | |
type Rep Filter Source # | |
Defined in Amazonka.RobOMaker.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.RobOMaker.Types.Filter" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) |
Create a value of Filter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Filter'
, filter_name
- The name of the filter.
$sel:values:Filter'
, filter_values
- A list of values.
FinishedWorldsSummary
data FinishedWorldsSummary Source #
Information about worlds that finished.
See: newFinishedWorldsSummary
smart constructor.
Instances
newFinishedWorldsSummary :: FinishedWorldsSummary Source #
Create a value of FinishedWorldsSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureSummary:FinishedWorldsSummary'
, finishedWorldsSummary_failureSummary
- Information about worlds that failed.
$sel:finishedCount:FinishedWorldsSummary'
, finishedWorldsSummary_finishedCount
- The total number of finished worlds.
$sel:succeededWorlds:FinishedWorldsSummary'
, finishedWorldsSummary_succeededWorlds
- A list of worlds that succeeded.
LaunchConfig
data LaunchConfig Source #
Information about a launch configuration.
See: newLaunchConfig
smart constructor.
LaunchConfig' (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe PortForwardingConfig) (Maybe Bool) |
Instances
newLaunchConfig :: LaunchConfig Source #
Create a value of LaunchConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:command:LaunchConfig'
, launchConfig_command
- If you've specified General
as the value for your
RobotSoftwareSuite
, you can use this field to specify a list of
commands for your container image.
If you've specified SimulationRuntime
as the value for your
SimulationSoftwareSuite
, you can use this field to specify a list of
commands for your container image.
$sel:environmentVariables:LaunchConfig'
, launchConfig_environmentVariables
- The environment variables for the application launch.
$sel:launchFile:LaunchConfig'
, launchConfig_launchFile
- The launch file name.
$sel:packageName:LaunchConfig'
, launchConfig_packageName
- The package name.
$sel:portForwardingConfig:LaunchConfig'
, launchConfig_portForwardingConfig
- The port forwarding configuration.
$sel:streamUI:LaunchConfig'
, launchConfig_streamUI
- Boolean indicating whether a streaming session will be configured for
the application. If True
, 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.
LoggingConfig
data LoggingConfig Source #
The logging configuration.
See: newLoggingConfig
smart constructor.
Instances
newLoggingConfig :: LoggingConfig Source #
Create a value of LoggingConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recordAllRosTopics:LoggingConfig'
, loggingConfig_recordAllRosTopics
- A boolean indicating whether to record all ROS topics.
This API is no longer supported and will throw an error if used.
NetworkInterface
data NetworkInterface Source #
Describes a network interface.
See: newNetworkInterface
smart constructor.
Instances
newNetworkInterface :: NetworkInterface Source #
Create a value of NetworkInterface
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:networkInterfaceId:NetworkInterface'
, networkInterface_networkInterfaceId
- The ID of the network interface.
$sel:privateIpAddress:NetworkInterface'
, networkInterface_privateIpAddress
- The IPv4 address of the network interface within the subnet.
$sel:publicIpAddress:NetworkInterface'
, networkInterface_publicIpAddress
- The IPv4 public address of the network interface.
OutputLocation
data OutputLocation Source #
The output location.
See: newOutputLocation
smart constructor.
Instances
newOutputLocation :: OutputLocation Source #
Create a value of OutputLocation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Bucket:OutputLocation'
, outputLocation_s3Bucket
- The S3 bucket for output.
$sel:s3Prefix:OutputLocation'
, outputLocation_s3Prefix
- The S3 folder in the s3Bucket
where output files will be placed.
PortForwardingConfig
data PortForwardingConfig Source #
Configuration information for port forwarding.
See: newPortForwardingConfig
smart constructor.
Instances
newPortForwardingConfig :: PortForwardingConfig Source #
Create a value of PortForwardingConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:portMappings:PortForwardingConfig'
, portForwardingConfig_portMappings
- The port mappings for the configuration.
PortMapping
data PortMapping Source #
An object representing a port mapping.
See: newPortMapping
smart constructor.
Instances
Create a value of PortMapping
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enableOnPublicIp:PortMapping'
, portMapping_enableOnPublicIp
- A Boolean indicating whether to enable this port mapping on public IP.
$sel:jobPort:PortMapping'
, portMapping_jobPort
- The port number on the simulation job instance to use as a remote
connection point.
$sel:applicationPort:PortMapping'
, portMapping_applicationPort
- The port number on the application.
RenderingEngine
data RenderingEngine Source #
Information about a rendering engine.
See: newRenderingEngine
smart constructor.
Instances
newRenderingEngine :: RenderingEngine Source #
Create a value of RenderingEngine
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:RenderingEngine'
, renderingEngine_name
- The name of the rendering engine.
$sel:version:RenderingEngine'
, renderingEngine_version
- The version of the rendering engine.
RobotApplicationConfig
data RobotApplicationConfig Source #
Application configuration information for a robot.
See: newRobotApplicationConfig
smart constructor.
RobotApplicationConfig' (Maybe Text) (Maybe [Tool]) (Maybe [UploadConfiguration]) (Maybe Bool) (Maybe Bool) Text LaunchConfig |
Instances
newRobotApplicationConfig Source #
Create a value of RobotApplicationConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationVersion:RobotApplicationConfig'
, robotApplicationConfig_applicationVersion
- The version of the robot application.
$sel:tools:RobotApplicationConfig'
, robotApplicationConfig_tools
- Information about tools configured for the robot application.
$sel:uploadConfigurations:RobotApplicationConfig'
, robotApplicationConfig_uploadConfigurations
- The upload configurations for the robot application.
$sel:useDefaultTools:RobotApplicationConfig'
, robotApplicationConfig_useDefaultTools
- A Boolean indicating whether to use default robot application tools. The
default tools are rviz, rqt, terminal and rosbag record. The default is
False
.
This API is no longer supported and will throw an error if used.
$sel:useDefaultUploadConfigurations:RobotApplicationConfig'
, robotApplicationConfig_useDefaultUploadConfigurations
- A Boolean indicating whether to use default upload configurations. By
default, .ros
and .gazebo
files are uploaded when the application
terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation
.
This API is no longer supported and will throw an error if used.
$sel:application:RobotApplicationConfig'
, robotApplicationConfig_application
- The application information for the robot application.
$sel:launchConfig:RobotApplicationConfig'
, robotApplicationConfig_launchConfig
- The launch configuration for the robot application.
RobotApplicationSummary
data RobotApplicationSummary Source #
Summary information for a robot application.
See: newRobotApplicationSummary
smart constructor.
RobotApplicationSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe Text) |
Instances
newRobotApplicationSummary :: RobotApplicationSummary Source #
Create a value of RobotApplicationSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:RobotApplicationSummary'
, robotApplicationSummary_arn
- The Amazon Resource Name (ARN) of the robot.
$sel:lastUpdatedAt:RobotApplicationSummary'
, robotApplicationSummary_lastUpdatedAt
- The time, in milliseconds since the epoch, when the robot application
was last updated.
RobotApplicationSummary
, robotApplicationSummary_name
- The name of the robot application.
$sel:robotSoftwareSuite:RobotApplicationSummary'
, robotApplicationSummary_robotSoftwareSuite
- Information about a robot software suite (ROS distribution).
RobotApplicationSummary
, robotApplicationSummary_version
- The version of the robot application.
RobotSoftwareSuite
data RobotSoftwareSuite Source #
Information about a robot software suite (ROS distribution).
See: newRobotSoftwareSuite
smart constructor.
Instances
newRobotSoftwareSuite :: RobotSoftwareSuite Source #
Create a value of RobotSoftwareSuite
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:RobotSoftwareSuite'
, robotSoftwareSuite_name
- The name of the robot software suite (ROS distribution).
$sel:version:RobotSoftwareSuite'
, robotSoftwareSuite_version
- The version of the robot software suite (ROS distribution).
S3KeyOutput
data S3KeyOutput Source #
Information about S3 keys.
See: newS3KeyOutput
smart constructor.
S3KeyOutput' (Maybe Text) (Maybe Text) |
Instances
newS3KeyOutput :: S3KeyOutput Source #
Create a value of S3KeyOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:etag:S3KeyOutput'
, s3KeyOutput_etag
- The etag for the object.
$sel:s3Key:S3KeyOutput'
, s3KeyOutput_s3Key
- The S3 key.
SimulationApplicationConfig
data SimulationApplicationConfig Source #
Information about a simulation application configuration.
See: newSimulationApplicationConfig
smart constructor.
SimulationApplicationConfig' (Maybe Text) (Maybe [Tool]) (Maybe [UploadConfiguration]) (Maybe Bool) (Maybe Bool) (Maybe [WorldConfig]) Text LaunchConfig |
Instances
newSimulationApplicationConfig Source #
Create a value of SimulationApplicationConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationVersion:SimulationApplicationConfig'
, simulationApplicationConfig_applicationVersion
- The version of the simulation application.
$sel:tools:SimulationApplicationConfig'
, simulationApplicationConfig_tools
- Information about tools configured for the simulation application.
$sel:uploadConfigurations:SimulationApplicationConfig'
, simulationApplicationConfig_uploadConfigurations
- Information about upload configurations for the simulation application.
$sel:useDefaultTools:SimulationApplicationConfig'
, simulationApplicationConfig_useDefaultTools
- A Boolean indicating whether to use default simulation application
tools. The default tools are rviz, rqt, terminal and rosbag record. The
default is False
.
This API is no longer supported and will throw an error if used.
$sel:useDefaultUploadConfigurations:SimulationApplicationConfig'
, simulationApplicationConfig_useDefaultUploadConfigurations
- A Boolean indicating whether to use default upload configurations. By
default, .ros
and .gazebo
files are uploaded when the application
terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation
.
This API is no longer supported and will throw an error if used.
$sel:worldConfigs:SimulationApplicationConfig'
, simulationApplicationConfig_worldConfigs
- A list of world configurations.
$sel:application:SimulationApplicationConfig'
, simulationApplicationConfig_application
- The application information for the simulation application.
$sel:launchConfig:SimulationApplicationConfig'
, simulationApplicationConfig_launchConfig
- The launch configuration for the simulation application.
SimulationApplicationSummary
data SimulationApplicationSummary Source #
Summary information for a simulation application.
See: newSimulationApplicationSummary
smart constructor.
SimulationApplicationSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe RobotSoftwareSuite) (Maybe SimulationSoftwareSuite) (Maybe Text) |
Instances
newSimulationApplicationSummary :: SimulationApplicationSummary Source #
Create a value of SimulationApplicationSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:SimulationApplicationSummary'
, simulationApplicationSummary_arn
- The Amazon Resource Name (ARN) of the simulation application.
$sel:lastUpdatedAt:SimulationApplicationSummary'
, simulationApplicationSummary_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation
application was last updated.
SimulationApplicationSummary
, simulationApplicationSummary_name
- The name of the simulation application.
$sel:robotSoftwareSuite:SimulationApplicationSummary'
, simulationApplicationSummary_robotSoftwareSuite
- Information about a robot software suite (ROS distribution).
$sel:simulationSoftwareSuite:SimulationApplicationSummary'
, simulationApplicationSummary_simulationSoftwareSuite
- Information about a simulation software suite.
SimulationApplicationSummary
, simulationApplicationSummary_version
- The version of the simulation application.
SimulationJob
data SimulationJob Source #
Information about a simulation job.
See: newSimulationJob
smart constructor.
SimulationJob' (Maybe Text) (Maybe Text) (Maybe ComputeResponse) (Maybe [DataSource]) (Maybe FailureBehavior) (Maybe SimulationJobErrorCode) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe LoggingConfig) (Maybe Integer) (Maybe Text) (Maybe NetworkInterface) (Maybe OutputLocation) (Maybe (NonEmpty RobotApplicationConfig)) (Maybe (NonEmpty SimulationApplicationConfig)) (Maybe Integer) (Maybe SimulationJobStatus) (Maybe (HashMap Text Text)) (Maybe VPCConfigResponse) |
Instances
newSimulationJob :: SimulationJob Source #
Create a value of SimulationJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:SimulationJob'
, simulationJob_arn
- The Amazon Resource Name (ARN) of the simulation job.
$sel:clientRequestToken:SimulationJob'
, simulationJob_clientRequestToken
- A unique identifier for this SimulationJob
request.
$sel:compute:SimulationJob'
, simulationJob_compute
- Compute information for the simulation job
$sel:dataSources:SimulationJob'
, simulationJob_dataSources
- The data sources for the simulation job.
$sel:failureBehavior:SimulationJob'
, simulationJob_failureBehavior
- The failure behavior the simulation job.
- Continue
- Leaves the host running for its maximum timeout duration after a
4XX
error code. - Fail
- Stop the simulation job and terminate the instance.
$sel:failureCode:SimulationJob'
, simulationJob_failureCode
- The failure code of the simulation job if it failed.
$sel:failureReason:SimulationJob'
, simulationJob_failureReason
- The reason why the simulation job failed.
$sel:iamRole:SimulationJob'
, simulationJob_iamRole
- 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.
$sel:lastStartedAt:SimulationJob'
, simulationJob_lastStartedAt
- The time, in milliseconds since the epoch, when the simulation job was
last started.
$sel:lastUpdatedAt:SimulationJob'
, simulationJob_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation job was
last updated.
$sel:loggingConfig:SimulationJob'
, simulationJob_loggingConfig
- The logging configuration.
$sel:maxJobDurationInSeconds:SimulationJob'
, simulationJob_maxJobDurationInSeconds
- The maximum simulation job duration in seconds. The value must be 8 days
(691,200 seconds) or less.
SimulationJob
, simulationJob_name
- The name of the simulation job.
$sel:networkInterface:SimulationJob'
, simulationJob_networkInterface
- Information about a network interface.
$sel:outputLocation:SimulationJob'
, simulationJob_outputLocation
- Location for output files generated by the simulation job.
$sel:robotApplications:SimulationJob'
, simulationJob_robotApplications
- A list of robot applications.
$sel:simulationApplications:SimulationJob'
, simulationJob_simulationApplications
- A list of simulation applications.
$sel:simulationTimeMillis:SimulationJob'
, simulationJob_simulationTimeMillis
- The simulation job execution duration in milliseconds.
$sel:status:SimulationJob'
, simulationJob_status
- Status of the simulation job.
$sel:tags:SimulationJob'
, simulationJob_tags
- A map that contains tag keys and tag values that are attached to the
simulation job.
$sel:vpcConfig:SimulationJob'
, simulationJob_vpcConfig
- VPC configuration information.
SimulationJobBatchSummary
data SimulationJobBatchSummary Source #
Information about a simulation job batch.
See: newSimulationJobBatchSummary
smart constructor.
SimulationJobBatchSummary' (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Int) (Maybe POSIX) (Maybe Int) (Maybe SimulationJobBatchStatus) |
Instances
newSimulationJobBatchSummary :: SimulationJobBatchSummary Source #
Create a value of SimulationJobBatchSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:SimulationJobBatchSummary'
, simulationJobBatchSummary_arn
- The Amazon Resource Name (ARN) of the batch.
$sel:createdAt:SimulationJobBatchSummary'
, simulationJobBatchSummary_createdAt
- The time, in milliseconds since the epoch, when the simulation job batch
was created.
$sel:createdRequestCount:SimulationJobBatchSummary'
, simulationJobBatchSummary_createdRequestCount
- The number of created simulation job requests.
$sel:failedRequestCount:SimulationJobBatchSummary'
, simulationJobBatchSummary_failedRequestCount
- The number of failed simulation job requests.
$sel:lastUpdatedAt:SimulationJobBatchSummary'
, simulationJobBatchSummary_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation job batch
was last updated.
$sel:pendingRequestCount:SimulationJobBatchSummary'
, simulationJobBatchSummary_pendingRequestCount
- The number of pending simulation job requests.
$sel:status:SimulationJobBatchSummary'
, simulationJobBatchSummary_status
- The status of the simulation job batch.
- Pending
- The simulation job batch request is pending.
- InProgress
- The simulation job batch is in progress.
- Failed
- The simulation job batch failed. One or more simulation job requests
could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
- 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
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
- The simulation batch job was cancelled.
- Canceling
- The simulation batch job is being cancelled.
- Completing
- The simulation batch job is completing.
- TimingOut
- The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
- The simulation batch job timed out.
SimulationJobRequest
data SimulationJobRequest Source #
Information about a simulation job request.
See: newSimulationJobRequest
smart constructor.
Instances
newSimulationJobRequest Source #
Create a value of SimulationJobRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:compute:SimulationJobRequest'
, simulationJobRequest_compute
- Compute information for the simulation job
$sel:dataSources:SimulationJobRequest'
, simulationJobRequest_dataSources
- Specify data sources to mount read-only files from S3 into your
simulation. These files are available under
/opt/robomaker/datasources/data_source_name
.
There is a limit of 100 files and a combined size of 25GB for all
DataSourceConfig
objects.
$sel:failureBehavior:SimulationJobRequest'
, simulationJobRequest_failureBehavior
- The failure behavior the simulation job.
- Continue
- Leaves the host running for its maximum timeout duration after a
4XX
error code. - Fail
- Stop the simulation job and terminate the instance.
$sel:iamRole:SimulationJobRequest'
, simulationJobRequest_iamRole
- 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.
$sel:loggingConfig:SimulationJobRequest'
, simulationJobRequest_loggingConfig
- Undocumented member.
$sel:outputLocation:SimulationJobRequest'
, simulationJobRequest_outputLocation
- Undocumented member.
$sel:robotApplications:SimulationJobRequest'
, simulationJobRequest_robotApplications
- The robot applications to use in the simulation job.
$sel:simulationApplications:SimulationJobRequest'
, simulationJobRequest_simulationApplications
- The simulation applications to use in the simulation job.
$sel:tags:SimulationJobRequest'
, simulationJobRequest_tags
- A map that contains tag keys and tag values that are attached to the
simulation job request.
$sel:useDefaultApplications:SimulationJobRequest'
, simulationJobRequest_useDefaultApplications
- A Boolean indicating whether to use default applications in the
simulation job. Default applications include Gazebo, rqt, rviz and
terminal access.
$sel:vpcConfig:SimulationJobRequest'
, simulationJobRequest_vpcConfig
- Undocumented member.
$sel:maxJobDurationInSeconds:SimulationJobRequest'
, simulationJobRequest_maxJobDurationInSeconds
- The maximum simulation job duration in seconds. The value must be 8 days
(691,200 seconds) or less.
SimulationJobSummary
data SimulationJobSummary Source #
Summary information for a simulation job.
See: newSimulationJobSummary
smart constructor.
SimulationJobSummary' (Maybe Text) (Maybe ComputeType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe SimulationJobStatus) |
Instances
newSimulationJobSummary :: SimulationJobSummary Source #
Create a value of SimulationJobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:SimulationJobSummary'
, simulationJobSummary_arn
- The Amazon Resource Name (ARN) of the simulation job.
$sel:computeType:SimulationJobSummary'
, simulationJobSummary_computeType
- The compute type for the simulation job summary.
$sel:dataSourceNames:SimulationJobSummary'
, simulationJobSummary_dataSourceNames
- The names of the data sources.
$sel:lastUpdatedAt:SimulationJobSummary'
, simulationJobSummary_lastUpdatedAt
- The time, in milliseconds since the epoch, when the simulation job was
last updated.
$sel:name:SimulationJobSummary'
, simulationJobSummary_name
- The name of the simulation job.
$sel:robotApplicationNames:SimulationJobSummary'
, simulationJobSummary_robotApplicationNames
- A list of simulation job robot application names.
$sel:simulationApplicationNames:SimulationJobSummary'
, simulationJobSummary_simulationApplicationNames
- A list of simulation job simulation application names.
$sel:status:SimulationJobSummary'
, simulationJobSummary_status
- The status of the simulation job.
SimulationSoftwareSuite
data SimulationSoftwareSuite Source #
Information about a simulation software suite.
See: newSimulationSoftwareSuite
smart constructor.
Instances
newSimulationSoftwareSuite :: SimulationSoftwareSuite Source #
Create a value of SimulationSoftwareSuite
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SimulationSoftwareSuite'
, simulationSoftwareSuite_name
- The name of the simulation software suite.
$sel:version:SimulationSoftwareSuite'
, simulationSoftwareSuite_version
- The version of the simulation software suite.
Source
Information about a source.
See: newSource
smart constructor.
Instances
FromJSON Source Source # | |
Generic Source Source # | |
Read Source Source # | |
Show Source Source # | |
NFData Source Source # | |
Defined in Amazonka.RobOMaker.Types.Source | |
Eq Source Source # | |
Hashable Source Source # | |
Defined in Amazonka.RobOMaker.Types.Source | |
type Rep Source Source # | |
Defined in Amazonka.RobOMaker.Types.Source type Rep Source = D1 ('MetaData "Source" "Amazonka.RobOMaker.Types.Source" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "Source'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "architecture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Architecture)) :*: S1 ('MetaSel ('Just "etag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
Create a value of Source
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:architecture:Source'
, source_architecture
- The taget processor architecture for the application.
$sel:etag:Source'
, source_etag
- A hash of the object specified by s3Bucket
and s3Key
.
$sel:s3Bucket:Source'
, source_s3Bucket
- The s3 bucket name.
$sel:s3Key:Source'
, source_s3Key
- The s3 object key.
SourceConfig
data SourceConfig Source #
Information about a source configuration.
See: newSourceConfig
smart constructor.
SourceConfig' (Maybe Architecture) (Maybe Text) (Maybe Text) |
Instances
newSourceConfig :: SourceConfig Source #
Create a value of SourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:architecture:SourceConfig'
, sourceConfig_architecture
- The target processor architecture for the application.
$sel:s3Bucket:SourceConfig'
, sourceConfig_s3Bucket
- The Amazon S3 bucket name.
$sel:s3Key:SourceConfig'
, sourceConfig_s3Key
- The s3 object key.
TemplateLocation
data TemplateLocation Source #
Information about a template location.
See: newTemplateLocation
smart constructor.
Instances
Create a value of TemplateLocation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Bucket:TemplateLocation'
, templateLocation_s3Bucket
- The Amazon S3 bucket name.
$sel:s3Key:TemplateLocation'
, templateLocation_s3Key
- The list of S3 keys identifying the data source files.
TemplateSummary
data TemplateSummary Source #
Summary information for a template.
See: newTemplateSummary
smart constructor.
Instances
newTemplateSummary :: TemplateSummary Source #
Create a value of TemplateSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:TemplateSummary'
, templateSummary_arn
- The Amazon Resource Name (ARN) of the template.
$sel:createdAt:TemplateSummary'
, templateSummary_createdAt
- The time, in milliseconds since the epoch, when the template was
created.
$sel:lastUpdatedAt:TemplateSummary'
, templateSummary_lastUpdatedAt
- The time, in milliseconds since the epoch, when the template was last
updated.
$sel:name:TemplateSummary'
, templateSummary_name
- The name of the template.
$sel:version:TemplateSummary'
, templateSummary_version
- The version of the template that you're using.
Tool
Information about a tool. Tools are used in a simulation job.
See: newTool
smart constructor.
Instances
Create a value of Tool
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exitBehavior:Tool'
, tool_exitBehavior
- Exit behavior determines what happens when your tool quits running.
RESTART
will cause your tool to be restarted. FAIL
will cause your
job to exit. The default is RESTART
.
$sel:streamOutputToCloudWatch:Tool'
, tool_streamOutputToCloudWatch
- Boolean indicating whether logs will be recorded in CloudWatch for the
tool. The default is False
.
$sel:streamUI:Tool'
, tool_streamUI
- Boolean indicating whether a streaming session will be configured for
the tool. If True
, AWS RoboMaker will configure a connection so you
can interact with the tool as it is running in the simulation. It must
have a graphical user interface. The default is False
.
$sel:name:Tool'
, tool_name
- The name of the tool.
$sel:command:Tool'
, tool_command
- Command-line arguments for the tool. It must include the tool executable
name.
UploadConfiguration
data UploadConfiguration Source #
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
See: newUploadConfiguration
smart constructor.
Instances
newUploadConfiguration Source #
:: Text | |
-> Text | |
-> UploadBehavior | |
-> UploadConfiguration |
Create a value of UploadConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:UploadConfiguration'
, uploadConfiguration_name
- 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.
For example, if your simulation output location is s3://my-bucket
and your upload configuration name is robot-test
, your files will be
uploaded to s3://my-bucket/<simid>/<runid>/robot-test
.
$sel:path:UploadConfiguration'
, uploadConfiguration_path
- Specifies the path of the file(s) to upload. Standard Unix glob matching
rules are accepted, with the addition of **
as a super asterisk. For
example, specifying /var/log/**.log
causes all .log files in the
/var/log
directory tree to be collected. For more examples, see
Glob Library.
$sel:uploadBehavior:UploadConfiguration'
, uploadConfiguration_uploadBehavior
- Specifies when to upload the files:
- UPLOAD_ON_TERMINATE
- Matching files are uploaded once the simulation enters the
TERMINATING
state. Matching files are not uploaded until all of your code (including tools) have stopped.If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
- UPLOAD_ROLLING_AUTO_REMOVE
- 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.
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.
See: newVPCConfig
smart constructor.
Instances
FromJSON VPCConfig Source # | |
ToJSON VPCConfig Source # | |
Defined in Amazonka.RobOMaker.Types.VPCConfig | |
Generic VPCConfig Source # | |
Read VPCConfig Source # | |
Show VPCConfig Source # | |
NFData VPCConfig Source # | |
Defined in Amazonka.RobOMaker.Types.VPCConfig | |
Eq VPCConfig Source # | |
Hashable VPCConfig Source # | |
Defined in Amazonka.RobOMaker.Types.VPCConfig | |
type Rep VPCConfig Source # | |
Defined in Amazonka.RobOMaker.Types.VPCConfig type Rep VPCConfig = D1 ('MetaData "VPCConfig" "Amazonka.RobOMaker.Types.VPCConfig" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "VPCConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assignPublicIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))) |
Create a value of VPCConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignPublicIp:VPCConfig'
, vPCConfig_assignPublicIp
- A boolean indicating whether to assign a public IP address.
$sel:securityGroups:VPCConfig'
, vPCConfig_securityGroups
- A list of one or more security groups IDs in your VPC.
$sel:subnets:VPCConfig'
, vPCConfig_subnets
- A list of one or more subnet IDs in your VPC.
VPCConfigResponse
data VPCConfigResponse Source #
VPC configuration associated with your simulation job.
See: newVPCConfigResponse
smart constructor.
Instances
newVPCConfigResponse :: VPCConfigResponse Source #
Create a value of VPCConfigResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignPublicIp:VPCConfigResponse'
, vPCConfigResponse_assignPublicIp
- A boolean indicating if a public IP was assigned.
$sel:securityGroups:VPCConfigResponse'
, vPCConfigResponse_securityGroups
- A list of security group IDs associated with the simulation job.
$sel:subnets:VPCConfigResponse'
, vPCConfigResponse_subnets
- A list of subnet IDs associated with the simulation job.
$sel:vpcId:VPCConfigResponse'
, vPCConfigResponse_vpcId
- The VPC ID associated with your simulation job.
WorldConfig
data WorldConfig Source #
Configuration information for a world.
See: newWorldConfig
smart constructor.
Instances
newWorldConfig :: WorldConfig Source #
Create a value of WorldConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:world:WorldConfig'
, worldConfig_world
- The world generated by Simulation WorldForge.
WorldCount
data WorldCount Source #
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
and interiorCountPerFloorplan = 20
. This will
result in 20 worlds (floorplanCount
* interiorCountPerFloorplan)
.
If you set floorplanCount = 4
and interiorCountPerFloorplan = 5
,
there will be 20 worlds with 5 unique floor plans.
See: newWorldCount
smart constructor.
WorldCount' (Maybe Int) (Maybe Int) |
Instances
newWorldCount :: WorldCount Source #
Create a value of WorldCount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:floorplanCount:WorldCount'
, worldCount_floorplanCount
- The number of unique floorplans.
$sel:interiorCountPerFloorplan:WorldCount'
, worldCount_interiorCountPerFloorplan
- The number of unique interiors per floorplan.
WorldExportJobSummary
data WorldExportJobSummary Source #
Information about a world export job.
See: newWorldExportJobSummary
smart constructor.
WorldExportJobSummary' (Maybe Text) (Maybe POSIX) (Maybe OutputLocation) (Maybe WorldExportJobStatus) (Maybe (NonEmpty Text)) |
Instances
newWorldExportJobSummary :: WorldExportJobSummary Source #
Create a value of WorldExportJobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:WorldExportJobSummary'
, worldExportJobSummary_arn
- The Amazon Resource Name (ARN) of the world export job.
$sel:createdAt:WorldExportJobSummary'
, worldExportJobSummary_createdAt
- The time, in milliseconds since the epoch, when the world export job was
created.
$sel:outputLocation:WorldExportJobSummary'
, worldExportJobSummary_outputLocation
- Undocumented member.
$sel:status:WorldExportJobSummary'
, worldExportJobSummary_status
- The status of the world export job.
- Pending
- The world export job request is pending.
- Running
- The world export job is running.
- Completed
- The world export job completed.
- Failed
- The world export job failed. See
failureCode
for more information. - Canceled
- The world export job was cancelled.
- Canceling
- The world export job is being cancelled.
$sel:worlds:WorldExportJobSummary'
, worldExportJobSummary_worlds
- A list of worlds.
WorldFailure
data WorldFailure Source #
Information about a failed world.
See: newWorldFailure
smart constructor.
Instances
newWorldFailure :: WorldFailure Source #
Create a value of WorldFailure
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureCode:WorldFailure'
, worldFailure_failureCode
- The failure code of the world export job if it failed:
- InternalServiceError
- Internal service error.
- LimitExceeded
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
- The specified resource could not be found.
- RequestThrottled
- The request was throttled.
- InvalidInput
- An input parameter in the request is not valid.
$sel:failureCount:WorldFailure'
, worldFailure_failureCount
- The number of failed worlds.
$sel:sampleFailureReason:WorldFailure'
, worldFailure_sampleFailureReason
- The sample reason why the world failed. World errors are aggregated. A
sample is used as the sampleFailureReason
.
WorldGenerationJobSummary
data WorldGenerationJobSummary Source #
Information about a world generator job.
See: newWorldGenerationJobSummary
smart constructor.
WorldGenerationJobSummary' (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe WorldGenerationJobStatus) (Maybe Int) (Maybe Text) (Maybe WorldCount) |
Instances
newWorldGenerationJobSummary :: WorldGenerationJobSummary Source #
Create a value of WorldGenerationJobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:WorldGenerationJobSummary'
, worldGenerationJobSummary_arn
- The Amazon Resource Name (ARN) of the world generator job.
$sel:createdAt:WorldGenerationJobSummary'
, worldGenerationJobSummary_createdAt
- The time, in milliseconds since the epoch, when the world generator job
was created.
$sel:failedWorldCount:WorldGenerationJobSummary'
, worldGenerationJobSummary_failedWorldCount
- The number of worlds that failed.
$sel:status:WorldGenerationJobSummary'
, worldGenerationJobSummary_status
- The status of the world generator job:
- Pending
- The world generator job request is pending.
- Running
- The world generator job is running.
- Completed
- The world generator job completed.
- Failed
- The world generator job failed. See
failureCode
for more information. - PartialFailed
- Some worlds did not generate.
- Canceled
- The world generator job was cancelled.
- Canceling
- The world generator job is being cancelled.
$sel:succeededWorldCount:WorldGenerationJobSummary'
, worldGenerationJobSummary_succeededWorldCount
- The number of worlds that were generated.
$sel:template:WorldGenerationJobSummary'
, worldGenerationJobSummary_template
- The Amazon Resource Name (arn) of the world template.
$sel:worldCount:WorldGenerationJobSummary'
, worldGenerationJobSummary_worldCount
- Information about the world count.
WorldSummary
data WorldSummary Source #
Information about a world.
See: newWorldSummary
smart constructor.
Instances
newWorldSummary :: WorldSummary Source #
Create a value of WorldSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:WorldSummary'
, worldSummary_arn
- The Amazon Resource Name (ARN) of the world.
$sel:createdAt:WorldSummary'
, worldSummary_createdAt
- The time, in milliseconds since the epoch, when the world was created.
$sel:generationJob:WorldSummary'
, worldSummary_generationJob
- The Amazon Resource Name (arn) of the world generation job.
$sel:template:WorldSummary'
, worldSummary_template
- The Amazon Resource Name (arn) of the world template.