RoboMaker
public struct RoboMaker
Client object for interacting with AWS RoboMaker service.
This section provides documentation for the AWS RoboMaker API operations.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the RoboMaker client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Deletes one or more worlds in a batch operation.
Declaration
Swift
public func batchDeleteWorlds(_ input: BatchDeleteWorldsRequest) -> EventLoopFuture<BatchDeleteWorldsResponse>
-
Describes one or more simulation jobs.
Declaration
Swift
public func batchDescribeSimulationJob(_ input: BatchDescribeSimulationJobRequest) -> EventLoopFuture<BatchDescribeSimulationJobResponse>
-
Cancels the specified deployment job.
Declaration
Swift
public func cancelDeploymentJob(_ input: CancelDeploymentJobRequest) -> EventLoopFuture<CancelDeploymentJobResponse>
-
Cancels the specified simulation job.
Declaration
Swift
public func cancelSimulationJob(_ input: CancelSimulationJobRequest) -> EventLoopFuture<CancelSimulationJobResponse>
-
Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.
Declaration
Swift
public func cancelSimulationJobBatch(_ input: CancelSimulationJobBatchRequest) -> EventLoopFuture<CancelSimulationJobBatchResponse>
-
Cancels the specified export job.
Declaration
Swift
public func cancelWorldExportJob(_ input: CancelWorldExportJobRequest) -> EventLoopFuture<CancelWorldExportJobResponse>
-
Cancels the specified world generator job.
Declaration
Swift
public func cancelWorldGenerationJob(_ input: CancelWorldGenerationJobRequest) -> EventLoopFuture<CancelWorldGenerationJobResponse>
-
Deploys a specific version of a robot application to robots in a fleet. The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version. After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
Declaration
Swift
public func createDeploymentJob(_ input: CreateDeploymentJobRequest) -> EventLoopFuture<CreateDeploymentJobResponse>
-
Creates a fleet, a logical group of robots running the same robot application.
Declaration
Swift
public func createFleet(_ input: CreateFleetRequest) -> EventLoopFuture<CreateFleetResponse>
-
Creates a robot.
Declaration
Swift
public func createRobot(_ input: CreateRobotRequest) -> EventLoopFuture<CreateRobotResponse>
-
Creates a robot application.
Declaration
Swift
public func createRobotApplication(_ input: CreateRobotApplicationRequest) -> EventLoopFuture<CreateRobotApplicationResponse>
-
Creates a version of a robot application.
Declaration
Swift
public func createRobotApplicationVersion(_ input: CreateRobotApplicationVersionRequest) -> EventLoopFuture<CreateRobotApplicationVersionResponse>
-
Creates a simulation application.
Declaration
Swift
public func createSimulationApplication(_ input: CreateSimulationApplicationRequest) -> EventLoopFuture<CreateSimulationApplicationResponse>
-
Creates a simulation application with a specific revision id.
Declaration
Swift
public func createSimulationApplicationVersion(_ input: CreateSimulationApplicationVersionRequest) -> EventLoopFuture<CreateSimulationApplicationVersionResponse>
-
Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
Declaration
Swift
public func createSimulationJob(_ input: CreateSimulationJobRequest) -> EventLoopFuture<CreateSimulationJobResponse>
-
Creates a world export job.
Declaration
Swift
public func createWorldExportJob(_ input: CreateWorldExportJobRequest) -> EventLoopFuture<CreateWorldExportJobResponse>
-
Creates worlds using the specified template.
Declaration
Swift
public func createWorldGenerationJob(_ input: CreateWorldGenerationJobRequest) -> EventLoopFuture<CreateWorldGenerationJobResponse>
-
Creates a world template.
Declaration
Swift
public func createWorldTemplate(_ input: CreateWorldTemplateRequest) -> EventLoopFuture<CreateWorldTemplateResponse>
-
Deletes a fleet.
Declaration
Swift
public func deleteFleet(_ input: DeleteFleetRequest) -> EventLoopFuture<DeleteFleetResponse>
-
Deletes a robot.
Declaration
Swift
public func deleteRobot(_ input: DeleteRobotRequest) -> EventLoopFuture<DeleteRobotResponse>
-
Deletes a robot application.
Declaration
Swift
public func deleteRobotApplication(_ input: DeleteRobotApplicationRequest) -> EventLoopFuture<DeleteRobotApplicationResponse>
-
Deletes a simulation application.
Declaration
Swift
public func deleteSimulationApplication(_ input: DeleteSimulationApplicationRequest) -> EventLoopFuture<DeleteSimulationApplicationResponse>
-
Deletes a world template.
Declaration
Swift
public func deleteWorldTemplate(_ input: DeleteWorldTemplateRequest) -> EventLoopFuture<DeleteWorldTemplateResponse>
-
Deregisters a robot.
Declaration
Swift
public func deregisterRobot(_ input: DeregisterRobotRequest) -> EventLoopFuture<DeregisterRobotResponse>
-
Describes a deployment job.
Declaration
Swift
public func describeDeploymentJob(_ input: DescribeDeploymentJobRequest) -> EventLoopFuture<DescribeDeploymentJobResponse>
-
Describes a fleet.
Declaration
Swift
public func describeFleet(_ input: DescribeFleetRequest) -> EventLoopFuture<DescribeFleetResponse>
-
Describes a robot.
Declaration
Swift
public func describeRobot(_ input: DescribeRobotRequest) -> EventLoopFuture<DescribeRobotResponse>
-
Describes a robot application.
Declaration
Swift
public func describeRobotApplication(_ input: DescribeRobotApplicationRequest) -> EventLoopFuture<DescribeRobotApplicationResponse>
-
Describes a simulation application.
Declaration
Swift
public func describeSimulationApplication(_ input: DescribeSimulationApplicationRequest) -> EventLoopFuture<DescribeSimulationApplicationResponse>
-
Describes a simulation job.
Declaration
Swift
public func describeSimulationJob(_ input: DescribeSimulationJobRequest) -> EventLoopFuture<DescribeSimulationJobResponse>
-
Describes a simulation job batch.
Declaration
Swift
public func describeSimulationJobBatch(_ input: DescribeSimulationJobBatchRequest) -> EventLoopFuture<DescribeSimulationJobBatchResponse>
-
Describes a world.
Declaration
Swift
public func describeWorld(_ input: DescribeWorldRequest) -> EventLoopFuture<DescribeWorldResponse>
-
Describes a world export job.
Declaration
Swift
public func describeWorldExportJob(_ input: DescribeWorldExportJobRequest) -> EventLoopFuture<DescribeWorldExportJobResponse>
-
Describes a world generation job.
Declaration
Swift
public func describeWorldGenerationJob(_ input: DescribeWorldGenerationJobRequest) -> EventLoopFuture<DescribeWorldGenerationJobResponse>
-
Describes a world template.
Declaration
Swift
public func describeWorldTemplate(_ input: DescribeWorldTemplateRequest) -> EventLoopFuture<DescribeWorldTemplateResponse>
-
Gets the world template body.
Declaration
Swift
public func getWorldTemplateBody(_ input: GetWorldTemplateBodyRequest) -> EventLoopFuture<GetWorldTemplateBodyResponse>
-
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
Declaration
Swift
public func listDeploymentJobs(_ input: ListDeploymentJobsRequest) -> EventLoopFuture<ListDeploymentJobsResponse>
-
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
Declaration
Swift
public func listFleets(_ input: ListFleetsRequest) -> EventLoopFuture<ListFleetsResponse>
-
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
Declaration
Swift
public func listRobotApplications(_ input: ListRobotApplicationsRequest) -> EventLoopFuture<ListRobotApplicationsResponse>
-
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
Declaration
Swift
public func listRobots(_ input: ListRobotsRequest) -> EventLoopFuture<ListRobotsResponse>
-
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
Declaration
Swift
public func listSimulationApplications(_ input: ListSimulationApplicationsRequest) -> EventLoopFuture<ListSimulationApplicationsResponse>
-
Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
Declaration
Swift
public func listSimulationJobBatches(_ input: ListSimulationJobBatchesRequest) -> EventLoopFuture<ListSimulationJobBatchesResponse>
-
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
Declaration
Swift
public func listSimulationJobs(_ input: ListSimulationJobsRequest) -> EventLoopFuture<ListSimulationJobsResponse>
-
Lists all tags on a AWS RoboMaker resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>
-
Lists world export jobs.
Declaration
Swift
public func listWorldExportJobs(_ input: ListWorldExportJobsRequest) -> EventLoopFuture<ListWorldExportJobsResponse>
-
Lists world generator jobs.
Declaration
Swift
public func listWorldGenerationJobs(_ input: ListWorldGenerationJobsRequest) -> EventLoopFuture<ListWorldGenerationJobsResponse>
-
Lists world templates.
Declaration
Swift
public func listWorldTemplates(_ input: ListWorldTemplatesRequest) -> EventLoopFuture<ListWorldTemplatesResponse>
-
Lists worlds.
Declaration
Swift
public func listWorlds(_ input: ListWorldsRequest) -> EventLoopFuture<ListWorldsResponse>
-
Registers a robot with a fleet.
Declaration
Swift
public func registerRobot(_ input: RegisterRobotRequest) -> EventLoopFuture<RegisterRobotResponse>
-
Restarts a running simulation job.
Declaration
Swift
public func restartSimulationJob(_ input: RestartSimulationJobRequest) -> EventLoopFuture<RestartSimulationJobResponse>
-
Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.
Declaration
Swift
public func startSimulationJobBatch(_ input: StartSimulationJobBatchRequest) -> EventLoopFuture<StartSimulationJobBatchResponse>
-
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
Declaration
Swift
public func syncDeploymentJob(_ input: SyncDeploymentJobRequest) -> EventLoopFuture<SyncDeploymentJobResponse>
-
Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>
-
Removes the specified tags from the specified AWS RoboMaker resource. To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource .
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>
-
Updates a robot application.
Declaration
Swift
public func updateRobotApplication(_ input: UpdateRobotApplicationRequest) -> EventLoopFuture<UpdateRobotApplicationResponse>
-
Updates a simulation application.
Declaration
Swift
public func updateSimulationApplication(_ input: UpdateSimulationApplicationRequest) -> EventLoopFuture<UpdateSimulationApplicationResponse>
-
Updates a world template.
Declaration
Swift
public func updateWorldTemplate(_ input: UpdateWorldTemplateRequest) -> EventLoopFuture<UpdateWorldTemplateResponse>
-
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
Declaration
Swift
public func listDeploymentJobsPaginator(_ input: ListDeploymentJobsRequest, onPage: @escaping (ListDeploymentJobsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
Declaration
Swift
public func listFleetsPaginator(_ input: ListFleetsRequest, onPage: @escaping (ListFleetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
Declaration
Swift
public func listRobotApplicationsPaginator(_ input: ListRobotApplicationsRequest, onPage: @escaping (ListRobotApplicationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
Declaration
Swift
public func listRobotsPaginator(_ input: ListRobotsRequest, onPage: @escaping (ListRobotsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
Declaration
Swift
public func listSimulationApplicationsPaginator(_ input: ListSimulationApplicationsRequest, onPage: @escaping (ListSimulationApplicationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
Declaration
Swift
public func listSimulationJobBatchesPaginator(_ input: ListSimulationJobBatchesRequest, onPage: @escaping (ListSimulationJobBatchesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
Declaration
Swift
public func listSimulationJobsPaginator(_ input: ListSimulationJobsRequest, onPage: @escaping (ListSimulationJobsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists world export jobs.
Declaration
Swift
public func listWorldExportJobsPaginator(_ input: ListWorldExportJobsRequest, onPage: @escaping (ListWorldExportJobsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists world generator jobs.
Declaration
Swift
public func listWorldGenerationJobsPaginator(_ input: ListWorldGenerationJobsRequest, onPage: @escaping (ListWorldGenerationJobsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists world templates.
Declaration
Swift
public func listWorldTemplatesPaginator(_ input: ListWorldTemplatesRequest, onPage: @escaping (ListWorldTemplatesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists worlds.
Declaration
Swift
public func listWorldsPaginator(_ input: ListWorldsRequest, onPage: @escaping (ListWorldsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListDeploymentJobsRequest : AWSShape
extension RoboMaker.ListDeploymentJobsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListFleetsRequest : AWSShape
extension RoboMaker.ListFleetsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListRobotApplicationsRequest : AWSShape
extension RoboMaker.ListRobotApplicationsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListRobotsRequest : AWSShape
extension RoboMaker.ListRobotsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListSimulationApplicationsRequest : AWSShape
extension RoboMaker.ListSimulationApplicationsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListSimulationJobBatchesRequest : AWSShape
extension RoboMaker.ListSimulationJobBatchesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListSimulationJobsRequest : AWSShape
extension RoboMaker.ListSimulationJobsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListWorldExportJobsRequest : AWSShape
extension RoboMaker.ListWorldExportJobsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListWorldGenerationJobsRequest : AWSShape
extension RoboMaker.ListWorldGenerationJobsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListWorldTemplatesRequest : AWSShape
extension RoboMaker.ListWorldTemplatesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListWorldsRequest : AWSShape
extension RoboMaker.ListWorldsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum Architecture : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DeploymentJobErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DeploymentStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum FailureBehavior : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum RenderingEngineType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum RobotDeploymentStep : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum RobotSoftwareSuiteType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum RobotSoftwareSuiteVersionType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum RobotStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SimulationJobBatchErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SimulationJobBatchStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SimulationJobErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SimulationJobStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SimulationSoftwareSuiteType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum WorldExportJobErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum WorldExportJobStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum WorldGenerationJobErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum WorldGenerationJobStatus : String, CustomStringConvertible, Codable