AWS.RoboMaker (aws-elixir v0.8.0) View Source

This section provides documentation for the AWS RoboMaker API operations.

Link to this section Summary

Functions

Deletes one or more worlds in a batch operation.

Describes one or more simulation jobs.

Cancels the specified deployment job.

Cancels the specified simulation job.

Cancels the specified export job.

Cancels the specified world generator job.

Deploys a specific version of a robot application to robots in a fleet.

Creates a fleet, a logical group of robots running the same robot application.

Creates a version of a robot application.

Creates a simulation application with a specific revision id.

Creates worlds using the specified template.

Returns a list of deployment jobs for a fleet.

Returns a list of fleets.

Returns a list of robot application.

Returns a list of robots.

Returns a list of simulation applications.

Returns a list simulation job batches.

Returns a list of simulation jobs.

Lists all tags on a AWS RoboMaker resource.

Registers a robot with a fleet.

Restarts a running simulation job.

Syncrhonizes robots in a fleet to the latest deployment.

Adds or edits tags for a AWS RoboMaker resource.

Removes the specified tags from the specified AWS RoboMaker resource.

Link to this section Functions

Link to this function

batch_delete_worlds(client, input, options \\ [])

View Source

Deletes one or more worlds in a batch operation.

Link to this function

batch_describe_simulation_job(client, input, options \\ [])

View Source

Describes one or more simulation jobs.

Link to this function

cancel_deployment_job(client, input, options \\ [])

View Source

Cancels the specified deployment job.

Link to this function

cancel_simulation_job(client, input, options \\ [])

View Source

Cancels the specified simulation job.

Link to this function

cancel_simulation_job_batch(client, input, options \\ [])

View Source

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.

Link to this function

cancel_world_export_job(client, input, options \\ [])

View Source

Cancels the specified export job.

Link to this function

cancel_world_generation_job(client, input, options \\ [])

View Source

Cancels the specified world generator job.

Link to this function

create_deployment_job(client, input, options \\ [])

View Source

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.

Link to this function

create_fleet(client, input, options \\ [])

View Source

Creates a fleet, a logical group of robots running the same robot application.

Link to this function

create_robot(client, input, options \\ [])

View Source

Creates a robot.

Link to this function

create_robot_application(client, input, options \\ [])

View Source

Creates a robot application.

Link to this function

create_robot_application_version(client, input, options \\ [])

View Source

Creates a version of a robot application.

Link to this function

create_simulation_application(client, input, options \\ [])

View Source

Creates a simulation application.

Link to this function

create_simulation_application_version(client, input, options \\ [])

View Source

Creates a simulation application with a specific revision id.

Link to this function

create_simulation_job(client, input, options \\ [])

View Source

Creates a simulation job.

After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.

Link to this function

create_world_export_job(client, input, options \\ [])

View Source

Creates a world export job.

Link to this function

create_world_generation_job(client, input, options \\ [])

View Source

Creates worlds using the specified template.

Link to this function

create_world_template(client, input, options \\ [])

View Source

Creates a world template.

Link to this function

delete_fleet(client, input, options \\ [])

View Source

Deletes a fleet.

Link to this function

delete_robot(client, input, options \\ [])

View Source

Deletes a robot.

Link to this function

delete_robot_application(client, input, options \\ [])

View Source

Deletes a robot application.

Link to this function

delete_simulation_application(client, input, options \\ [])

View Source

Deletes a simulation application.

Link to this function

delete_world_template(client, input, options \\ [])

View Source

Deletes a world template.

Link to this function

deregister_robot(client, input, options \\ [])

View Source

Deregisters a robot.

Link to this function

describe_deployment_job(client, input, options \\ [])

View Source

Describes a deployment job.

Link to this function

describe_fleet(client, input, options \\ [])

View Source

Describes a fleet.

Link to this function

describe_robot(client, input, options \\ [])

View Source

Describes a robot.

Link to this function

describe_robot_application(client, input, options \\ [])

View Source

Describes a robot application.

Link to this function

describe_simulation_application(client, input, options \\ [])

View Source

Describes a simulation application.

Link to this function

describe_simulation_job(client, input, options \\ [])

View Source

Describes a simulation job.

Link to this function

describe_simulation_job_batch(client, input, options \\ [])

View Source

Describes a simulation job batch.

Link to this function

describe_world(client, input, options \\ [])

View Source

Describes a world.

Link to this function

describe_world_export_job(client, input, options \\ [])

View Source

Describes a world export job.

Link to this function

describe_world_generation_job(client, input, options \\ [])

View Source

Describes a world generation job.

Link to this function

describe_world_template(client, input, options \\ [])

View Source

Describes a world template.

Link to this function

get_world_template_body(client, input, options \\ [])

View Source

Gets the world template body.

Link to this function

list_deployment_jobs(client, input, options \\ [])

View Source

Returns a list of deployment jobs for a fleet.

You can optionally provide filters to retrieve specific deployment jobs.

Link to this function

list_fleets(client, input, options \\ [])

View Source

Returns a list of fleets.

You can optionally provide filters to retrieve specific fleets.

Link to this function

list_robot_applications(client, input, options \\ [])

View Source

Returns a list of robot application.

You can optionally provide filters to retrieve specific robot applications.

Link to this function

list_robots(client, input, options \\ [])

View Source

Returns a list of robots.

You can optionally provide filters to retrieve specific robots.

Link to this function

list_simulation_applications(client, input, options \\ [])

View Source

Returns a list of simulation applications.

You can optionally provide filters to retrieve specific simulation applications.

Link to this function

list_simulation_job_batches(client, input, options \\ [])

View Source

Returns a list simulation job batches.

You can optionally provide filters to retrieve specific simulation batch jobs.

Link to this function

list_simulation_jobs(client, input, options \\ [])

View Source

Returns a list of simulation jobs.

You can optionally provide filters to retrieve specific simulation jobs.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists all tags on a AWS RoboMaker resource.

Link to this function

list_world_export_jobs(client, input, options \\ [])

View Source

Lists world export jobs.

Link to this function

list_world_generation_jobs(client, input, options \\ [])

View Source

Lists world generator jobs.

Link to this function

list_world_templates(client, input, options \\ [])

View Source

Lists world templates.

Link to this function

list_worlds(client, input, options \\ [])

View Source

Lists worlds.

Link to this function

register_robot(client, input, options \\ [])

View Source

Registers a robot with a fleet.

Link to this function

restart_simulation_job(client, input, options \\ [])

View Source

Restarts a running simulation job.

Link to this function

start_simulation_job_batch(client, input, options \\ [])

View Source

Starts a new simulation job batch.

The batch is defined using one or more SimulationJobRequest objects.

Link to this function

sync_deployment_job(client, input, options \\ [])

View Source

Syncrhonizes robots in a fleet to the latest deployment.

This is helpful if robots were added after a deployment.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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 .

Link to this function

update_robot_application(client, input, options \\ [])

View Source

Updates a robot application.

Link to this function

update_simulation_application(client, input, options \\ [])

View Source

Updates a simulation application.

Link to this function

update_world_template(client, input, options \\ [])

View Source

Updates a world template.