robomaker

package module
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 10, 2021 License: Apache-2.0 Imports: 29 Imported by: 5

Documentation

Overview

Package robomaker provides the API client, operations, and parameter types for AWS RoboMaker.

This section provides documentation for the AWS RoboMaker API operations.

Index

Constants

View Source
const ServiceAPIVersion = "2018-06-29"
View Source
const ServiceID = "RoboMaker"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type BatchDeleteWorldsInput added in v0.29.0

type BatchDeleteWorldsInput struct {

	// A list of Amazon Resource Names (arns) that correspond to worlds to delete.
	//
	// This member is required.
	Worlds []string
}

type BatchDeleteWorldsOutput added in v0.29.0

type BatchDeleteWorldsOutput struct {

	// A list of unprocessed worlds associated with the call. These worlds were not
	// deleted.
	UnprocessedWorlds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchDescribeSimulationJobInput

type BatchDescribeSimulationJobInput struct {

	// A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
	//
	// This member is required.
	Jobs []string
}

type BatchDescribeSimulationJobOutput

type BatchDescribeSimulationJobOutput struct {

	// A list of simulation jobs.
	Jobs []types.SimulationJob

	// A list of unprocessed simulation job Amazon Resource Names (ARNs).
	UnprocessedJobs []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelDeploymentJobInput

type CancelDeploymentJobInput struct {

	// The deployment job ARN to cancel.
	//
	// This member is required.
	Job *string
}

type CancelDeploymentJobOutput

type CancelDeploymentJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelSimulationJobBatchInput

type CancelSimulationJobBatchInput struct {

	// The id of the batch to cancel.
	//
	// This member is required.
	Batch *string
}

type CancelSimulationJobBatchOutput

type CancelSimulationJobBatchOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelSimulationJobInput

type CancelSimulationJobInput struct {

	// The simulation job ARN to cancel.
	//
	// This member is required.
	Job *string
}

type CancelSimulationJobOutput

type CancelSimulationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelWorldExportJobInput added in v0.29.0

type CancelWorldExportJobInput struct {

	// The Amazon Resource Name (arn) of the world export job to cancel.
	//
	// This member is required.
	Job *string
}

type CancelWorldExportJobOutput added in v0.29.0

type CancelWorldExportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelWorldGenerationJobInput added in v0.29.0

type CancelWorldGenerationJobInput struct {

	// The Amazon Resource Name (arn) of the world generator job to cancel.
	//
	// This member is required.
	Job *string
}

type CancelWorldGenerationJobOutput added in v0.29.0

type CancelWorldGenerationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS RoboMaker.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchDeleteWorlds added in v0.29.0

func (c *Client) BatchDeleteWorlds(ctx context.Context, params *BatchDeleteWorldsInput, optFns ...func(*Options)) (*BatchDeleteWorldsOutput, error)

Deletes one or more worlds in a batch operation.

func (*Client) BatchDescribeSimulationJob

func (c *Client) BatchDescribeSimulationJob(ctx context.Context, params *BatchDescribeSimulationJobInput, optFns ...func(*Options)) (*BatchDescribeSimulationJobOutput, error)

Describes one or more simulation jobs.

func (*Client) CancelDeploymentJob

func (c *Client) CancelDeploymentJob(ctx context.Context, params *CancelDeploymentJobInput, optFns ...func(*Options)) (*CancelDeploymentJobOutput, error)

Cancels the specified deployment job.

func (*Client) CancelSimulationJob

func (c *Client) CancelSimulationJob(ctx context.Context, params *CancelSimulationJobInput, optFns ...func(*Options)) (*CancelSimulationJobOutput, error)

Cancels the specified simulation job.

func (*Client) CancelSimulationJobBatch

func (c *Client) CancelSimulationJobBatch(ctx context.Context, params *CancelSimulationJobBatchInput, optFns ...func(*Options)) (*CancelSimulationJobBatchOutput, error)

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.

func (*Client) CancelWorldExportJob added in v0.29.0

func (c *Client) CancelWorldExportJob(ctx context.Context, params *CancelWorldExportJobInput, optFns ...func(*Options)) (*CancelWorldExportJobOutput, error)

Cancels the specified export job.

func (*Client) CancelWorldGenerationJob added in v0.29.0

func (c *Client) CancelWorldGenerationJob(ctx context.Context, params *CancelWorldGenerationJobInput, optFns ...func(*Options)) (*CancelWorldGenerationJobOutput, error)

Cancels the specified world generator job.

func (*Client) CreateDeploymentJob

func (c *Client) CreateDeploymentJob(ctx context.Context, params *CreateDeploymentJobInput, optFns ...func(*Options)) (*CreateDeploymentJobOutput, error)

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.

func (*Client) CreateFleet

func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error)

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

func (*Client) CreateRobot

func (c *Client) CreateRobot(ctx context.Context, params *CreateRobotInput, optFns ...func(*Options)) (*CreateRobotOutput, error)

Creates a robot.

func (*Client) CreateRobotApplication

func (c *Client) CreateRobotApplication(ctx context.Context, params *CreateRobotApplicationInput, optFns ...func(*Options)) (*CreateRobotApplicationOutput, error)

Creates a robot application.

func (*Client) CreateRobotApplicationVersion

func (c *Client) CreateRobotApplicationVersion(ctx context.Context, params *CreateRobotApplicationVersionInput, optFns ...func(*Options)) (*CreateRobotApplicationVersionOutput, error)

Creates a version of a robot application.

func (*Client) CreateSimulationApplication

func (c *Client) CreateSimulationApplication(ctx context.Context, params *CreateSimulationApplicationInput, optFns ...func(*Options)) (*CreateSimulationApplicationOutput, error)

Creates a simulation application.

func (*Client) CreateSimulationApplicationVersion

func (c *Client) CreateSimulationApplicationVersion(ctx context.Context, params *CreateSimulationApplicationVersionInput, optFns ...func(*Options)) (*CreateSimulationApplicationVersionOutput, error)

Creates a simulation application with a specific revision id.

func (*Client) CreateSimulationJob

func (c *Client) CreateSimulationJob(ctx context.Context, params *CreateSimulationJobInput, optFns ...func(*Options)) (*CreateSimulationJobOutput, error)

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

func (*Client) CreateWorldExportJob added in v0.29.0

func (c *Client) CreateWorldExportJob(ctx context.Context, params *CreateWorldExportJobInput, optFns ...func(*Options)) (*CreateWorldExportJobOutput, error)

Creates a world export job.

func (*Client) CreateWorldGenerationJob added in v0.29.0

func (c *Client) CreateWorldGenerationJob(ctx context.Context, params *CreateWorldGenerationJobInput, optFns ...func(*Options)) (*CreateWorldGenerationJobOutput, error)

Creates worlds using the specified template.

func (*Client) CreateWorldTemplate added in v0.29.0

func (c *Client) CreateWorldTemplate(ctx context.Context, params *CreateWorldTemplateInput, optFns ...func(*Options)) (*CreateWorldTemplateOutput, error)

Creates a world template.

func (*Client) DeleteFleet

func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optFns ...func(*Options)) (*DeleteFleetOutput, error)

Deletes a fleet.

func (*Client) DeleteRobot

func (c *Client) DeleteRobot(ctx context.Context, params *DeleteRobotInput, optFns ...func(*Options)) (*DeleteRobotOutput, error)

Deletes a robot.

func (*Client) DeleteRobotApplication

func (c *Client) DeleteRobotApplication(ctx context.Context, params *DeleteRobotApplicationInput, optFns ...func(*Options)) (*DeleteRobotApplicationOutput, error)

Deletes a robot application.

func (*Client) DeleteSimulationApplication

func (c *Client) DeleteSimulationApplication(ctx context.Context, params *DeleteSimulationApplicationInput, optFns ...func(*Options)) (*DeleteSimulationApplicationOutput, error)

Deletes a simulation application.

func (*Client) DeleteWorldTemplate added in v0.29.0

func (c *Client) DeleteWorldTemplate(ctx context.Context, params *DeleteWorldTemplateInput, optFns ...func(*Options)) (*DeleteWorldTemplateOutput, error)

Deletes a world template.

func (*Client) DeregisterRobot

func (c *Client) DeregisterRobot(ctx context.Context, params *DeregisterRobotInput, optFns ...func(*Options)) (*DeregisterRobotOutput, error)

Deregisters a robot.

func (*Client) DescribeDeploymentJob

func (c *Client) DescribeDeploymentJob(ctx context.Context, params *DescribeDeploymentJobInput, optFns ...func(*Options)) (*DescribeDeploymentJobOutput, error)

Describes a deployment job.

func (*Client) DescribeFleet

func (c *Client) DescribeFleet(ctx context.Context, params *DescribeFleetInput, optFns ...func(*Options)) (*DescribeFleetOutput, error)

Describes a fleet.

func (*Client) DescribeRobot

func (c *Client) DescribeRobot(ctx context.Context, params *DescribeRobotInput, optFns ...func(*Options)) (*DescribeRobotOutput, error)

Describes a robot.

func (*Client) DescribeRobotApplication

func (c *Client) DescribeRobotApplication(ctx context.Context, params *DescribeRobotApplicationInput, optFns ...func(*Options)) (*DescribeRobotApplicationOutput, error)

Describes a robot application.

func (*Client) DescribeSimulationApplication

func (c *Client) DescribeSimulationApplication(ctx context.Context, params *DescribeSimulationApplicationInput, optFns ...func(*Options)) (*DescribeSimulationApplicationOutput, error)

Describes a simulation application.

func (*Client) DescribeSimulationJob

func (c *Client) DescribeSimulationJob(ctx context.Context, params *DescribeSimulationJobInput, optFns ...func(*Options)) (*DescribeSimulationJobOutput, error)

Describes a simulation job.

func (*Client) DescribeSimulationJobBatch

func (c *Client) DescribeSimulationJobBatch(ctx context.Context, params *DescribeSimulationJobBatchInput, optFns ...func(*Options)) (*DescribeSimulationJobBatchOutput, error)

Describes a simulation job batch.

func (*Client) DescribeWorld added in v0.29.0

func (c *Client) DescribeWorld(ctx context.Context, params *DescribeWorldInput, optFns ...func(*Options)) (*DescribeWorldOutput, error)

Describes a world.

func (*Client) DescribeWorldExportJob added in v0.29.0

func (c *Client) DescribeWorldExportJob(ctx context.Context, params *DescribeWorldExportJobInput, optFns ...func(*Options)) (*DescribeWorldExportJobOutput, error)

Describes a world export job.

func (*Client) DescribeWorldGenerationJob added in v0.29.0

func (c *Client) DescribeWorldGenerationJob(ctx context.Context, params *DescribeWorldGenerationJobInput, optFns ...func(*Options)) (*DescribeWorldGenerationJobOutput, error)

Describes a world generation job.

func (*Client) DescribeWorldTemplate added in v0.29.0

func (c *Client) DescribeWorldTemplate(ctx context.Context, params *DescribeWorldTemplateInput, optFns ...func(*Options)) (*DescribeWorldTemplateOutput, error)

Describes a world template.

func (*Client) GetWorldTemplateBody added in v0.29.0

func (c *Client) GetWorldTemplateBody(ctx context.Context, params *GetWorldTemplateBodyInput, optFns ...func(*Options)) (*GetWorldTemplateBodyOutput, error)

Gets the world template body.

func (*Client) ListDeploymentJobs

func (c *Client) ListDeploymentJobs(ctx context.Context, params *ListDeploymentJobsInput, optFns ...func(*Options)) (*ListDeploymentJobsOutput, error)

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

func (*Client) ListFleets

func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns ...func(*Options)) (*ListFleetsOutput, error)

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

func (*Client) ListRobotApplications

func (c *Client) ListRobotApplications(ctx context.Context, params *ListRobotApplicationsInput, optFns ...func(*Options)) (*ListRobotApplicationsOutput, error)

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

func (*Client) ListRobots

func (c *Client) ListRobots(ctx context.Context, params *ListRobotsInput, optFns ...func(*Options)) (*ListRobotsOutput, error)

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

func (*Client) ListSimulationApplications

func (c *Client) ListSimulationApplications(ctx context.Context, params *ListSimulationApplicationsInput, optFns ...func(*Options)) (*ListSimulationApplicationsOutput, error)

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

func (*Client) ListSimulationJobBatches

func (c *Client) ListSimulationJobBatches(ctx context.Context, params *ListSimulationJobBatchesInput, optFns ...func(*Options)) (*ListSimulationJobBatchesOutput, error)

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

func (*Client) ListSimulationJobs

func (c *Client) ListSimulationJobs(ctx context.Context, params *ListSimulationJobsInput, optFns ...func(*Options)) (*ListSimulationJobsOutput, error)

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

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags on a AWS RoboMaker resource.

func (*Client) ListWorldExportJobs added in v0.29.0

func (c *Client) ListWorldExportJobs(ctx context.Context, params *ListWorldExportJobsInput, optFns ...func(*Options)) (*ListWorldExportJobsOutput, error)

Lists world export jobs.

func (*Client) ListWorldGenerationJobs added in v0.29.0

func (c *Client) ListWorldGenerationJobs(ctx context.Context, params *ListWorldGenerationJobsInput, optFns ...func(*Options)) (*ListWorldGenerationJobsOutput, error)

Lists world generator jobs.

func (*Client) ListWorldTemplates added in v0.29.0

func (c *Client) ListWorldTemplates(ctx context.Context, params *ListWorldTemplatesInput, optFns ...func(*Options)) (*ListWorldTemplatesOutput, error)

Lists world templates.

func (*Client) ListWorlds added in v0.29.0

func (c *Client) ListWorlds(ctx context.Context, params *ListWorldsInput, optFns ...func(*Options)) (*ListWorldsOutput, error)

Lists worlds.

func (*Client) RegisterRobot

func (c *Client) RegisterRobot(ctx context.Context, params *RegisterRobotInput, optFns ...func(*Options)) (*RegisterRobotOutput, error)

Registers a robot with a fleet.

func (*Client) RestartSimulationJob

func (c *Client) RestartSimulationJob(ctx context.Context, params *RestartSimulationJobInput, optFns ...func(*Options)) (*RestartSimulationJobOutput, error)

Restarts a running simulation job.

func (*Client) StartSimulationJobBatch

func (c *Client) StartSimulationJobBatch(ctx context.Context, params *StartSimulationJobBatchInput, optFns ...func(*Options)) (*StartSimulationJobBatchOutput, error)

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

func (*Client) SyncDeploymentJob

func (c *Client) SyncDeploymentJob(ctx context.Context, params *SyncDeploymentJobInput, optFns ...func(*Options)) (*SyncDeploymentJobOutput, error)

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

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

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.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

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).

func (*Client) UpdateRobotApplication

func (c *Client) UpdateRobotApplication(ctx context.Context, params *UpdateRobotApplicationInput, optFns ...func(*Options)) (*UpdateRobotApplicationOutput, error)

Updates a robot application.

func (*Client) UpdateSimulationApplication

func (c *Client) UpdateSimulationApplication(ctx context.Context, params *UpdateSimulationApplicationInput, optFns ...func(*Options)) (*UpdateSimulationApplicationOutput, error)

Updates a simulation application.

func (*Client) UpdateWorldTemplate added in v0.29.0

func (c *Client) UpdateWorldTemplate(ctx context.Context, params *UpdateWorldTemplateInput, optFns ...func(*Options)) (*UpdateWorldTemplateOutput, error)

Updates a world template.

type CreateDeploymentJobInput

type CreateDeploymentJobInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientRequestToken *string

	// The deployment application configuration.
	//
	// This member is required.
	DeploymentApplicationConfigs []types.DeploymentApplicationConfig

	// The Amazon Resource Name (ARN) of the fleet to deploy.
	//
	// This member is required.
	Fleet *string

	// The requested deployment configuration.
	DeploymentConfig *types.DeploymentConfig

	// A map that contains tag keys and tag values that are attached to the deployment
	// job.
	Tags map[string]string
}

type CreateDeploymentJobOutput

type CreateDeploymentJobOutput struct {

	// The Amazon Resource Name (ARN) of the deployment job.
	Arn *string

	// The time, in milliseconds since the epoch, when the fleet was created.
	CreatedAt *time.Time

	// The deployment application configuration.
	DeploymentApplicationConfigs []types.DeploymentApplicationConfig

	// The deployment configuration.
	DeploymentConfig *types.DeploymentConfig

	// The failure code of the simulation job if it failed: BadPermissionError AWS
	// Greengrass requires a service-level role permission to access other services.
	// The role must include the AWSGreengrassResourceAccessRolePolicy managed policy
	// (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor).
	// ExtractingBundleFailure The robot application could not be extracted from the
	// bundle. FailureThresholdBreached The percentage of robots that could not be
	// updated exceeded the percentage set for the deployment.
	// GreengrassDeploymentFailed The robot application could not be deployed to the
	// robot. GreengrassGroupVersionDoesNotExist The AWS Greengrass group or version
	// associated with a robot is missing. InternalServerError An internal error has
	// occurred. Retry your request, but if the problem persists, contact us with
	// details. MissingRobotApplicationArchitecture The robot application does not have
	// a source that matches the architecture of the robot.
	// MissingRobotDeploymentResource One or more of the resources specified for the
	// robot application are missing. For example, does the robot application have the
	// correct launch package and launch file? PostLaunchFileFailure The post-launch
	// script failed. PreLaunchFileFailure The pre-launch script failed.
	// ResourceNotFound One or more deployment resources are missing. For example, do
	// robot application source bundles still exist? RobotDeploymentNoResponse There is
	// no response from the robot. It might not be powered on or connected to the
	// internet.
	FailureCode types.DeploymentJobErrorCode

	// The failure reason of the deployment job if it failed.
	FailureReason *string

	// The target fleet for the deployment job.
	Fleet *string

	// The status of the deployment job.
	Status types.DeploymentStatus

	// The list of all tags added to the deployment job.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateFleetInput

type CreateFleetInput struct {

	// The name of the fleet.
	//
	// This member is required.
	Name *string

	// A map that contains tag keys and tag values that are attached to the fleet.
	Tags map[string]string
}

type CreateFleetOutput

type CreateFleetOutput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	Arn *string

	// The time, in milliseconds since the epoch, when the fleet was created.
	CreatedAt *time.Time

	// The name of the fleet.
	Name *string

	// The list of all tags added to the fleet.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRobotApplicationInput

type CreateRobotApplicationInput struct {

	// The name of the robot application.
	//
	// This member is required.
	Name *string

	// The robot software suite (ROS distribuition) used by the robot application.
	//
	// This member is required.
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The sources of the robot application.
	//
	// This member is required.
	Sources []types.SourceConfig

	// A map that contains tag keys and tag values that are attached to the robot
	// application.
	Tags map[string]string
}

type CreateRobotApplicationOutput

type CreateRobotApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the robot application.
	Arn *string

	// The time, in milliseconds since the epoch, when the robot application was last
	// updated.
	LastUpdatedAt *time.Time

	// The name of the robot application.
	Name *string

	// The revision id of the robot application.
	RevisionId *string

	// The robot software suite (ROS distribution) used by the robot application.
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The sources of the robot application.
	Sources []types.Source

	// The list of all tags added to the robot application.
	Tags map[string]string

	// The version of the robot application.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRobotApplicationVersionInput

type CreateRobotApplicationVersionInput struct {

	// The application information for the robot application.
	//
	// This member is required.
	Application *string

	// 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.
	CurrentRevisionId *string
}

type CreateRobotApplicationVersionOutput

type CreateRobotApplicationVersionOutput struct {

	// The Amazon Resource Name (ARN) of the robot application.
	Arn *string

	// The time, in milliseconds since the epoch, when the robot application was last
	// updated.
	LastUpdatedAt *time.Time

	// The name of the robot application.
	Name *string

	// The revision id of the robot application.
	RevisionId *string

	// The robot software suite (ROS distribution) used by the robot application.
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The sources of the robot application.
	Sources []types.Source

	// The version of the robot application.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRobotInput

type CreateRobotInput struct {

	// The target architecture of the robot.
	//
	// This member is required.
	Architecture types.Architecture

	// The Greengrass group id.
	//
	// This member is required.
	GreengrassGroupId *string

	// The name for the robot.
	//
	// This member is required.
	Name *string

	// A map that contains tag keys and tag values that are attached to the robot.
	Tags map[string]string
}

type CreateRobotOutput

type CreateRobotOutput struct {

	// The target architecture of the robot.
	Architecture types.Architecture

	// The Amazon Resource Name (ARN) of the robot.
	Arn *string

	// The time, in milliseconds since the epoch, when the robot was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the Greengrass group associated with the
	// robot.
	GreengrassGroupId *string

	// The name of the robot.
	Name *string

	// The list of all tags added to the robot.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSimulationApplicationInput

type CreateSimulationApplicationInput struct {

	// The name of the simulation application.
	//
	// This member is required.
	Name *string

	// The robot software suite (ROS distribution) used by the simulation application.
	//
	// This member is required.
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The simulation software suite used by the simulation application.
	//
	// This member is required.
	SimulationSoftwareSuite *types.SimulationSoftwareSuite

	// The sources of the simulation application.
	//
	// This member is required.
	Sources []types.SourceConfig

	// The rendering engine for the simulation application.
	RenderingEngine *types.RenderingEngine

	// A map that contains tag keys and tag values that are attached to the simulation
	// application.
	Tags map[string]string
}

type CreateSimulationApplicationOutput

type CreateSimulationApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the simulation application.
	Arn *string

	// The time, in milliseconds since the epoch, when the simulation application was
	// last updated.
	LastUpdatedAt *time.Time

	// The name of the simulation application.
	Name *string

	// The rendering engine for the simulation application.
	RenderingEngine *types.RenderingEngine

	// The revision id of the simulation application.
	RevisionId *string

	// Information about the robot software suite (ROS distribution).
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The simulation software suite used by the simulation application.
	SimulationSoftwareSuite *types.SimulationSoftwareSuite

	// The sources of the simulation application.
	Sources []types.Source

	// The list of all tags added to the simulation application.
	Tags map[string]string

	// The version of the simulation application.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSimulationApplicationVersionInput

type CreateSimulationApplicationVersionInput struct {

	// The application information for the simulation application.
	//
	// This member is required.
	Application *string

	// 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.
	CurrentRevisionId *string
}

type CreateSimulationApplicationVersionOutput

type CreateSimulationApplicationVersionOutput struct {

	// The Amazon Resource Name (ARN) of the simulation application.
	Arn *string

	// The time, in milliseconds since the epoch, when the simulation application was
	// last updated.
	LastUpdatedAt *time.Time

	// The name of the simulation application.
	Name *string

	// The rendering engine for the simulation application.
	RenderingEngine *types.RenderingEngine

	// The revision ID of the simulation application.
	RevisionId *string

	// Information about the robot software suite (ROS distribution).
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The simulation software suite used by the simulation application.
	SimulationSoftwareSuite *types.SimulationSoftwareSuite

	// The sources of the simulation application.
	Sources []types.Source

	// The version of the simulation application.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSimulationJobInput

type CreateSimulationJobInput struct {

	// 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.
	//
	// This member is required.
	IamRole *string

	// 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.
	//
	// This member is required.
	MaxJobDurationInSeconds int64

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// Compute information for the simulation job.
	Compute *types.Compute

	// 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.
	DataSources []types.DataSourceConfig

	// The failure behavior the simulation job. Continue Restart the simulation job in
	// the same host instance. Fail Stop the simulation job and terminate the instance.
	FailureBehavior types.FailureBehavior

	// The logging configuration.
	LoggingConfig *types.LoggingConfig

	// Location for output files generated by the simulation job.
	OutputLocation *types.OutputLocation

	// The robot application to use in the simulation job.
	RobotApplications []types.RobotApplicationConfig

	// The simulation application to use in the simulation job.
	SimulationApplications []types.SimulationApplicationConfig

	// A map that contains tag keys and tag values that are attached to the simulation
	// job.
	Tags map[string]string

	// 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.
	VpcConfig *types.VPCConfig
}

type CreateSimulationJobOutput

type CreateSimulationJobOutput struct {

	// The Amazon Resource Name (ARN) of the simulation job.
	Arn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// Compute information for the simulation job.
	Compute *types.ComputeResponse

	// The data sources for the simulation job.
	DataSources []types.DataSource

	// the failure behavior for the simulation job.
	FailureBehavior types.FailureBehavior

	// 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.
	FailureCode types.SimulationJobErrorCode

	// The IAM role that allows the simulation job to call the AWS APIs that are
	// specified in its associated policies on your behalf.
	IamRole *string

	// The time, in milliseconds since the epoch, when the simulation job was last
	// started.
	LastStartedAt *time.Time

	// The time, in milliseconds since the epoch, when the simulation job was last
	// updated.
	LastUpdatedAt *time.Time

	// The logging configuration.
	LoggingConfig *types.LoggingConfig

	// The maximum simulation job duration in seconds.
	MaxJobDurationInSeconds int64

	// Simulation job output files location.
	OutputLocation *types.OutputLocation

	// The robot application used by the simulation job.
	RobotApplications []types.RobotApplicationConfig

	// The simulation application used by the simulation job.
	SimulationApplications []types.SimulationApplicationConfig

	// The simulation job execution duration in milliseconds.
	SimulationTimeMillis int64

	// The status of the simulation job.
	Status types.SimulationJobStatus

	// The list of all tags added to the simulation job.
	Tags map[string]string

	// Information about the vpc configuration.
	VpcConfig *types.VPCConfigResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateWorldExportJobInput added in v0.29.0

type CreateWorldExportJobInput struct {

	// The IAM role that the world export process uses to access the Amazon S3 bucket
	// and put the export.
	//
	// This member is required.
	IamRole *string

	// The output location.
	//
	// This member is required.
	OutputLocation *types.OutputLocation

	// A list of Amazon Resource Names (arns) that correspond to worlds to export.
	//
	// This member is required.
	Worlds []string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// A map that contains tag keys and tag values that are attached to the world
	// export job.
	Tags map[string]string
}

type CreateWorldExportJobOutput added in v0.29.0

type CreateWorldExportJobOutput struct {

	// The Amazon Resource Name (ARN) of the world export job.
	Arn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// The time, in milliseconds since the epoch, when the world export job was
	// created.
	CreatedAt *time.Time

	// 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
	// (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting-worldforge.html).
	FailureCode types.WorldExportJobErrorCode

	// The IAM role that the world export process uses to access the Amazon S3 bucket
	// and put the export.
	IamRole *string

	// The output location.
	OutputLocation *types.OutputLocation

	// 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.
	Status types.WorldExportJobStatus

	// A map that contains tag keys and tag values that are attached to the world
	// export job.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateWorldGenerationJobInput added in v0.29.0

type CreateWorldGenerationJobInput struct {

	// The Amazon Resource Name (arn) of the world template describing the worlds you
	// want to create.
	//
	// This member is required.
	Template *string

	// Information about the world count.
	//
	// This member is required.
	WorldCount *types.WorldCount

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// A map that contains tag keys and tag values that are attached to the world
	// generator job.
	Tags map[string]string

	// A map that contains tag keys and tag values that are attached to the generated
	// worlds.
	WorldTags map[string]string
}

type CreateWorldGenerationJobOutput added in v0.29.0

type CreateWorldGenerationJobOutput struct {

	// The Amazon Resource Name (ARN) of the world generator job.
	Arn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// The time, in milliseconds since the epoch, when the world generator job was
	// created.
	CreatedAt *time.Time

	// 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.
	FailureCode types.WorldGenerationJobErrorCode

	// 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.
	Status types.WorldGenerationJobStatus

	// A map that contains tag keys and tag values that are attached to the world
	// generator job.
	Tags map[string]string

	// The Amazon Resource Name (arn) of the world template.
	Template *string

	// Information about the world count.
	WorldCount *types.WorldCount

	// A map that contains tag keys and tag values that are attached to the generated
	// worlds.
	WorldTags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateWorldTemplateInput added in v0.29.0

type CreateWorldTemplateInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// The name of the world template.
	Name *string

	// A map that contains tag keys and tag values that are attached to the world
	// template.
	Tags map[string]string

	// The world template body.
	TemplateBody *string

	// The location of the world template.
	TemplateLocation *types.TemplateLocation
}

type CreateWorldTemplateOutput added in v0.29.0

type CreateWorldTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the world template.
	Arn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// The time, in milliseconds since the epoch, when the world template was created.
	CreatedAt *time.Time

	// The name of the world template.
	Name *string

	// A map that contains tag keys and tag values that are attached to the world
	// template.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteFleetInput

type DeleteFleetInput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	Fleet *string
}

type DeleteFleetOutput

type DeleteFleetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRobotApplicationInput

type DeleteRobotApplicationInput struct {

	// The Amazon Resource Name (ARN) of the the robot application.
	//
	// This member is required.
	Application *string

	// The version of the robot application to delete.
	ApplicationVersion *string
}

type DeleteRobotApplicationOutput

type DeleteRobotApplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRobotInput

type DeleteRobotInput struct {

	// The Amazon Resource Name (ARN) of the robot.
	//
	// This member is required.
	Robot *string
}

type DeleteRobotOutput

type DeleteRobotOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteSimulationApplicationInput

type DeleteSimulationApplicationInput struct {

	// The application information for the simulation application to delete.
	//
	// This member is required.
	Application *string

	// The version of the simulation application to delete.
	ApplicationVersion *string
}

type DeleteSimulationApplicationOutput

type DeleteSimulationApplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteWorldTemplateInput added in v0.29.0

type DeleteWorldTemplateInput struct {

	// The Amazon Resource Name (arn) of the world template you want to delete.
	//
	// This member is required.
	Template *string
}

type DeleteWorldTemplateOutput added in v0.29.0

type DeleteWorldTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeregisterRobotInput

type DeregisterRobotInput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	Fleet *string

	// The Amazon Resource Name (ARN) of the robot.
	//
	// This member is required.
	Robot *string
}

type DeregisterRobotOutput

type DeregisterRobotOutput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	Fleet *string

	// The Amazon Resource Name (ARN) of the robot.
	Robot *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDeploymentJobInput

type DescribeDeploymentJobInput struct {

	// The Amazon Resource Name (ARN) of the deployment job.
	//
	// This member is required.
	Job *string
}

type DescribeDeploymentJobOutput

type DescribeDeploymentJobOutput struct {

	// The Amazon Resource Name (ARN) of the deployment job.
	Arn *string

	// The time, in milliseconds since the epoch, when the deployment job was created.
	CreatedAt *time.Time

	// The deployment application configuration.
	DeploymentApplicationConfigs []types.DeploymentApplicationConfig

	// The deployment configuration.
	DeploymentConfig *types.DeploymentConfig

	// The deployment job failure code.
	FailureCode types.DeploymentJobErrorCode

	// A short description of the reason why the deployment job failed.
	FailureReason *string

	// The Amazon Resource Name (ARN) of the fleet.
	Fleet *string

	// A list of robot deployment summaries.
	RobotDeploymentSummary []types.RobotDeployment

	// The status of the deployment job.
	Status types.DeploymentStatus

	// The list of all tags added to the specified deployment job.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeFleetInput

type DescribeFleetInput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	Fleet *string
}

type DescribeFleetOutput

type DescribeFleetOutput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	Arn *string

	// The time, in milliseconds since the epoch, when the fleet was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the last deployment job.
	LastDeploymentJob *string

	// The status of the last deployment.
	LastDeploymentStatus types.DeploymentStatus

	// The time of the last deployment.
	LastDeploymentTime *time.Time

	// The name of the fleet.
	Name *string

	// A list of robots.
	Robots []types.Robot

	// The list of all tags added to the specified fleet.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeRobotApplicationInput

type DescribeRobotApplicationInput struct {

	// The Amazon Resource Name (ARN) of the robot application.
	//
	// This member is required.
	Application *string

	// The version of the robot application to describe.
	ApplicationVersion *string
}

type DescribeRobotApplicationOutput

type DescribeRobotApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the robot application.
	Arn *string

	// The time, in milliseconds since the epoch, when the robot application was last
	// updated.
	LastUpdatedAt *time.Time

	// The name of the robot application.
	Name *string

	// The revision id of the robot application.
	RevisionId *string

	// The robot software suite (ROS distribution) used by the robot application.
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The sources of the robot application.
	Sources []types.Source

	// The list of all tags added to the specified robot application.
	Tags map[string]string

	// The version of the robot application.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeRobotInput

type DescribeRobotInput struct {

	// The Amazon Resource Name (ARN) of the robot to be described.
	//
	// This member is required.
	Robot *string
}

type DescribeRobotOutput

type DescribeRobotOutput struct {

	// The target architecture of the robot application.
	Architecture types.Architecture

	// The Amazon Resource Name (ARN) of the robot.
	Arn *string

	// The time, in milliseconds since the epoch, when the robot was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the fleet.
	FleetArn *string

	// The Greengrass group id.
	GreengrassGroupId *string

	// The Amazon Resource Name (ARN) of the last deployment job.
	LastDeploymentJob *string

	// The time of the last deployment job.
	LastDeploymentTime *time.Time

	// The name of the robot.
	Name *string

	// The status of the fleet.
	Status types.RobotStatus

	// The list of all tags added to the specified robot.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSimulationApplicationInput

type DescribeSimulationApplicationInput struct {

	// The application information for the simulation application.
	//
	// This member is required.
	Application *string

	// The version of the simulation application to describe.
	ApplicationVersion *string
}

type DescribeSimulationApplicationOutput

type DescribeSimulationApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the robot simulation application.
	Arn *string

	// The time, in milliseconds since the epoch, when the simulation application was
	// last updated.
	LastUpdatedAt *time.Time

	// The name of the simulation application.
	Name *string

	// The rendering engine for the simulation application.
	RenderingEngine *types.RenderingEngine

	// The revision id of the simulation application.
	RevisionId *string

	// Information about the robot software suite (ROS distribution).
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The simulation software suite used by the simulation application.
	SimulationSoftwareSuite *types.SimulationSoftwareSuite

	// The sources of the simulation application.
	Sources []types.Source

	// The list of all tags added to the specified simulation application.
	Tags map[string]string

	// The version of the simulation application.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSimulationJobBatchInput

type DescribeSimulationJobBatchInput struct {

	// The id of the batch to describe.
	//
	// This member is required.
	Batch *string
}

type DescribeSimulationJobBatchOutput

type DescribeSimulationJobBatchOutput struct {

	// The Amazon Resource Name (ARN) of the batch.
	Arn *string

	// The batch policy.
	BatchPolicy *types.BatchPolicy

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// The time, in milliseconds since the epoch, when the simulation job batch was
	// created.
	CreatedAt *time.Time

	// A list of created simulation job summaries.
	CreatedRequests []types.SimulationJobSummary

	// 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.
	FailedRequests []types.FailedCreateSimulationJobRequest

	// The failure code of the simulation job batch.
	FailureCode types.SimulationJobBatchErrorCode

	// The reason the simulation job batch failed.
	FailureReason *string

	// The time, in milliseconds since the epoch, when the simulation job batch was
	// last updated.
	LastUpdatedAt *time.Time

	// A list of pending simulation job requests. These requests have not yet been
	// created into simulation jobs.
	PendingRequests []types.SimulationJobRequest

	// 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). See failureCode and
	// failureReason 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 or Failed). 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 be Failed. If there are no such failing request, the batch status
	// will be TimedOut. TimedOut The simulation batch job timed out.
	Status types.SimulationJobBatchStatus

	// A map that contains tag keys and tag values that are attached to the simulation
	// job batch.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSimulationJobInput

type DescribeSimulationJobInput struct {

	// The Amazon Resource Name (ARN) of the simulation job to be described.
	//
	// This member is required.
	Job *string
}

type DescribeSimulationJobOutput

type DescribeSimulationJobOutput struct {

	// The Amazon Resource Name (ARN) of the simulation job.
	Arn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// Compute information for the simulation job.
	Compute *types.ComputeResponse

	// The data sources for the simulation job.
	DataSources []types.DataSource

	// The failure behavior for the simulation job.
	FailureBehavior types.FailureBehavior

	// 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.
	FailureCode types.SimulationJobErrorCode

	// Details about why the simulation job failed. For more information about
	// troubleshooting, see Troubleshooting
	// (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html).
	FailureReason *string

	// The IAM role that allows the simulation instance to call the AWS APIs that are
	// specified in its associated policies on your behalf.
	IamRole *string

	// The time, in milliseconds since the epoch, when the simulation job was last
	// started.
	LastStartedAt *time.Time

	// The time, in milliseconds since the epoch, when the simulation job was last
	// updated.
	LastUpdatedAt *time.Time

	// The logging configuration.
	LoggingConfig *types.LoggingConfig

	// The maximum job duration in seconds. The value must be 8 days (691,200 seconds)
	// or less.
	MaxJobDurationInSeconds int64

	// The name of the simulation job.
	Name *string

	// The network interface information for the simulation job.
	NetworkInterface *types.NetworkInterface

	// Location for output files generated by the simulation job.
	OutputLocation *types.OutputLocation

	// A list of robot applications.
	RobotApplications []types.RobotApplicationConfig

	// A list of simulation applications.
	SimulationApplications []types.SimulationApplicationConfig

	// The simulation job execution duration in milliseconds.
	SimulationTimeMillis int64

	// The status of the simulation job.
	Status types.SimulationJobStatus

	// The list of all tags added to the specified simulation job.
	Tags map[string]string

	// The VPC configuration.
	VpcConfig *types.VPCConfigResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorldExportJobInput added in v0.29.0

type DescribeWorldExportJobInput struct {

	// The Amazon Resource Name (arn) of the world export job to describe.
	//
	// This member is required.
	Job *string
}

type DescribeWorldExportJobOutput added in v0.29.0

type DescribeWorldExportJobOutput struct {

	// The Amazon Resource Name (ARN) of the world export job.
	Arn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// The time, in milliseconds since the epoch, when the world export job was
	// created.
	CreatedAt *time.Time

	// 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.
	FailureCode types.WorldExportJobErrorCode

	// The reason why the world export job failed.
	FailureReason *string

	// The IAM role that the world export process uses to access the Amazon S3 bucket
	// and put the export.
	IamRole *string

	// The output location.
	OutputLocation *types.OutputLocation

	// 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 and failureReason
	// for more information. Canceled The world export job was cancelled. Canceling The
	// world export job is being cancelled.
	Status types.WorldExportJobStatus

	// A map that contains tag keys and tag values that are attached to the world
	// export job.
	Tags map[string]string

	// A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
	Worlds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorldGenerationJobInput added in v0.29.0

type DescribeWorldGenerationJobInput struct {

	// The Amazon Resource Name (arn) of the world generation job to describe.
	//
	// This member is required.
	Job *string
}

type DescribeWorldGenerationJobOutput added in v0.29.0

type DescribeWorldGenerationJobOutput struct {

	// The Amazon Resource Name (ARN) of the world generation job.
	Arn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// The time, in milliseconds since the epoch, when the world generation job was
	// created.
	CreatedAt *time.Time

	// 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.
	FailureCode types.WorldGenerationJobErrorCode

	// The reason why the world generation job failed.
	FailureReason *string

	// Summary information about finished worlds.
	FinishedWorldsSummary *types.FinishedWorldsSummary

	// 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.
	Status types.WorldGenerationJobStatus

	// A map that contains tag keys and tag values that are attached to the world
	// generation job.
	Tags map[string]string

	// The Amazon Resource Name (arn) of the world template.
	Template *string

	// Information about the world count.
	WorldCount *types.WorldCount

	// A map that contains tag keys and tag values that are attached to the generated
	// worlds.
	WorldTags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorldInput added in v0.29.0

type DescribeWorldInput struct {

	// The Amazon Resource Name (arn) of the world you want to describe.
	//
	// This member is required.
	World *string
}

type DescribeWorldOutput added in v0.29.0

type DescribeWorldOutput struct {

	// The Amazon Resource Name (arn) of the world.
	Arn *string

	// The time, in milliseconds since the epoch, when the world was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (arn) of the world generation job that generated the
	// world.
	GenerationJob *string

	// A map that contains tag keys and tag values that are attached to the world.
	Tags map[string]string

	// The world template.
	Template *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorldTemplateInput added in v0.29.0

type DescribeWorldTemplateInput struct {

	// The Amazon Resource Name (arn) of the world template you want to describe.
	//
	// This member is required.
	Template *string
}

type DescribeWorldTemplateOutput added in v0.29.0

type DescribeWorldTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the world template.
	Arn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// The time, in milliseconds since the epoch, when the world template was created.
	CreatedAt *time.Time

	// The time, in milliseconds since the epoch, when the world template was last
	// updated.
	LastUpdatedAt *time.Time

	// The name of the world template.
	Name *string

	// A map that contains tag keys and tag values that are attached to the world
	// template.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetWorldTemplateBodyInput added in v0.29.0

type GetWorldTemplateBodyInput struct {

	// The Amazon Resource Name (arn) of the world generator job.
	GenerationJob *string

	// The Amazon Resource Name (arn) of the world template.
	Template *string
}

type GetWorldTemplateBodyOutput added in v0.29.0

type GetWorldTemplateBodyOutput struct {

	// The world template body.
	TemplateBody *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListDeploymentJobsAPIClient added in v0.30.0

type ListDeploymentJobsAPIClient interface {
	ListDeploymentJobs(context.Context, *ListDeploymentJobsInput, ...func(*Options)) (*ListDeploymentJobsOutput, error)
}

ListDeploymentJobsAPIClient is a client that implements the ListDeploymentJobs operation.

type ListDeploymentJobsInput

type ListDeploymentJobsInput struct {

	// Optional filters to limit results. The filter names status and fleetName 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 InProgress or the status
	// Pending.
	Filters []types.Filter

	// When this parameter is used, ListDeploymentJobs 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 ListDeploymentJobs request
	// with the returned nextToken value. This value can be between 1 and 200. If this
	// parameter is not used, then ListDeploymentJobs returns up to 200 results and a
	// nextToken value if applicable.
	MaxResults *int32

	// 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 ListDeploymentJobs 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.
	NextToken *string
}

type ListDeploymentJobsOutput

type ListDeploymentJobsOutput struct {

	// A list of deployment jobs that meet the criteria of the request.
	DeploymentJobs []types.DeploymentJob

	// 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 ListDeploymentJobs 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDeploymentJobsPaginator added in v0.30.0

type ListDeploymentJobsPaginator struct {
	// contains filtered or unexported fields
}

ListDeploymentJobsPaginator is a paginator for ListDeploymentJobs

func NewListDeploymentJobsPaginator added in v0.30.0

func NewListDeploymentJobsPaginator(client ListDeploymentJobsAPIClient, params *ListDeploymentJobsInput, optFns ...func(*ListDeploymentJobsPaginatorOptions)) *ListDeploymentJobsPaginator

NewListDeploymentJobsPaginator returns a new ListDeploymentJobsPaginator

func (*ListDeploymentJobsPaginator) HasMorePages added in v0.30.0

func (p *ListDeploymentJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeploymentJobsPaginator) NextPage added in v0.30.0

func (p *ListDeploymentJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeploymentJobsOutput, error)

NextPage retrieves the next ListDeploymentJobs page.

type ListDeploymentJobsPaginatorOptions added in v0.30.0

type ListDeploymentJobsPaginatorOptions struct {
	// When this parameter is used, ListDeploymentJobs 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 ListDeploymentJobs request
	// with the returned nextToken value. This value can be between 1 and 200. If this
	// parameter is not used, then ListDeploymentJobs returns up to 200 results and a
	// nextToken value if applicable.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDeploymentJobsPaginatorOptions is the paginator options for ListDeploymentJobs

type ListFleetsAPIClient added in v0.30.0

type ListFleetsAPIClient interface {
	ListFleets(context.Context, *ListFleetsInput, ...func(*Options)) (*ListFleetsOutput, error)
}

ListFleetsAPIClient is a client that implements the ListFleets operation.

type ListFleetsInput

type ListFleetsInput struct {

	// 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.
	Filters []types.Filter

	// When this parameter is used, ListFleets 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 ListFleets request with the
	// returned nextToken value. This value can be between 1 and 200. If this parameter
	// is not used, then ListFleets returns up to 200 results and a nextToken value if
	// applicable.
	MaxResults *int32

	// 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 ListFleets 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. This token should
	// be treated as an opaque identifier that is only used to retrieve the next items
	// in a list and not for other programmatic purposes.
	NextToken *string
}

type ListFleetsOutput

type ListFleetsOutput struct {

	// A list of fleet details meeting the request criteria.
	FleetDetails []types.Fleet

	// 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 ListFleets 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListFleetsPaginator added in v0.30.0

type ListFleetsPaginator struct {
	// contains filtered or unexported fields
}

ListFleetsPaginator is a paginator for ListFleets

func NewListFleetsPaginator added in v0.30.0

func NewListFleetsPaginator(client ListFleetsAPIClient, params *ListFleetsInput, optFns ...func(*ListFleetsPaginatorOptions)) *ListFleetsPaginator

NewListFleetsPaginator returns a new ListFleetsPaginator

func (*ListFleetsPaginator) HasMorePages added in v0.30.0

func (p *ListFleetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFleetsPaginator) NextPage added in v0.30.0

func (p *ListFleetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFleetsOutput, error)

NextPage retrieves the next ListFleets page.

type ListFleetsPaginatorOptions added in v0.30.0

type ListFleetsPaginatorOptions struct {
	// When this parameter is used, ListFleets 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 ListFleets request with the
	// returned nextToken value. This value can be between 1 and 200. If this parameter
	// is not used, then ListFleets returns up to 200 results and a nextToken value if
	// applicable.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFleetsPaginatorOptions is the paginator options for ListFleets

type ListRobotApplicationsAPIClient added in v0.30.0

type ListRobotApplicationsAPIClient interface {
	ListRobotApplications(context.Context, *ListRobotApplicationsInput, ...func(*Options)) (*ListRobotApplicationsOutput, error)
}

ListRobotApplicationsAPIClient is a client that implements the ListRobotApplications operation.

type ListRobotApplicationsInput

type ListRobotApplicationsInput struct {

	// 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.
	Filters []types.Filter

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string

	// The version qualifier of the robot application.
	VersionQualifier *string
}

type ListRobotApplicationsOutput

type ListRobotApplicationsOutput struct {

	// 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.
	NextToken *string

	// A list of robot application summaries that meet the criteria of the request.
	RobotApplicationSummaries []types.RobotApplicationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListRobotApplicationsPaginator added in v0.30.0

type ListRobotApplicationsPaginator struct {
	// contains filtered or unexported fields
}

ListRobotApplicationsPaginator is a paginator for ListRobotApplications

func NewListRobotApplicationsPaginator added in v0.30.0

NewListRobotApplicationsPaginator returns a new ListRobotApplicationsPaginator

func (*ListRobotApplicationsPaginator) HasMorePages added in v0.30.0

func (p *ListRobotApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRobotApplicationsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListRobotApplications page.

type ListRobotApplicationsPaginatorOptions added in v0.30.0

type ListRobotApplicationsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRobotApplicationsPaginatorOptions is the paginator options for ListRobotApplications

type ListRobotsAPIClient added in v0.30.0

type ListRobotsAPIClient interface {
	ListRobots(context.Context, *ListRobotsInput, ...func(*Options)) (*ListRobotsOutput, error)
}

ListRobotsAPIClient is a client that implements the ListRobots operation.

type ListRobotsInput

type ListRobotsInput struct {

	// Optional filters to limit results. The filter names status and fleetName 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 Registered or the status
	// Available.
	Filters []types.Filter

	// When this parameter is used, ListRobots 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 ListRobots request with the
	// returned nextToken value. This value can be between 1 and 200. If this parameter
	// is not used, then ListRobots returns up to 200 results and a nextToken value if
	// applicable.
	MaxResults *int32

	// 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 ListRobots 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.
	NextToken *string
}

type ListRobotsOutput

type ListRobotsOutput struct {

	// 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 ListRobots 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.
	NextToken *string

	// A list of robots that meet the criteria of the request.
	Robots []types.Robot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListRobotsPaginator added in v0.30.0

type ListRobotsPaginator struct {
	// contains filtered or unexported fields
}

ListRobotsPaginator is a paginator for ListRobots

func NewListRobotsPaginator added in v0.30.0

func NewListRobotsPaginator(client ListRobotsAPIClient, params *ListRobotsInput, optFns ...func(*ListRobotsPaginatorOptions)) *ListRobotsPaginator

NewListRobotsPaginator returns a new ListRobotsPaginator

func (*ListRobotsPaginator) HasMorePages added in v0.30.0

func (p *ListRobotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRobotsPaginator) NextPage added in v0.30.0

func (p *ListRobotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRobotsOutput, error)

NextPage retrieves the next ListRobots page.

type ListRobotsPaginatorOptions added in v0.30.0

type ListRobotsPaginatorOptions struct {
	// When this parameter is used, ListRobots 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 ListRobots request with the
	// returned nextToken value. This value can be between 1 and 200. If this parameter
	// is not used, then ListRobots returns up to 200 results and a nextToken value if
	// applicable.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRobotsPaginatorOptions is the paginator options for ListRobots

type ListSimulationApplicationsAPIClient added in v0.30.0

type ListSimulationApplicationsAPIClient interface {
	ListSimulationApplications(context.Context, *ListSimulationApplicationsInput, ...func(*Options)) (*ListSimulationApplicationsOutput, error)
}

ListSimulationApplicationsAPIClient is a client that implements the ListSimulationApplications operation.

type ListSimulationApplicationsInput

type ListSimulationApplicationsInput struct {

	// 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.
	Filters []types.Filter

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string

	// The version qualifier of the simulation application.
	VersionQualifier *string
}

type ListSimulationApplicationsOutput

type ListSimulationApplicationsOutput struct {

	// 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.
	NextToken *string

	// A list of simulation application summaries that meet the criteria of the
	// request.
	SimulationApplicationSummaries []types.SimulationApplicationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSimulationApplicationsPaginator added in v0.30.0

type ListSimulationApplicationsPaginator struct {
	// contains filtered or unexported fields
}

ListSimulationApplicationsPaginator is a paginator for ListSimulationApplications

func NewListSimulationApplicationsPaginator added in v0.30.0

NewListSimulationApplicationsPaginator returns a new ListSimulationApplicationsPaginator

func (*ListSimulationApplicationsPaginator) HasMorePages added in v0.30.0

func (p *ListSimulationApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSimulationApplicationsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListSimulationApplications page.

type ListSimulationApplicationsPaginatorOptions added in v0.30.0

type ListSimulationApplicationsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSimulationApplicationsPaginatorOptions is the paginator options for ListSimulationApplications

type ListSimulationJobBatchesAPIClient added in v0.30.0

type ListSimulationJobBatchesAPIClient interface {
	ListSimulationJobBatches(context.Context, *ListSimulationJobBatchesInput, ...func(*Options)) (*ListSimulationJobBatchesOutput, error)
}

ListSimulationJobBatchesAPIClient is a client that implements the ListSimulationJobBatches operation.

type ListSimulationJobBatchesInput

type ListSimulationJobBatchesInput struct {

	// Optional filters to limit results.
	Filters []types.Filter

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
}

type ListSimulationJobBatchesOutput

type ListSimulationJobBatchesOutput struct {

	// 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.
	NextToken *string

	// A list of simulation job batch summaries.
	SimulationJobBatchSummaries []types.SimulationJobBatchSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSimulationJobBatchesPaginator added in v0.30.0

type ListSimulationJobBatchesPaginator struct {
	// contains filtered or unexported fields
}

ListSimulationJobBatchesPaginator is a paginator for ListSimulationJobBatches

func NewListSimulationJobBatchesPaginator added in v0.30.0

NewListSimulationJobBatchesPaginator returns a new ListSimulationJobBatchesPaginator

func (*ListSimulationJobBatchesPaginator) HasMorePages added in v0.30.0

func (p *ListSimulationJobBatchesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSimulationJobBatchesPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListSimulationJobBatches page.

type ListSimulationJobBatchesPaginatorOptions added in v0.30.0

type ListSimulationJobBatchesPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSimulationJobBatchesPaginatorOptions is the paginator options for ListSimulationJobBatches

type ListSimulationJobsAPIClient added in v0.30.0

type ListSimulationJobsAPIClient interface {
	ListSimulationJobs(context.Context, *ListSimulationJobsInput, ...func(*Options)) (*ListSimulationJobsOutput, error)
}

ListSimulationJobsAPIClient is a client that implements the ListSimulationJobs operation.

type ListSimulationJobsInput

type ListSimulationJobsInput struct {

	// 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.
	Filters []types.Filter

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
}

type ListSimulationJobsOutput

type ListSimulationJobsOutput struct {

	// A list of simulation job summaries that meet the criteria of the request.
	//
	// This member is required.
	SimulationJobSummaries []types.SimulationJobSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSimulationJobsPaginator added in v0.30.0

type ListSimulationJobsPaginator struct {
	// contains filtered or unexported fields
}

ListSimulationJobsPaginator is a paginator for ListSimulationJobs

func NewListSimulationJobsPaginator added in v0.30.0

func NewListSimulationJobsPaginator(client ListSimulationJobsAPIClient, params *ListSimulationJobsInput, optFns ...func(*ListSimulationJobsPaginatorOptions)) *ListSimulationJobsPaginator

NewListSimulationJobsPaginator returns a new ListSimulationJobsPaginator

func (*ListSimulationJobsPaginator) HasMorePages added in v0.30.0

func (p *ListSimulationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSimulationJobsPaginator) NextPage added in v0.30.0

func (p *ListSimulationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSimulationJobsOutput, error)

NextPage retrieves the next ListSimulationJobs page.

type ListSimulationJobsPaginatorOptions added in v0.30.0

type ListSimulationJobsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSimulationJobsPaginatorOptions is the paginator options for ListSimulationJobs

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
	//
	// This member is required.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The list of all tags added to the specified resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListWorldExportJobsAPIClient added in v0.30.0

type ListWorldExportJobsAPIClient interface {
	ListWorldExportJobs(context.Context, *ListWorldExportJobsInput, ...func(*Options)) (*ListWorldExportJobsOutput, error)
}

ListWorldExportJobsAPIClient is a client that implements the ListWorldExportJobs operation.

type ListWorldExportJobsInput added in v0.29.0

type ListWorldExportJobsInput struct {

	// Optional filters to limit results. You can use generationJobId and templateId.
	Filters []types.Filter

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
}

type ListWorldExportJobsOutput added in v0.29.0

type ListWorldExportJobsOutput struct {

	// Summary information for world export jobs.
	//
	// This member is required.
	WorldExportJobSummaries []types.WorldExportJobSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListWorldExportJobsPaginator added in v0.30.0

type ListWorldExportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListWorldExportJobsPaginator is a paginator for ListWorldExportJobs

func NewListWorldExportJobsPaginator added in v0.30.0

func NewListWorldExportJobsPaginator(client ListWorldExportJobsAPIClient, params *ListWorldExportJobsInput, optFns ...func(*ListWorldExportJobsPaginatorOptions)) *ListWorldExportJobsPaginator

NewListWorldExportJobsPaginator returns a new ListWorldExportJobsPaginator

func (*ListWorldExportJobsPaginator) HasMorePages added in v0.30.0

func (p *ListWorldExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorldExportJobsPaginator) NextPage added in v0.30.0

func (p *ListWorldExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorldExportJobsOutput, error)

NextPage retrieves the next ListWorldExportJobs page.

type ListWorldExportJobsPaginatorOptions added in v0.30.0

type ListWorldExportJobsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorldExportJobsPaginatorOptions is the paginator options for ListWorldExportJobs

type ListWorldGenerationJobsAPIClient added in v0.30.0

type ListWorldGenerationJobsAPIClient interface {
	ListWorldGenerationJobs(context.Context, *ListWorldGenerationJobsInput, ...func(*Options)) (*ListWorldGenerationJobsOutput, error)
}

ListWorldGenerationJobsAPIClient is a client that implements the ListWorldGenerationJobs operation.

type ListWorldGenerationJobsInput added in v0.29.0

type ListWorldGenerationJobsInput struct {

	// Optional filters to limit results. You can use status and templateId.
	Filters []types.Filter

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
}

type ListWorldGenerationJobsOutput added in v0.29.0

type ListWorldGenerationJobsOutput struct {

	// Summary information for world generator jobs.
	//
	// This member is required.
	WorldGenerationJobSummaries []types.WorldGenerationJobSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListWorldGenerationJobsPaginator added in v0.30.0

type ListWorldGenerationJobsPaginator struct {
	// contains filtered or unexported fields
}

ListWorldGenerationJobsPaginator is a paginator for ListWorldGenerationJobs

func NewListWorldGenerationJobsPaginator added in v0.30.0

NewListWorldGenerationJobsPaginator returns a new ListWorldGenerationJobsPaginator

func (*ListWorldGenerationJobsPaginator) HasMorePages added in v0.30.0

func (p *ListWorldGenerationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorldGenerationJobsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListWorldGenerationJobs page.

type ListWorldGenerationJobsPaginatorOptions added in v0.30.0

type ListWorldGenerationJobsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorldGenerationJobsPaginatorOptions is the paginator options for ListWorldGenerationJobs

type ListWorldTemplatesAPIClient added in v0.30.0

type ListWorldTemplatesAPIClient interface {
	ListWorldTemplates(context.Context, *ListWorldTemplatesInput, ...func(*Options)) (*ListWorldTemplatesOutput, error)
}

ListWorldTemplatesAPIClient is a client that implements the ListWorldTemplates operation.

type ListWorldTemplatesInput added in v0.29.0

type ListWorldTemplatesInput struct {

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
}

type ListWorldTemplatesOutput added in v0.29.0

type ListWorldTemplatesOutput struct {

	// 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.
	NextToken *string

	// Summary information for templates.
	TemplateSummaries []types.TemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListWorldTemplatesPaginator added in v0.30.0

type ListWorldTemplatesPaginator struct {
	// contains filtered or unexported fields
}

ListWorldTemplatesPaginator is a paginator for ListWorldTemplates

func NewListWorldTemplatesPaginator added in v0.30.0

func NewListWorldTemplatesPaginator(client ListWorldTemplatesAPIClient, params *ListWorldTemplatesInput, optFns ...func(*ListWorldTemplatesPaginatorOptions)) *ListWorldTemplatesPaginator

NewListWorldTemplatesPaginator returns a new ListWorldTemplatesPaginator

func (*ListWorldTemplatesPaginator) HasMorePages added in v0.30.0

func (p *ListWorldTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorldTemplatesPaginator) NextPage added in v0.30.0

func (p *ListWorldTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorldTemplatesOutput, error)

NextPage retrieves the next ListWorldTemplates page.

type ListWorldTemplatesPaginatorOptions added in v0.30.0

type ListWorldTemplatesPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorldTemplatesPaginatorOptions is the paginator options for ListWorldTemplates

type ListWorldsAPIClient added in v0.30.0

type ListWorldsAPIClient interface {
	ListWorlds(context.Context, *ListWorldsInput, ...func(*Options)) (*ListWorldsOutput, error)
}

ListWorldsAPIClient is a client that implements the ListWorlds operation.

type ListWorldsInput added in v0.29.0

type ListWorldsInput struct {

	// Optional filters to limit results. You can use status.
	Filters []types.Filter

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
}

type ListWorldsOutput added in v0.29.0

type ListWorldsOutput struct {

	// 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.
	NextToken *string

	// Summary information for worlds.
	WorldSummaries []types.WorldSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListWorldsPaginator added in v0.30.0

type ListWorldsPaginator struct {
	// contains filtered or unexported fields
}

ListWorldsPaginator is a paginator for ListWorlds

func NewListWorldsPaginator added in v0.30.0

func NewListWorldsPaginator(client ListWorldsAPIClient, params *ListWorldsInput, optFns ...func(*ListWorldsPaginatorOptions)) *ListWorldsPaginator

NewListWorldsPaginator returns a new ListWorldsPaginator

func (*ListWorldsPaginator) HasMorePages added in v0.30.0

func (p *ListWorldsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorldsPaginator) NextPage added in v0.30.0

func (p *ListWorldsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorldsOutput, error)

NextPage retrieves the next ListWorlds page.

type ListWorldsPaginatorOptions added in v0.30.0

type ListWorldsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorldsPaginatorOptions is the paginator options for ListWorlds

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type RegisterRobotInput

type RegisterRobotInput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	Fleet *string

	// The Amazon Resource Name (ARN) of the robot.
	//
	// This member is required.
	Robot *string
}

type RegisterRobotOutput

type RegisterRobotOutput struct {

	// The Amazon Resource Name (ARN) of the fleet that the robot will join.
	Fleet *string

	// Information about the robot registration.
	Robot *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type RestartSimulationJobInput

type RestartSimulationJobInput struct {

	// The Amazon Resource Name (ARN) of the simulation job.
	//
	// This member is required.
	Job *string
}

type RestartSimulationJobOutput

type RestartSimulationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartSimulationJobBatchInput

type StartSimulationJobBatchInput struct {

	// A list of simulation job requests to create in the batch.
	//
	// This member is required.
	CreateSimulationJobRequests []types.SimulationJobRequest

	// The batch policy.
	BatchPolicy *types.BatchPolicy

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// A map that contains tag keys and tag values that are attached to the deployment
	// job batch.
	Tags map[string]string
}

type StartSimulationJobBatchOutput

type StartSimulationJobBatchOutput struct {

	// The Amazon Resource Name (arn) of the batch.
	Arn *string

	// The batch policy.
	BatchPolicy *types.BatchPolicy

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientRequestToken *string

	// The time, in milliseconds since the epoch, when the simulation job batch was
	// created.
	CreatedAt *time.Time

	// A list of created simulation job request summaries.
	CreatedRequests []types.SimulationJobSummary

	// 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.
	FailedRequests []types.FailedCreateSimulationJobRequest

	// The failure code if the simulation job batch failed.
	FailureCode types.SimulationJobBatchErrorCode

	// The reason the simulation job batch failed.
	FailureReason *string

	// A list of pending simulation job requests. These requests have not yet been
	// created into simulation jobs.
	PendingRequests []types.SimulationJobRequest

	// 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). See
	// failureCode and failureReason 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 or Failed). 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 be Failed. If there are no such
	// failing request, the batch status will be TimedOut. TimedOut The simulation
	// batch job timed out.
	Status types.SimulationJobBatchStatus

	// A map that contains tag keys and tag values that are attached to the deployment
	// job batch.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SyncDeploymentJobInput

type SyncDeploymentJobInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientRequestToken *string

	// The target fleet for the synchronization.
	//
	// This member is required.
	Fleet *string
}

type SyncDeploymentJobOutput

type SyncDeploymentJobOutput struct {

	// The Amazon Resource Name (ARN) of the synchronization request.
	Arn *string

	// The time, in milliseconds since the epoch, when the fleet was created.
	CreatedAt *time.Time

	// Information about the deployment application configurations.
	DeploymentApplicationConfigs []types.DeploymentApplicationConfig

	// Information about the deployment configuration.
	DeploymentConfig *types.DeploymentConfig

	// The failure code if the job fails: 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.
	FailureCode types.DeploymentJobErrorCode

	// The failure reason if the job fails.
	FailureReason *string

	// The Amazon Resource Name (ARN) of the fleet.
	Fleet *string

	// The status of the synchronization job.
	Status types.DeploymentStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
	//
	// This member is required.
	ResourceArn *string

	// A map that contains tag keys and tag values that are attached to the resource.
	//
	// This member is required.
	Tags map[string]string
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing
	// tags.
	//
	// This member is required.
	ResourceArn *string

	// A map that contains tag keys and tag values that will be unattached from the
	// resource.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRobotApplicationInput

type UpdateRobotApplicationInput struct {

	// The application information for the robot application.
	//
	// This member is required.
	Application *string

	// The robot software suite (ROS distribution) used by the robot application.
	//
	// This member is required.
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The sources of the robot application.
	//
	// This member is required.
	Sources []types.SourceConfig

	// The revision id for the robot application.
	CurrentRevisionId *string
}

type UpdateRobotApplicationOutput

type UpdateRobotApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the updated robot application.
	Arn *string

	// The time, in milliseconds since the epoch, when the robot application was last
	// updated.
	LastUpdatedAt *time.Time

	// The name of the robot application.
	Name *string

	// The revision id of the robot application.
	RevisionId *string

	// The robot software suite (ROS distribution) used by the robot application.
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The sources of the robot application.
	Sources []types.Source

	// The version of the robot application.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateSimulationApplicationInput

type UpdateSimulationApplicationInput struct {

	// The application information for the simulation application.
	//
	// This member is required.
	Application *string

	// Information about the robot software suite (ROS distribution).
	//
	// This member is required.
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The simulation software suite used by the simulation application.
	//
	// This member is required.
	SimulationSoftwareSuite *types.SimulationSoftwareSuite

	// The sources of the simulation application.
	//
	// This member is required.
	Sources []types.SourceConfig

	// The revision id for the robot application.
	CurrentRevisionId *string

	// The rendering engine for the simulation application.
	RenderingEngine *types.RenderingEngine
}

type UpdateSimulationApplicationOutput

type UpdateSimulationApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the updated simulation application.
	Arn *string

	// The time, in milliseconds since the epoch, when the simulation application was
	// last updated.
	LastUpdatedAt *time.Time

	// The name of the simulation application.
	Name *string

	// The rendering engine for the simulation application.
	RenderingEngine *types.RenderingEngine

	// The revision id of the simulation application.
	RevisionId *string

	// Information about the robot software suite (ROS distribution).
	RobotSoftwareSuite *types.RobotSoftwareSuite

	// The simulation software suite used by the simulation application.
	SimulationSoftwareSuite *types.SimulationSoftwareSuite

	// The sources of the simulation application.
	Sources []types.Source

	// The version of the robot application.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateWorldTemplateInput added in v0.29.0

type UpdateWorldTemplateInput struct {

	// The Amazon Resource Name (arn) of the world template to update.
	//
	// This member is required.
	Template *string

	// The name of the template.
	Name *string

	// The world template body.
	TemplateBody *string

	// The location of the world template.
	TemplateLocation *types.TemplateLocation
}

type UpdateWorldTemplateOutput added in v0.29.0

type UpdateWorldTemplateOutput struct {

	// The Amazon Resource Name (arn) of the world template.
	Arn *string

	// The time, in milliseconds since the epoch, when the world template was created.
	CreatedAt *time.Time

	// The time, in milliseconds since the epoch, when the world template was last
	// updated.
	LastUpdatedAt *time.Time

	// The name of the world template.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL