NAME

Paws::Robomaker - Perl Interface to AWS AWS RoboMaker

SYNOPSIS

use Paws;

my $obj = Paws->service('Robomaker');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

This section provides documentation for the AWS RoboMaker API operations.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29

METHODS

BatchDeleteWorlds

Worlds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Robomaker::BatchDeleteWorlds

Returns: a Paws::Robomaker::BatchDeleteWorldsResponse instance

Deletes one or more worlds in a batch operation.

BatchDescribeSimulationJob

Jobs => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Robomaker::BatchDescribeSimulationJob

Returns: a Paws::Robomaker::BatchDescribeSimulationJobResponse instance

Describes one or more simulation jobs.

CancelDeploymentJob

Job => Str

Each argument is described in detail in: Paws::Robomaker::CancelDeploymentJob

Returns: a Paws::Robomaker::CancelDeploymentJobResponse instance

Cancels the specified deployment job.

CancelSimulationJob

Job => Str

Each argument is described in detail in: Paws::Robomaker::CancelSimulationJob

Returns: a Paws::Robomaker::CancelSimulationJobResponse instance

Cancels the specified simulation job.

CancelSimulationJobBatch

Batch => Str

Each argument is described in detail in: Paws::Robomaker::CancelSimulationJobBatch

Returns: a Paws::Robomaker::CancelSimulationJobBatchResponse instance

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.

CancelWorldExportJob

Job => Str

Each argument is described in detail in: Paws::Robomaker::CancelWorldExportJob

Returns: a Paws::Robomaker::CancelWorldExportJobResponse instance

Cancels the specified export job.

CancelWorldGenerationJob

Job => Str

Each argument is described in detail in: Paws::Robomaker::CancelWorldGenerationJob

Returns: a Paws::Robomaker::CancelWorldGenerationJobResponse instance

Cancels the specified world generator job.

CreateDeploymentJob

ClientRequestToken => Str
DeploymentApplicationConfigs => ArrayRef[Paws::Robomaker::DeploymentApplicationConfig]
Fleet => Str
[DeploymentConfig => Paws::Robomaker::DeploymentConfig]
[Tags => Paws::Robomaker::TagMap]

Each argument is described in detail in: Paws::Robomaker::CreateDeploymentJob

Returns: a Paws::Robomaker::CreateDeploymentJobResponse instance

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 (https://docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html).

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

CreateFleet

Name => Str
[Tags => Paws::Robomaker::TagMap]

Each argument is described in detail in: Paws::Robomaker::CreateFleet

Returns: a Paws::Robomaker::CreateFleetResponse instance

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

CreateRobot

Architecture => Str
GreengrassGroupId => Str
Name => Str
[Tags => Paws::Robomaker::TagMap]

Each argument is described in detail in: Paws::Robomaker::CreateRobot

Returns: a Paws::Robomaker::CreateRobotResponse instance

Creates a robot.

CreateRobotApplication

Name => Str
RobotSoftwareSuite => Paws::Robomaker::RobotSoftwareSuite
Sources => ArrayRef[Paws::Robomaker::SourceConfig]
[Tags => Paws::Robomaker::TagMap]

Each argument is described in detail in: Paws::Robomaker::CreateRobotApplication

Returns: a Paws::Robomaker::CreateRobotApplicationResponse instance

Creates a robot application.

CreateRobotApplicationVersion

Application => Str
[CurrentRevisionId => Str]

Each argument is described in detail in: Paws::Robomaker::CreateRobotApplicationVersion

Returns: a Paws::Robomaker::CreateRobotApplicationVersionResponse instance

Creates a version of a robot application.

CreateSimulationApplication

Name => Str
RobotSoftwareSuite => Paws::Robomaker::RobotSoftwareSuite
SimulationSoftwareSuite => Paws::Robomaker::SimulationSoftwareSuite
Sources => ArrayRef[Paws::Robomaker::SourceConfig]
[RenderingEngine => Paws::Robomaker::RenderingEngine]
[Tags => Paws::Robomaker::TagMap]

Each argument is described in detail in: Paws::Robomaker::CreateSimulationApplication

Returns: a Paws::Robomaker::CreateSimulationApplicationResponse instance

Creates a simulation application.

CreateSimulationApplicationVersion

Application => Str
[CurrentRevisionId => Str]

Each argument is described in detail in: Paws::Robomaker::CreateSimulationApplicationVersion

Returns: a Paws::Robomaker::CreateSimulationApplicationVersionResponse instance

Creates a simulation application with a specific revision id.

CreateSimulationJob

IamRole => Str
MaxJobDurationInSeconds => Int
[ClientRequestToken => Str]
[Compute => Paws::Robomaker::Compute]
[DataSources => ArrayRef[Paws::Robomaker::DataSourceConfig]]
[FailureBehavior => Str]
[LoggingConfig => Paws::Robomaker::LoggingConfig]
[OutputLocation => Paws::Robomaker::OutputLocation]
[RobotApplications => ArrayRef[Paws::Robomaker::RobotApplicationConfig]]
[SimulationApplications => ArrayRef[Paws::Robomaker::SimulationApplicationConfig]]
[Tags => Paws::Robomaker::TagMap]
[VpcConfig => Paws::Robomaker::VPCConfig]

Each argument is described in detail in: Paws::Robomaker::CreateSimulationJob

Returns: a Paws::Robomaker::CreateSimulationJobResponse instance

Creates a simulation job.

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

CreateWorldExportJob

IamRole => Str
OutputLocation => Paws::Robomaker::OutputLocation
Worlds => ArrayRef[Str|Undef]
[ClientRequestToken => Str]
[Tags => Paws::Robomaker::TagMap]

Each argument is described in detail in: Paws::Robomaker::CreateWorldExportJob

Returns: a Paws::Robomaker::CreateWorldExportJobResponse instance

Creates a world export job.

CreateWorldGenerationJob

Template => Str
WorldCount => Paws::Robomaker::WorldCount
[ClientRequestToken => Str]
[Tags => Paws::Robomaker::TagMap]
[WorldTags => Paws::Robomaker::TagMap]

Each argument is described in detail in: Paws::Robomaker::CreateWorldGenerationJob

Returns: a Paws::Robomaker::CreateWorldGenerationJobResponse instance

Creates worlds using the specified template.

CreateWorldTemplate

[ClientRequestToken => Str]
[Name => Str]
[Tags => Paws::Robomaker::TagMap]
[TemplateBody => Str]
[TemplateLocation => Paws::Robomaker::TemplateLocation]

Each argument is described in detail in: Paws::Robomaker::CreateWorldTemplate

Returns: a Paws::Robomaker::CreateWorldTemplateResponse instance

Creates a world template.

DeleteFleet

Fleet => Str

Each argument is described in detail in: Paws::Robomaker::DeleteFleet

Returns: a Paws::Robomaker::DeleteFleetResponse instance

Deletes a fleet.

DeleteRobot

Robot => Str

Each argument is described in detail in: Paws::Robomaker::DeleteRobot

Returns: a Paws::Robomaker::DeleteRobotResponse instance

Deletes a robot.

DeleteRobotApplication

Application => Str
[ApplicationVersion => Str]

Each argument is described in detail in: Paws::Robomaker::DeleteRobotApplication

Returns: a Paws::Robomaker::DeleteRobotApplicationResponse instance

Deletes a robot application.

DeleteSimulationApplication

Application => Str
[ApplicationVersion => Str]

Each argument is described in detail in: Paws::Robomaker::DeleteSimulationApplication

Returns: a Paws::Robomaker::DeleteSimulationApplicationResponse instance

Deletes a simulation application.

DeleteWorldTemplate

Template => Str

Each argument is described in detail in: Paws::Robomaker::DeleteWorldTemplate

Returns: a Paws::Robomaker::DeleteWorldTemplateResponse instance

Deletes a world template.

DeregisterRobot

Fleet => Str
Robot => Str

Each argument is described in detail in: Paws::Robomaker::DeregisterRobot

Returns: a Paws::Robomaker::DeregisterRobotResponse instance

Deregisters a robot.

DescribeDeploymentJob

Job => Str

Each argument is described in detail in: Paws::Robomaker::DescribeDeploymentJob

Returns: a Paws::Robomaker::DescribeDeploymentJobResponse instance

Describes a deployment job.

DescribeFleet

Fleet => Str

Each argument is described in detail in: Paws::Robomaker::DescribeFleet

Returns: a Paws::Robomaker::DescribeFleetResponse instance

Describes a fleet.

DescribeRobot

Robot => Str

Each argument is described in detail in: Paws::Robomaker::DescribeRobot

Returns: a Paws::Robomaker::DescribeRobotResponse instance

Describes a robot.

DescribeRobotApplication

Application => Str
[ApplicationVersion => Str]

Each argument is described in detail in: Paws::Robomaker::DescribeRobotApplication

Returns: a Paws::Robomaker::DescribeRobotApplicationResponse instance

Describes a robot application.

DescribeSimulationApplication

Application => Str
[ApplicationVersion => Str]

Each argument is described in detail in: Paws::Robomaker::DescribeSimulationApplication

Returns: a Paws::Robomaker::DescribeSimulationApplicationResponse instance

Describes a simulation application.

DescribeSimulationJob

Job => Str

Each argument is described in detail in: Paws::Robomaker::DescribeSimulationJob

Returns: a Paws::Robomaker::DescribeSimulationJobResponse instance

Describes a simulation job.

DescribeSimulationJobBatch

Batch => Str

Each argument is described in detail in: Paws::Robomaker::DescribeSimulationJobBatch

Returns: a Paws::Robomaker::DescribeSimulationJobBatchResponse instance

Describes a simulation job batch.

DescribeWorld

World => Str

Each argument is described in detail in: Paws::Robomaker::DescribeWorld

Returns: a Paws::Robomaker::DescribeWorldResponse instance

Describes a world.

DescribeWorldExportJob

Job => Str

Each argument is described in detail in: Paws::Robomaker::DescribeWorldExportJob

Returns: a Paws::Robomaker::DescribeWorldExportJobResponse instance

Describes a world export job.

DescribeWorldGenerationJob

Job => Str

Each argument is described in detail in: Paws::Robomaker::DescribeWorldGenerationJob

Returns: a Paws::Robomaker::DescribeWorldGenerationJobResponse instance

Describes a world generation job.

DescribeWorldTemplate

Template => Str

Each argument is described in detail in: Paws::Robomaker::DescribeWorldTemplate

Returns: a Paws::Robomaker::DescribeWorldTemplateResponse instance

Describes a world template.

GetWorldTemplateBody

[GenerationJob => Str]
[Template => Str]

Each argument is described in detail in: Paws::Robomaker::GetWorldTemplateBody

Returns: a Paws::Robomaker::GetWorldTemplateBodyResponse instance

Gets the world template body.

ListDeploymentJobs

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Robomaker::ListDeploymentJobs

Returns: a Paws::Robomaker::ListDeploymentJobsResponse instance

Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

ListFleets

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Robomaker::ListFleets

Returns: a Paws::Robomaker::ListFleetsResponse instance

Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

ListRobotApplications

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]
[VersionQualifier => Str]

Each argument is described in detail in: Paws::Robomaker::ListRobotApplications

Returns: a Paws::Robomaker::ListRobotApplicationsResponse instance

Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.

ListRobots

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Robomaker::ListRobots

Returns: a Paws::Robomaker::ListRobotsResponse instance

Returns a list of robots. You can optionally provide filters to retrieve specific robots.

ListSimulationApplications

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]
[VersionQualifier => Str]

Each argument is described in detail in: Paws::Robomaker::ListSimulationApplications

Returns: a Paws::Robomaker::ListSimulationApplicationsResponse instance

Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.

ListSimulationJobBatches

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Robomaker::ListSimulationJobBatches

Returns: a Paws::Robomaker::ListSimulationJobBatchesResponse instance

Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.

ListSimulationJobs

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Robomaker::ListSimulationJobs

Returns: a Paws::Robomaker::ListSimulationJobsResponse instance

Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::Robomaker::ListTagsForResource

Returns: a Paws::Robomaker::ListTagsForResourceResponse instance

Lists all tags on a AWS RoboMaker resource.

ListWorldExportJobs

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Robomaker::ListWorldExportJobs

Returns: a Paws::Robomaker::ListWorldExportJobsResponse instance

Lists world export jobs.

ListWorldGenerationJobs

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Robomaker::ListWorldGenerationJobs

Returns: a Paws::Robomaker::ListWorldGenerationJobsResponse instance

Lists world generator jobs.

ListWorlds

[Filters => ArrayRef[Paws::Robomaker::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Robomaker::ListWorlds

Returns: a Paws::Robomaker::ListWorldsResponse instance

Lists worlds.

ListWorldTemplates

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Robomaker::ListWorldTemplates

Returns: a Paws::Robomaker::ListWorldTemplatesResponse instance

Lists world templates.

RegisterRobot

Fleet => Str
Robot => Str

Each argument is described in detail in: Paws::Robomaker::RegisterRobot

Returns: a Paws::Robomaker::RegisterRobotResponse instance

Registers a robot with a fleet.

RestartSimulationJob

Job => Str

Each argument is described in detail in: Paws::Robomaker::RestartSimulationJob

Returns: a Paws::Robomaker::RestartSimulationJobResponse instance

Restarts a running simulation job.

StartSimulationJobBatch

CreateSimulationJobRequests => ArrayRef[Paws::Robomaker::SimulationJobRequest]
[BatchPolicy => Paws::Robomaker::BatchPolicy]
[ClientRequestToken => Str]
[Tags => Paws::Robomaker::TagMap]

Each argument is described in detail in: Paws::Robomaker::StartSimulationJobBatch

Returns: a Paws::Robomaker::StartSimulationJobBatchResponse instance

Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.

SyncDeploymentJob

ClientRequestToken => Str
Fleet => Str

Each argument is described in detail in: Paws::Robomaker::SyncDeploymentJob

Returns: a Paws::Robomaker::SyncDeploymentJobResponse instance

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

TagResource

ResourceArn => Str
Tags => Paws::Robomaker::TagMap

Each argument is described in detail in: Paws::Robomaker::TagResource

Returns: a Paws::Robomaker::TagResourceResponse instance

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 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the AWS Billing and Cost Management User Guide.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Robomaker::UntagResource

Returns: a Paws::Robomaker::UntagResourceResponse instance

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 (https://docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html).

UpdateRobotApplication

Application => Str
RobotSoftwareSuite => Paws::Robomaker::RobotSoftwareSuite
Sources => ArrayRef[Paws::Robomaker::SourceConfig]
[CurrentRevisionId => Str]

Each argument is described in detail in: Paws::Robomaker::UpdateRobotApplication

Returns: a Paws::Robomaker::UpdateRobotApplicationResponse instance

Updates a robot application.

UpdateSimulationApplication

Application => Str
RobotSoftwareSuite => Paws::Robomaker::RobotSoftwareSuite
SimulationSoftwareSuite => Paws::Robomaker::SimulationSoftwareSuite
Sources => ArrayRef[Paws::Robomaker::SourceConfig]
[CurrentRevisionId => Str]
[RenderingEngine => Paws::Robomaker::RenderingEngine]

Each argument is described in detail in: Paws::Robomaker::UpdateSimulationApplication

Returns: a Paws::Robomaker::UpdateSimulationApplicationResponse instance

Updates a simulation application.

UpdateWorldTemplate

Template => Str
[Name => Str]
[TemplateBody => Str]
[TemplateLocation => Paws::Robomaker::TemplateLocation]

Each argument is described in detail in: Paws::Robomaker::UpdateWorldTemplate

Returns: a Paws::Robomaker::UpdateWorldTemplateResponse instance

Updates a world template.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results