universal-s3
Version:
Universal S3 SDK for JavaScript, available for Node.js backends
1,235 lines (1,234 loc) • 89 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class RoboMaker extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: RoboMaker.Types.ClientConfiguration)
config: Config & RoboMaker.Types.ClientConfiguration;
/**
* Describes one or more simulation jobs.
*/
batchDescribeSimulationJob(params: RoboMaker.Types.BatchDescribeSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.BatchDescribeSimulationJobResponse) => void): Request<RoboMaker.Types.BatchDescribeSimulationJobResponse, AWSError>;
/**
* Describes one or more simulation jobs.
*/
batchDescribeSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.BatchDescribeSimulationJobResponse) => void): Request<RoboMaker.Types.BatchDescribeSimulationJobResponse, AWSError>;
/**
* Cancels the specified deployment job.
*/
cancelDeploymentJob(params: RoboMaker.Types.CancelDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CancelDeploymentJobResponse) => void): Request<RoboMaker.Types.CancelDeploymentJobResponse, AWSError>;
/**
* Cancels the specified deployment job.
*/
cancelDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.CancelDeploymentJobResponse) => void): Request<RoboMaker.Types.CancelDeploymentJobResponse, AWSError>;
/**
* Cancels the specified simulation job.
*/
cancelSimulationJob(params: RoboMaker.Types.CancelSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request<RoboMaker.Types.CancelSimulationJobResponse, AWSError>;
/**
* Cancels the specified simulation job.
*/
cancelSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request<RoboMaker.Types.CancelSimulationJobResponse, AWSError>;
/**
* Deploys a specific version of a robot application to robots in a fleet. The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version. After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
*/
createDeploymentJob(params: RoboMaker.Types.CreateDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request<RoboMaker.Types.CreateDeploymentJobResponse, AWSError>;
/**
* Deploys a specific version of a robot application to robots in a fleet. The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version. After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
*/
createDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request<RoboMaker.Types.CreateDeploymentJobResponse, AWSError>;
/**
* Creates a fleet, a logical group of robots running the same robot application.
*/
createFleet(params: RoboMaker.Types.CreateFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request<RoboMaker.Types.CreateFleetResponse, AWSError>;
/**
* Creates a fleet, a logical group of robots running the same robot application.
*/
createFleet(callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request<RoboMaker.Types.CreateFleetResponse, AWSError>;
/**
* Creates a robot.
*/
createRobot(params: RoboMaker.Types.CreateRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request<RoboMaker.Types.CreateRobotResponse, AWSError>;
/**
* Creates a robot.
*/
createRobot(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request<RoboMaker.Types.CreateRobotResponse, AWSError>;
/**
* Creates a robot application.
*/
createRobotApplication(params: RoboMaker.Types.CreateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationResponse, AWSError>;
/**
* Creates a robot application.
*/
createRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationResponse, AWSError>;
/**
* Creates a version of a robot application.
*/
createRobotApplicationVersion(params: RoboMaker.Types.CreateRobotApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationVersionResponse, AWSError>;
/**
* Creates a version of a robot application.
*/
createRobotApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationVersionResponse, AWSError>;
/**
* Creates a simulation application.
*/
createSimulationApplication(params: RoboMaker.Types.CreateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationResponse, AWSError>;
/**
* Creates a simulation application.
*/
createSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationResponse, AWSError>;
/**
* Creates a simulation application with a specific revision id.
*/
createSimulationApplicationVersion(params: RoboMaker.Types.CreateSimulationApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationVersionResponse, AWSError>;
/**
* Creates a simulation application with a specific revision id.
*/
createSimulationApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationVersionResponse, AWSError>;
/**
* Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
*/
createSimulationJob(params: RoboMaker.Types.CreateSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request<RoboMaker.Types.CreateSimulationJobResponse, AWSError>;
/**
* Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
*/
createSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request<RoboMaker.Types.CreateSimulationJobResponse, AWSError>;
/**
* Deletes a fleet.
*/
deleteFleet(params: RoboMaker.Types.DeleteFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request<RoboMaker.Types.DeleteFleetResponse, AWSError>;
/**
* Deletes a fleet.
*/
deleteFleet(callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request<RoboMaker.Types.DeleteFleetResponse, AWSError>;
/**
* Deletes a robot.
*/
deleteRobot(params: RoboMaker.Types.DeleteRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request<RoboMaker.Types.DeleteRobotResponse, AWSError>;
/**
* Deletes a robot.
*/
deleteRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request<RoboMaker.Types.DeleteRobotResponse, AWSError>;
/**
* Deletes a robot application.
*/
deleteRobotApplication(params: RoboMaker.Types.DeleteRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request<RoboMaker.Types.DeleteRobotApplicationResponse, AWSError>;
/**
* Deletes a robot application.
*/
deleteRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request<RoboMaker.Types.DeleteRobotApplicationResponse, AWSError>;
/**
* Deletes a simulation application.
*/
deleteSimulationApplication(params: RoboMaker.Types.DeleteSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request<RoboMaker.Types.DeleteSimulationApplicationResponse, AWSError>;
/**
* Deletes a simulation application.
*/
deleteSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request<RoboMaker.Types.DeleteSimulationApplicationResponse, AWSError>;
/**
* Deregisters a robot.
*/
deregisterRobot(params: RoboMaker.Types.DeregisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request<RoboMaker.Types.DeregisterRobotResponse, AWSError>;
/**
* Deregisters a robot.
*/
deregisterRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request<RoboMaker.Types.DeregisterRobotResponse, AWSError>;
/**
* Describes a deployment job.
*/
describeDeploymentJob(params: RoboMaker.Types.DescribeDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request<RoboMaker.Types.DescribeDeploymentJobResponse, AWSError>;
/**
* Describes a deployment job.
*/
describeDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request<RoboMaker.Types.DescribeDeploymentJobResponse, AWSError>;
/**
* Describes a fleet.
*/
describeFleet(params: RoboMaker.Types.DescribeFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request<RoboMaker.Types.DescribeFleetResponse, AWSError>;
/**
* Describes a fleet.
*/
describeFleet(callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request<RoboMaker.Types.DescribeFleetResponse, AWSError>;
/**
* Describes a robot.
*/
describeRobot(params: RoboMaker.Types.DescribeRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request<RoboMaker.Types.DescribeRobotResponse, AWSError>;
/**
* Describes a robot.
*/
describeRobot(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request<RoboMaker.Types.DescribeRobotResponse, AWSError>;
/**
* Describes a robot application.
*/
describeRobotApplication(params: RoboMaker.Types.DescribeRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request<RoboMaker.Types.DescribeRobotApplicationResponse, AWSError>;
/**
* Describes a robot application.
*/
describeRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request<RoboMaker.Types.DescribeRobotApplicationResponse, AWSError>;
/**
* Describes a simulation application.
*/
describeSimulationApplication(params: RoboMaker.Types.DescribeSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request<RoboMaker.Types.DescribeSimulationApplicationResponse, AWSError>;
/**
* Describes a simulation application.
*/
describeSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request<RoboMaker.Types.DescribeSimulationApplicationResponse, AWSError>;
/**
* Describes a simulation job.
*/
describeSimulationJob(params: RoboMaker.Types.DescribeSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobResponse, AWSError>;
/**
* Describes a simulation job.
*/
describeSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobResponse, AWSError>;
/**
* Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
*/
listDeploymentJobs(params: RoboMaker.Types.ListDeploymentJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request<RoboMaker.Types.ListDeploymentJobsResponse, AWSError>;
/**
* Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
*/
listDeploymentJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request<RoboMaker.Types.ListDeploymentJobsResponse, AWSError>;
/**
* Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
*/
listFleets(params: RoboMaker.Types.ListFleetsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request<RoboMaker.Types.ListFleetsResponse, AWSError>;
/**
* Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
*/
listFleets(callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request<RoboMaker.Types.ListFleetsResponse, AWSError>;
/**
* Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
*/
listRobotApplications(params: RoboMaker.Types.ListRobotApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request<RoboMaker.Types.ListRobotApplicationsResponse, AWSError>;
/**
* Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
*/
listRobotApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request<RoboMaker.Types.ListRobotApplicationsResponse, AWSError>;
/**
* Returns a list of robots. You can optionally provide filters to retrieve specific robots.
*/
listRobots(params: RoboMaker.Types.ListRobotsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request<RoboMaker.Types.ListRobotsResponse, AWSError>;
/**
* Returns a list of robots. You can optionally provide filters to retrieve specific robots.
*/
listRobots(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request<RoboMaker.Types.ListRobotsResponse, AWSError>;
/**
* Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
*/
listSimulationApplications(params: RoboMaker.Types.ListSimulationApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request<RoboMaker.Types.ListSimulationApplicationsResponse, AWSError>;
/**
* Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
*/
listSimulationApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request<RoboMaker.Types.ListSimulationApplicationsResponse, AWSError>;
/**
* Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
*/
listSimulationJobs(params: RoboMaker.Types.ListSimulationJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request<RoboMaker.Types.ListSimulationJobsResponse, AWSError>;
/**
* Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
*/
listSimulationJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request<RoboMaker.Types.ListSimulationJobsResponse, AWSError>;
/**
* Lists all tags on a AWS RoboMaker resource.
*/
listTagsForResource(params: RoboMaker.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request<RoboMaker.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all tags on a AWS RoboMaker resource.
*/
listTagsForResource(callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request<RoboMaker.Types.ListTagsForResourceResponse, AWSError>;
/**
* Registers a robot with a fleet.
*/
registerRobot(params: RoboMaker.Types.RegisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request<RoboMaker.Types.RegisterRobotResponse, AWSError>;
/**
* Registers a robot with a fleet.
*/
registerRobot(callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request<RoboMaker.Types.RegisterRobotResponse, AWSError>;
/**
* Restarts a running simulation job.
*/
restartSimulationJob(params: RoboMaker.Types.RestartSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request<RoboMaker.Types.RestartSimulationJobResponse, AWSError>;
/**
* Restarts a running simulation job.
*/
restartSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request<RoboMaker.Types.RestartSimulationJobResponse, AWSError>;
/**
* Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
*/
syncDeploymentJob(params: RoboMaker.Types.SyncDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request<RoboMaker.Types.SyncDeploymentJobResponse, AWSError>;
/**
* Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
*/
syncDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request<RoboMaker.Types.SyncDeploymentJobResponse, AWSError>;
/**
* Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
*/
tagResource(params: RoboMaker.Types.TagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request<RoboMaker.Types.TagResourceResponse, AWSError>;
/**
* Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
*/
tagResource(callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request<RoboMaker.Types.TagResourceResponse, AWSError>;
/**
* 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 .
*/
untagResource(params: RoboMaker.Types.UntagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request<RoboMaker.Types.UntagResourceResponse, AWSError>;
/**
* 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 .
*/
untagResource(callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request<RoboMaker.Types.UntagResourceResponse, AWSError>;
/**
* Updates a robot application.
*/
updateRobotApplication(params: RoboMaker.Types.UpdateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request<RoboMaker.Types.UpdateRobotApplicationResponse, AWSError>;
/**
* Updates a robot application.
*/
updateRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request<RoboMaker.Types.UpdateRobotApplicationResponse, AWSError>;
/**
* Updates a simulation application.
*/
updateSimulationApplication(params: RoboMaker.Types.UpdateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request<RoboMaker.Types.UpdateSimulationApplicationResponse, AWSError>;
/**
* Updates a simulation application.
*/
updateSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request<RoboMaker.Types.UpdateSimulationApplicationResponse, AWSError>;
}
declare namespace RoboMaker {
export type Architecture = "X86_64"|"ARM64"|"ARMHF"|string;
export type Arn = string;
export type Arns = Arn[];
export interface BatchDescribeSimulationJobRequest {
/**
* A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
*/
jobs: Arns;
}
export interface BatchDescribeSimulationJobResponse {
/**
* A list of simulation jobs.
*/
jobs?: SimulationJobs;
/**
* A list of unprocessed simulation job Amazon Resource Names (ARNs).
*/
unprocessedJobs?: Arns;
}
export type Boolean = boolean;
export type BoxedBoolean = boolean;
export interface CancelDeploymentJobRequest {
/**
* The deployment job ARN to cancel.
*/
job: Arn;
}
export interface CancelDeploymentJobResponse {
}
export interface CancelSimulationJobRequest {
/**
* The simulation job ARN to cancel.
*/
job: Arn;
}
export interface CancelSimulationJobResponse {
}
export type ClientRequestToken = string;
export type Command = string;
export interface CreateDeploymentJobRequest {
/**
* The requested deployment configuration.
*/
deploymentConfig?: DeploymentConfig;
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientRequestToken: ClientRequestToken;
/**
* The Amazon Resource Name (ARN) of the fleet to deploy.
*/
fleet: Arn;
/**
* The deployment application configuration.
*/
deploymentApplicationConfigs: DeploymentApplicationConfigs;
/**
* A map that contains tag keys and tag values that are attached to the deployment job.
*/
tags?: TagMap;
}
export interface CreateDeploymentJobResponse {
/**
* The Amazon Resource Name (ARN) of the deployment job.
*/
arn?: Arn;
/**
* The target fleet for the deployment job.
*/
fleet?: Arn;
/**
* The status of the deployment job.
*/
status?: DeploymentStatus;
/**
* The deployment application configuration.
*/
deploymentApplicationConfigs?: DeploymentApplicationConfigs;
/**
* The failure reason of the deployment job if it failed.
*/
failureReason?: GenericString;
/**
* 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. 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?: DeploymentJobErrorCode;
/**
* The time, in milliseconds since the epoch, when the fleet was created.
*/
createdAt?: CreatedAt;
/**
* The deployment configuration.
*/
deploymentConfig?: DeploymentConfig;
/**
* The list of all tags added to the deployment job.
*/
tags?: TagMap;
}
export interface CreateFleetRequest {
/**
* The name of the fleet.
*/
name: Name;
/**
* A map that contains tag keys and tag values that are attached to the fleet.
*/
tags?: TagMap;
}
export interface CreateFleetResponse {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
arn?: Arn;
/**
* The name of the fleet.
*/
name?: Name;
/**
* The time, in milliseconds since the epoch, when the fleet was created.
*/
createdAt?: CreatedAt;
/**
* The list of all tags added to the fleet.
*/
tags?: TagMap;
}
export interface CreateRobotApplicationRequest {
/**
* The name of the robot application.
*/
name: Name;
/**
* The sources of the robot application.
*/
sources: SourceConfigs;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite: RobotSoftwareSuite;
/**
* A map that contains tag keys and tag values that are attached to the robot application.
*/
tags?: TagMap;
}
export interface CreateRobotApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
arn?: Arn;
/**
* The name of the robot application.
*/
name?: Name;
/**
* The version of the robot application.
*/
version?: Version;
/**
* The sources of the robot application.
*/
sources?: Sources;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The time, in milliseconds since the epoch, when the robot application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision id of the robot application.
*/
revisionId?: RevisionId;
/**
* The list of all tags added to the robot application.
*/
tags?: TagMap;
}
export interface CreateRobotApplicationVersionRequest {
/**
* The application information for the robot application.
*/
application: Arn;
/**
* 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?: RevisionId;
}
export interface CreateRobotApplicationVersionResponse {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
arn?: Arn;
/**
* The name of the robot application.
*/
name?: Name;
/**
* The version of the robot application.
*/
version?: Version;
/**
* The sources of the robot application.
*/
sources?: Sources;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The time, in milliseconds since the epoch, when the robot application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision id of the robot application.
*/
revisionId?: RevisionId;
}
export interface CreateRobotRequest {
/**
* The name for the robot.
*/
name: Name;
/**
* The target architecture of the robot.
*/
architecture: Architecture;
/**
* The Greengrass group id.
*/
greengrassGroupId: Id;
/**
* A map that contains tag keys and tag values that are attached to the robot.
*/
tags?: TagMap;
}
export interface CreateRobotResponse {
/**
* The Amazon Resource Name (ARN) of the robot.
*/
arn?: Arn;
/**
* The name of the robot.
*/
name?: Name;
/**
* The time, in milliseconds since the epoch, when the robot was created.
*/
createdAt?: CreatedAt;
/**
* The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
*/
greengrassGroupId?: Id;
/**
* The target architecture of the robot.
*/
architecture?: Architecture;
/**
* The list of all tags added to the robot.
*/
tags?: TagMap;
}
export interface CreateSimulationApplicationRequest {
/**
* The name of the simulation application.
*/
name: Name;
/**
* The sources of the simulation application.
*/
sources: SourceConfigs;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite: SimulationSoftwareSuite;
/**
* The robot software suite of the simulation application.
*/
robotSoftwareSuite: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* A map that contains tag keys and tag values that are attached to the simulation application.
*/
tags?: TagMap;
}
export interface CreateSimulationApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the simulation application.
*/
arn?: Arn;
/**
* The name of the simulation application.
*/
name?: Name;
/**
* The version of the simulation application.
*/
version?: Version;
/**
* The sources of the simulation application.
*/
sources?: Sources;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite?: SimulationSoftwareSuite;
/**
* Information about the robot software suite.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* The time, in milliseconds since the epoch, when the simulation application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision id of the simulation application.
*/
revisionId?: RevisionId;
/**
* The list of all tags added to the simulation application.
*/
tags?: TagMap;
}
export interface CreateSimulationApplicationVersionRequest {
/**
* The application information for the simulation application.
*/
application: Arn;
/**
* 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?: RevisionId;
}
export interface CreateSimulationApplicationVersionResponse {
/**
* The Amazon Resource Name (ARN) of the simulation application.
*/
arn?: Arn;
/**
* The name of the simulation application.
*/
name?: Name;
/**
* The version of the simulation application.
*/
version?: Version;
/**
* The sources of the simulation application.
*/
sources?: Sources;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite?: SimulationSoftwareSuite;
/**
* Information about the robot software suite.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* The time, in milliseconds since the epoch, when the simulation application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The revision ID of the simulation application.
*/
revisionId?: RevisionId;
}
export interface CreateSimulationJobRequest {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientRequestToken?: ClientRequestToken;
/**
* Location for output files generated by the simulation job.
*/
outputLocation?: OutputLocation;
/**
* The logging configuration.
*/
loggingConfig?: LoggingConfig;
/**
* 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.
*/
maxJobDurationInSeconds: JobDuration;
/**
* 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.
*/
iamRole: IamRole;
/**
* 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?: FailureBehavior;
/**
* The robot application to use in the simulation job.
*/
robotApplications?: RobotApplicationConfigs;
/**
* The simulation application to use in the simulation job.
*/
simulationApplications?: SimulationApplicationConfigs;
/**
* The data sources for the simulation job. There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
*/
dataSources?: DataSourceConfigs;
/**
* A map that contains tag keys and tag values that are attached to the simulation job.
*/
tags?: TagMap;
/**
* 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?: VPCConfig;
}
export interface CreateSimulationJobResponse {
/**
* The Amazon Resource Name (ARN) of the simulation job.
*/
arn?: Arn;
/**
* The status of the simulation job.
*/
status?: SimulationJobStatus;
/**
* The time, in milliseconds since the epoch, when the simulation job was last started.
*/
lastStartedAt?: LastStartedAt;
/**
* The time, in milliseconds since the epoch, when the simulation job was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* the failure behavior for the simulation job.
*/
failureBehavior?: 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?: SimulationJobErrorCode;
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientRequestToken?: ClientRequestToken;
/**
* Simulation job output files location.
*/
outputLocation?: OutputLocation;
/**
* The logging configuration.
*/
loggingConfig?: LoggingConfig;
/**
* The maximum simulation job duration in seconds.
*/
maxJobDurationInSeconds?: JobDuration;
/**
* The simulation job execution duration in milliseconds.
*/
simulationTimeMillis?: SimulationTimeMillis;
/**
* The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
*/
iamRole?: IamRole;
/**
* The robot application used by the simulation job.
*/
robotApplications?: RobotApplicationConfigs;
/**
* The simulation application used by the simulation job.
*/
simulationApplications?: SimulationApplicationConfigs;
/**
* The data sources for the simulation job.
*/
dataSources?: DataSources;
/**
* The list of all tags added to the simulation job.
*/
tags?: TagMap;
/**
* Information about the vpc configuration.
*/
vpcConfig?: VPCConfigResponse;
}
export type CreatedAt = Date;
export interface DataSource {
/**
* The name of the data source.
*/
name?: Name;
/**
* The S3 bucket where the data files are located.
*/
s3Bucket?: S3Bucket;
/**
* The list of S3 keys identifying the data source files.
*/
s3Keys?: S3KeyOutputs;
}
export interface DataSourceConfig {
/**
* The name of the data source.
*/
name: Name;
/**
* The S3 bucket where the data files are located.
*/
s3Bucket: S3Bucket;
/**
* The list of S3 keys identifying the data source files.
*/
s3Keys: S3Keys;
}
export type DataSourceConfigs = DataSourceConfig[];
export type DataSourceNames = Name[];
export type DataSources = DataSource[];
export interface DeleteFleetRequest {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet: Arn;
}
export interface DeleteFleetResponse {
}
export interface DeleteRobotApplicationRequest {
/**
* The Amazon Resource Name (ARN) of the the robot application.
*/
application: Arn;
/**
* The version of the robot application to delete.
*/
applicationVersion?: Version;
}
export interface DeleteRobotApplicationResponse {
}
export interface DeleteRobotRequest {
/**
* The Amazon Resource Name (ARN) of the robot.
*/
robot: Arn;
}
export interface DeleteRobotResponse {
}
export interface DeleteSimulationApplicationRequest {
/**
* The application information for the simulation application to delete.
*/
application: Arn;
/**
* The version of the simulation application to delete.
*/
applicationVersion?: Version;
}
export interface DeleteSimulationApplicationResponse {
}
export interface DeploymentApplicationConfig {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
application: Arn;
/**
* The version of the application.
*/
applicationVersion: DeploymentVersion;
/**
* The launch configuration.
*/
launchConfig: DeploymentLaunchConfig;
}
export type DeploymentApplicationConfigs = DeploymentApplicationConfig[];
export interface DeploymentConfig {
/**
* The percentage of robots receiving the deployment at the same time.
*/
concurrentDeploymentPercentage?: Percentage;
/**
* The percentage of deployments that need to fail before stopping deployment.
*/
failureThresholdPercentage?: Percentage;
/**
* The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
*/
robotDeploymentTimeoutInSeconds?: DeploymentTimeout;
}
export interface DeploymentJob {
/**
* The Amazon Resource Name (ARN) of the deployment job.
*/
arn?: Arn;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet?: Arn;
/**
* The status of the deployment job.
*/
status?: DeploymentStatus;
/**
* The deployment application configuration.
*/
deploymentApplicationConfigs?: DeploymentApplicationConfigs;
/**
* The deployment configuration.
*/
deploymentConfig?: DeploymentConfig;
/**
* A short description of the reason why the deployment job failed.
*/
failureReason?: GenericString;
/**
* The deployment job failure code.
*/
failureCode?: DeploymentJobErrorCode;
/**
* The time, in milliseconds since the epoch, when the deployment job was created.
*/
createdAt?: CreatedAt;
}
export type DeploymentJobErrorCode = "ResourceNotFound"|"EnvironmentSetupError"|"EtagMismatch"|"FailureThresholdBreached"|"RobotDeploymentAborted"|"RobotDeploymentNoResponse"|"RobotAgentConnectionTimeout"|"GreengrassDeploymentFailed"|"MissingRobotArchitecture"|"MissingRobotApplicationArchitecture"|"MissingRobotDeploymentResource"|"GreengrassGroupVersionDoesNotExist"|"ExtractingBundleFailure"|"PreLaunchFileFailure"|"PostLaunchFileFailure"|"BadPermissionError"|"InternalServerError"|string;
export type DeploymentJobs = DeploymentJob[];
export interface DeploymentLaunchConfig {
/**
* The package name.
*/
packageName: Command;
/**
* The deployment pre-launch file. This file will be executed prior to the launch file.
*/
preLaunchFile?: Path;
/**
* The launch file name.
*/
launchFile: Command;
/**
* The deployment post-launch file. This file will be executed after the launch file.
*/
postLaunchFile?: Path;
/**
* An array of key/value pairs specifying environment variables for the robot application
*/
environmentVariables?: EnvironmentVariableMap;
}
export type DeploymentStatus = "Pending"|"Preparing"|"InProgress"|"Failed"|"Succeeded"|"Canceled"|string;
export type DeploymentTimeout = number;
export type DeploymentVersion = string;
export interface DeregisterRobotRequest {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet: Arn;
/**
* The Amazon Resource Name (ARN) of the robot.
*/
robot: Arn;
}
export interface DeregisterRobotResponse {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet?: Arn;
/**
* The Amazon Resource Name (ARN) of the robot.
*/
robot?: Arn;
}
export interface DescribeDeploymentJobRequest {
/**
* The Amazon Resource Name (ARN) of the deployment job.
*/
job: Arn;
}
export interface DescribeDeploymentJobResponse {
/**
* The Amazon Resource Name (ARN) of the deployment job.
*/
arn?: Arn;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet?: Arn;
/**
* The status of the deployment job.
*/
status?: DeploymentStatus;
/**
* The deployment configuration.
*/
deploymentConfig?: DeploymentConfig;
/**
* The deployment application configuration.
*/
deploymentApplicationConfigs?: DeploymentApplicationConfigs;
/**
* A short description of the reason why the deployment job failed.
*/
failureReason?: GenericString;
/**
* The deployment job failure code.
*/
failureCode?: DeploymentJobErrorCode;
/**
* The time, in milliseconds since the epoch, when the deployment job was created.
*/
createdAt?: CreatedAt;
/**
* A list of robot deployment summaries.
*/
robotDeploymentSummary?: RobotDeploymentSummary;
/**
* The list of all tags added to the specified deployment job.
*/
tags?: TagMap;
}
export interface DescribeFleetRequest {
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleet: Arn;
}
export interface DescribeFleetResponse {
/**
* The name of the fleet.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
arn?: Arn;
/**
* A list of robots.
*/
robots?: Robots;
/**
* The time, in milliseconds since the epoch, when the fleet was created.
*/
createdAt?: CreatedAt;
/**
* The status of the last deployment.
*/
lastDeploymentStatus?: DeploymentStatus;
/**
* The Amazon Resource Name (ARN) of the last deployment job.
*/
lastDeploymentJob?: Arn;
/**
* The time of the last deployment.
*/
lastDeploymentTime?: CreatedAt;
/**
* The list of all tags added to the specified fleet.
*/
tags?: TagMap;
}
export interface DescribeRobotApplicationRequest {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
application: Arn;
/**
* The version of the robot application to describe.
*/
applicationVersion?: Version;
}
export interface DescribeRobotApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the robot application.
*/
arn?: Arn;
/**
* The name of the robot application.
*/
name?: Name;
/**
* The version of the robot application.
*/
version?: Version;
/**
* The sources of the robot application.
*/
sources?: Sources;
/**
* The robot software suite used by the robot application.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The revision id of the robot application.
*/
revisionId?: RevisionId;
/**
* The time, in milliseconds since the epoch, when the robot application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The list of all tags added to the specified robot application.
*/
tags?: TagMap;
}
export interface DescribeRobotRequest {
/**
* The Amazon Resource Name (ARN) of the robot to be described.
*/
robot: Arn;
}
export interface DescribeRobotResponse {
/**
* The Amazon Resource Name (ARN) of the robot.
*/
arn?: Arn;
/**
* The name of the robot.
*/
name?: Name;
/**
* The Amazon Resource Name (ARN) of the fleet.
*/
fleetArn?: Arn;
/**
* The status of the fleet.
*/
status?: RobotStatus;
/**
* The Greengrass group id.
*/
greengrassGroupId?: Id;
/**
* The time, in milliseconds since the epoch, when the robot was created.
*/
createdAt?: CreatedAt;
/**
* The target architecture of the robot application.
*/
architecture?: Architecture;
/**
* The Amazon Resource Name (ARN) of the last deployment job.
*/
lastDeploymentJob?: Arn;
/**
* The time of the last deployment job.
*/
lastDeploymentTime?: CreatedAt;
/**
* The list of all tags added to the specified robot.
*/
tags?: TagMap;
}
export interface DescribeSimulationApplicationRequest {
/**
* The application information for the simulation application.
*/
application: Arn;
/**
* The version of the simulation application to describe.
*/
applicationVersion?: Version;
}
export interface DescribeSimulationApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the robot simulation application.
*/
arn?: Arn;
/**
* The name of the simulation application.
*/
name?: Name;
/**
* The version of the simulation application.
*/
version?: Version;
/**
* The sources of the simulation application.
*/
sources?: Sources;
/**
* The simulation software suite used by the simulation application.
*/
simulationSoftwareSuite?: SimulationSoftwareSuite;
/**
* Information about the robot software suite.
*/
robotSoftwareSuite?: RobotSoftwareSuite;
/**
* The rendering engine for the simulation application.
*/
renderingEngine?: RenderingEngine;
/**
* The revision id of the simulation application.
*/
revisionId?: RevisionId;
/**
* The time, in milliseconds since the epoch, when the simulation application was last updated.
*/
lastUpdatedAt?: LastUpdatedAt;
/**
* The list of all tags added to the specified simulation application.
*/
tags?: TagMap;
}
export interface DescribeSimulationJobRequest {
/**
* The Amazon Resource Name (ARN) of the simulation job to be described.
*/
job: Arn;
}
export interface DescribeSimulationJobResponse {
/**
* The Amazon Resource Name (ARN) of the simulation job.
*/
arn?: Arn;
/**
* The name of the simulation job.
*/
name?: Name;
/**
* The status of the simulation job.
*/
status?: SimulationJobStatus;
/**
* The time, in milliseconds since the epoch, when the simulation job was last started.
*/