Class: Aws::RoboMaker::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-robomaker/client.rb

Overview

An API client for RoboMaker. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::RoboMaker::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::RoboMaker::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::RoboMaker::EndpointParameters`

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



434
435
436
 
# File 'lib/aws-sdk-robomaker/client.rb', line 434

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4417
4418
4419
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4417

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4420
4421
4422
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4420

def errors_module
  Errors
end

Instance Method Details

#batch_delete_worlds(params = {}) ⇒ Types::BatchDeleteWorldsResponse

Deletes one or more worlds in a batch operation.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_worlds({
  worlds: ["Arn"], # required
})

Response structure


resp.unprocessed_worlds #=> Array
resp.unprocessed_worlds[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :worlds (required, Array<String>) —

    A list of Amazon Resource Names (arns) that correspond to worlds to delete.

Returns:

See Also:



465
466
467
468
 
# File 'lib/aws-sdk-robomaker/client.rb', line 465

def batch_delete_worlds(params = {}, options = {})
  req = build_request(:batch_delete_worlds, params)
  req.send_request(options)
end

#batch_describe_simulation_job(params = {}) ⇒ Types::BatchDescribeSimulationJobResponse

Describes one or more simulation jobs.

Examples:

Request syntax with placeholder values


resp = client.batch_describe_simulation_job({
  jobs: ["Arn"], # required
})

Response structure


resp.jobs #=> Array
resp.jobs[0].arn #=> String
resp.jobs[0].name #=> String
resp.jobs[0].status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
resp.jobs[0].last_started_at #=> Time
resp.jobs[0].last_updated_at #=> Time
resp.jobs[0].failure_behavior #=> String, one of "Fail", "Continue"
resp.jobs[0].failure_code #=> String, one of "InternalServiceError", "RobotApplicationCrash", "SimulationApplicationCrash", "RobotApplicationHealthCheckFailure", "SimulationApplicationHealthCheckFailure", "BadPermissionsRobotApplication", "BadPermissionsSimulationApplication", "BadPermissionsS3Object", "BadPermissionsS3Output", "BadPermissionsCloudwatchLogs", "SubnetIpLimitExceeded", "ENILimitExceeded", "BadPermissionsUserCredentials", "InvalidBundleRobotApplication", "InvalidBundleSimulationApplication", "InvalidS3Resource", "ThrottlingError", "LimitExceeded", "MismatchedEtag", "RobotApplicationVersionMismatchedEtag", "SimulationApplicationVersionMismatchedEtag", "ResourceNotFound", "RequestThrottled", "BatchTimedOut", "BatchCanceled", "InvalidInput", "WrongRegionS3Bucket", "WrongRegionS3Output", "WrongRegionRobotApplication", "WrongRegionSimulationApplication", "UploadContentMismatchError"
resp.jobs[0].failure_reason #=> String
resp.jobs[0].client_request_token #=> String
resp.jobs[0].output_location.s3_bucket #=> String
resp.jobs[0].output_location.s3_prefix #=> String
resp.jobs[0].logging_config.record_all_ros_topics #=> Boolean
resp.jobs[0].max_job_duration_in_seconds #=> Integer
resp.jobs[0].simulation_time_millis #=> Integer
resp.jobs[0].iam_role #=> String
resp.jobs[0].robot_applications #=> Array
resp.jobs[0].robot_applications[0].application #=> String
resp.jobs[0].robot_applications[0].application_version #=> String
resp.jobs[0].robot_applications[0].launch_config.package_name #=> String
resp.jobs[0].robot_applications[0].launch_config.launch_file #=> String
resp.jobs[0].robot_applications[0].launch_config.environment_variables #=> Hash
resp.jobs[0].robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.jobs[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.jobs[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.jobs[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.jobs[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.jobs[0].robot_applications[0].launch_config.stream_ui #=> Boolean
resp.jobs[0].robot_applications[0].launch_config.command #=> Array
resp.jobs[0].robot_applications[0].launch_config.command[0] #=> String
resp.jobs[0].robot_applications[0].upload_configurations #=> Array
resp.jobs[0].robot_applications[0].upload_configurations[0].name #=> String
resp.jobs[0].robot_applications[0].upload_configurations[0].path #=> String
resp.jobs[0].robot_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.jobs[0].robot_applications[0].use_default_upload_configurations #=> Boolean
resp.jobs[0].robot_applications[0].tools #=> Array
resp.jobs[0].robot_applications[0].tools[0].stream_ui #=> Boolean
resp.jobs[0].robot_applications[0].tools[0].name #=> String
resp.jobs[0].robot_applications[0].tools[0].command #=> String
resp.jobs[0].robot_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.jobs[0].robot_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.jobs[0].robot_applications[0].use_default_tools #=> Boolean
resp.jobs[0].simulation_applications #=> Array
resp.jobs[0].simulation_applications[0].application #=> String
resp.jobs[0].simulation_applications[0].application_version #=> String
resp.jobs[0].simulation_applications[0].launch_config.package_name #=> String
resp.jobs[0].simulation_applications[0].launch_config.launch_file #=> String
resp.jobs[0].simulation_applications[0].launch_config.environment_variables #=> Hash
resp.jobs[0].simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.jobs[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.jobs[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.jobs[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.jobs[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.jobs[0].simulation_applications[0].launch_config.stream_ui #=> Boolean
resp.jobs[0].simulation_applications[0].launch_config.command #=> Array
resp.jobs[0].simulation_applications[0].launch_config.command[0] #=> String
resp.jobs[0].simulation_applications[0].upload_configurations #=> Array
resp.jobs[0].simulation_applications[0].upload_configurations[0].name #=> String
resp.jobs[0].simulation_applications[0].upload_configurations[0].path #=> String
resp.jobs[0].simulation_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.jobs[0].simulation_applications[0].world_configs #=> Array
resp.jobs[0].simulation_applications[0].world_configs[0].world #=> String
resp.jobs[0].simulation_applications[0].use_default_upload_configurations #=> Boolean
resp.jobs[0].simulation_applications[0].tools #=> Array
resp.jobs[0].simulation_applications[0].tools[0].stream_ui #=> Boolean
resp.jobs[0].simulation_applications[0].tools[0].name #=> String
resp.jobs[0].simulation_applications[0].tools[0].command #=> String
resp.jobs[0].simulation_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.jobs[0].simulation_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.jobs[0].simulation_applications[0].use_default_tools #=> Boolean
resp.jobs[0].data_sources #=> Array
resp.jobs[0].data_sources[0].name #=> String
resp.jobs[0].data_sources[0].s3_bucket #=> String
resp.jobs[0].data_sources[0].s3_keys #=> Array
resp.jobs[0].data_sources[0].s3_keys[0].s3_key #=> String
resp.jobs[0].data_sources[0].s3_keys[0].etag #=> String
resp.jobs[0].data_sources[0].type #=> String, one of "Prefix", "Archive", "File"
resp.jobs[0].data_sources[0].destination #=> String
resp.jobs[0].tags #=> Hash
resp.jobs[0].tags["TagKey"] #=> String
resp.jobs[0].vpc_config.subnets #=> Array
resp.jobs[0].vpc_config.subnets[0] #=> String
resp.jobs[0].vpc_config.security_groups #=> Array
resp.jobs[0].vpc_config.security_groups[0] #=> String
resp.jobs[0].vpc_config.vpc_id #=> String
resp.jobs[0].vpc_config.assign_public_ip #=> Boolean
resp.jobs[0].network_interface.network_interface_id #=> String
resp.jobs[0].network_interface.private_ip_address #=> String
resp.jobs[0].network_interface.public_ip_address #=> String
resp.jobs[0].compute.simulation_unit_limit #=> Integer
resp.jobs[0].compute.compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.jobs[0].compute.gpu_unit_limit #=> Integer
resp.unprocessed_jobs #=> Array
resp.unprocessed_jobs[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :jobs (required, Array<String>) —

    A list of Amazon Resource Names (ARNs) of simulation jobs to describe.

Returns:

See Also:



587
588
589
590
 
# File 'lib/aws-sdk-robomaker/client.rb', line 587

def batch_describe_simulation_job(params = {}, options = {})
  req = build_request(:batch_describe_simulation_job, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4390

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::RoboMaker')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-robomaker'
  context[:gem_version] = '1.71.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_deployment_job(params = {}) ⇒ Struct

Cancels the specified deployment job.

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Examples:

Request syntax with placeholder values


resp = client.cancel_deployment_job({
  job: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job (required, String) —

    The deployment job ARN to cancel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



612
613
614
615
 
# File 'lib/aws-sdk-robomaker/client.rb', line 612

def cancel_deployment_job(params = {}, options = {})
  req = build_request(:cancel_deployment_job, params)
  req.send_request(options)
end

#cancel_simulation_job(params = {}) ⇒ Struct

Cancels the specified simulation job.

Examples:

Request syntax with placeholder values


resp = client.cancel_simulation_job({
  job: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job (required, String) —

    The simulation job ARN to cancel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



634
635
636
637
 
# File 'lib/aws-sdk-robomaker/client.rb', line 634

def cancel_simulation_job(params = {}, options = {})
  req = build_request(:cancel_simulation_job, params)
  req.send_request(options)
end

#cancel_simulation_job_batch(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.cancel_simulation_job_batch({
  batch: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :batch (required, String) —

    The id of the batch to cancel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



658
659
660
661
 
# File 'lib/aws-sdk-robomaker/client.rb', line 658

def cancel_simulation_job_batch(params = {}, options = {})
  req = build_request(:cancel_simulation_job_batch, params)
  req.send_request(options)
end

#cancel_world_export_job(params = {}) ⇒ Struct

Cancels the specified export job.

Examples:

Request syntax with placeholder values


resp = client.cancel_world_export_job({
  job: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job (required, String) —

    The Amazon Resource Name (arn) of the world export job to cancel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



680
681
682
683
 
# File 'lib/aws-sdk-robomaker/client.rb', line 680

def cancel_world_export_job(params = {}, options = {})
  req = build_request(:cancel_world_export_job, params)
  req.send_request(options)
end

#cancel_world_generation_job(params = {}) ⇒ Struct

Cancels the specified world generator job.

Examples:

Request syntax with placeholder values


resp = client.cancel_world_generation_job({
  job: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job (required, String) —

    The Amazon Resource Name (arn) of the world generator job to cancel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



702
703
704
705
 
# File 'lib/aws-sdk-robomaker/client.rb', line 702

def cancel_world_generation_job(params = {}, options = {})
  req = build_request(:cancel_world_generation_job, params)
  req.send_request(options)
end

#create_deployment_job(params = {}) ⇒ Types::CreateDeploymentJobResponse

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

This API is no longer supported and will throw an error if used.

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

<note markdown=“1”> After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.

</note>

[1]: docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html

Examples:

Request syntax with placeholder values


resp = client.create_deployment_job({
  deployment_config: {
    concurrent_deployment_percentage: 1,
    failure_threshold_percentage: 1,
    robot_deployment_timeout_in_seconds: 1,
    download_condition_file: {
      bucket: "S3Bucket", # required
      key: "S3Key", # required
      etag: "S3Etag",
    },
  },
  client_request_token: "ClientRequestToken", # required
  fleet: "Arn", # required
  deployment_application_configs: [ # required
    {
      application: "Arn", # required
      application_version: "DeploymentVersion", # required
      launch_config: { # required
        package_name: "Command", # required
        pre_launch_file: "Path",
        launch_file: "Command", # required
        post_launch_file: "Path",
        environment_variables: {
          "EnvironmentVariableKey" => "EnvironmentVariableValue",
        },
      },
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.fleet #=> String
resp.status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded", "Canceled"
resp.deployment_application_configs #=> Array
resp.deployment_application_configs[0].application #=> String
resp.deployment_application_configs[0].application_version #=> String
resp.deployment_application_configs[0].launch_config.package_name #=> String
resp.deployment_application_configs[0].launch_config.pre_launch_file #=> String
resp.deployment_application_configs[0].launch_config.launch_file #=> String
resp.deployment_application_configs[0].launch_config.post_launch_file #=> String
resp.deployment_application_configs[0].launch_config.environment_variables #=> Hash
resp.deployment_application_configs[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.failure_reason #=> String
resp.failure_code #=> String, one of "ResourceNotFound", "EnvironmentSetupError", "EtagMismatch", "FailureThresholdBreached", "RobotDeploymentAborted", "RobotDeploymentNoResponse", "RobotAgentConnectionTimeout", "GreengrassDeploymentFailed", "InvalidGreengrassGroup", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "LambdaDeleted", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "DownloadConditionFailed", "BadLambdaAssociated", "InternalServerError", "RobotApplicationDoesNotExist", "DeploymentFleetDoesNotExist", "FleetDeploymentTimeout"
resp.created_at #=> Time
resp.deployment_config.concurrent_deployment_percentage #=> Integer
resp.deployment_config.failure_threshold_percentage #=> Integer
resp.deployment_config.robot_deployment_timeout_in_seconds #=> Integer
resp.deployment_config.download_condition_file.bucket #=> String
resp.deployment_config.download_condition_file.key #=> String
resp.deployment_config.download_condition_file.etag #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :deployment_config (Types::DeploymentConfig) —

    The requested deployment configuration.

  • :client_request_token (required, String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :fleet (required, String) —

    The Amazon Resource Name (ARN) of the fleet to deploy.

  • :deployment_application_configs (required, Array<Types::DeploymentApplicationConfig>) —

    The deployment application configuration.

  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the deployment job.

Returns:

See Also:



823
824
825
826
 
# File 'lib/aws-sdk-robomaker/client.rb', line 823

def create_deployment_job(params = {}, options = {})
  req = build_request(:create_deployment_job, params)
  req.send_request(options)
end

#create_fleet(params = {}) ⇒ Types::CreateFleetResponse

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

This API is no longer supported and will throw an error if used.

Examples:

Request syntax with placeholder values


resp = client.create_fleet({
  name: "Name", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.created_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the fleet.

  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the fleet.

Returns:

See Also:



868
869
870
871
 
# File 'lib/aws-sdk-robomaker/client.rb', line 868

def create_fleet(params = {}, options = {})
  req = build_request(:create_fleet, params)
  req.send_request(options)
end

#create_robot(params = {}) ⇒ Types::CreateRobotResponse

Creates a robot.

This API is no longer supported and will throw an error if used.

Examples:

Request syntax with placeholder values


resp = client.create_robot({
  name: "Name", # required
  architecture: "X86_64", # required, accepts X86_64, ARM64, ARMHF
  greengrass_group_id: "Id", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.created_at #=> Time
resp.greengrass_group_id #=> String
resp.architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name for the robot.

  • :architecture (required, String) —

    The target architecture of the robot.

  • :greengrass_group_id (required, String) —

    The Greengrass group id.

  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the robot.

Returns:

See Also:



924
925
926
927
 
# File 'lib/aws-sdk-robomaker/client.rb', line 924

def create_robot(params = {}, options = {})
  req = build_request(:create_robot, params)
  req.send_request(options)
end

#create_robot_application(params = {}) ⇒ Types::CreateRobotApplicationResponse

Creates a robot application.

Examples:

Request syntax with placeholder values


resp = client.create_robot_application({
  name: "Name", # required
  sources: [
    {
      s3_bucket: "S3Bucket",
      s3_key: "S3Key",
      architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
    },
  ],
  robot_software_suite: { # required
    name: "ROS", # accepts ROS, ROS2, General
    version: "Kinetic", # accepts Kinetic, Melodic, Dashing, Foxy
  },
  tags: {
    "TagKey" => "TagValue",
  },
  environment: {
    uri: "RepositoryUrl",
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version #=> String
resp.sources #=> Array
resp.sources[0].s3_bucket #=> String
resp.sources[0].s3_key #=> String
resp.sources[0].etag #=> String
resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.last_updated_at #=> Time
resp.revision_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.environment.uri #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the robot application.

  • :sources (Array<Types::SourceConfig>) —

    The sources of the robot application.

  • :robot_software_suite (required, Types::RobotSoftwareSuite) —

    The robot software suite (ROS distribuition) used by the robot application.

  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the robot application.

  • :environment (Types::Environment) —

    The object that contains that URI of the Docker image that you use for your robot application.

Returns:

See Also:



1006
1007
1008
1009
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1006

def create_robot_application(params = {}, options = {})
  req = build_request(:create_robot_application, params)
  req.send_request(options)
end

#create_robot_application_version(params = {}) ⇒ Types::CreateRobotApplicationVersionResponse

Creates a version of a robot application.

Examples:

Request syntax with placeholder values


resp = client.create_robot_application_version({
  application: "Arn", # required
  current_revision_id: "RevisionId",
  s3_etags: ["S3Etag"],
  image_digest: "ImageDigest",
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version #=> String
resp.sources #=> Array
resp.sources[0].s3_bucket #=> String
resp.sources[0].s3_key #=> String
resp.sources[0].etag #=> String
resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.last_updated_at #=> Time
resp.revision_id #=> String
resp.environment.uri #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application (required, String) —

    The application information for the robot application.

  • :current_revision_id (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.

  • :s3_etags (Array<String>) —

    The Amazon S3 identifier for the zip file bundle that you use for your robot application.

  • :image_digest (String) —

    A SHA256 identifier for the Docker image that you use for your robot application.

Returns:

See Also:



1069
1070
1071
1072
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1069

def create_robot_application_version(params = {}, options = {})
  req = build_request(:create_robot_application_version, params)
  req.send_request(options)
end

#create_simulation_application(params = {}) ⇒ Types::CreateSimulationApplicationResponse

Creates a simulation application.

Examples:

Request syntax with placeholder values


resp = client.create_simulation_application({
  name: "Name", # required
  sources: [
    {
      s3_bucket: "S3Bucket",
      s3_key: "S3Key",
      architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
    },
  ],
  simulation_software_suite: { # required
    name: "Gazebo", # accepts Gazebo, RosbagPlay, SimulationRuntime
    version: "SimulationSoftwareSuiteVersionType",
  },
  robot_software_suite: { # required
    name: "ROS", # accepts ROS, ROS2, General
    version: "Kinetic", # accepts Kinetic, Melodic, Dashing, Foxy
  },
  rendering_engine: {
    name: "OGRE", # accepts OGRE
    version: "RenderingEngineVersionType",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  environment: {
    uri: "RepositoryUrl",
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version #=> String
resp.sources #=> Array
resp.sources[0].s3_bucket #=> String
resp.sources[0].s3_key #=> String
resp.sources[0].etag #=> String
resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.simulation_software_suite.name #=> String, one of "Gazebo", "RosbagPlay", "SimulationRuntime"
resp.simulation_software_suite.version #=> String
resp.robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.rendering_engine.name #=> String, one of "OGRE"
resp.rendering_engine.version #=> String
resp.last_updated_at #=> Time
resp.revision_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.environment.uri #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the simulation application.

  • :sources (Array<Types::SourceConfig>) —

    The sources of the simulation application.

  • :simulation_software_suite (required, Types::SimulationSoftwareSuite) —

    The simulation software suite used by the simulation application.

  • :robot_software_suite (required, Types::RobotSoftwareSuite) —

    The robot software suite (ROS distribution) used by the simulation application.

  • :rendering_engine (Types::RenderingEngine) —

    The rendering engine for the simulation application.

  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the simulation application.

  • :environment (Types::Environment) —

    The object that contains the Docker image URI used to create your simulation application.

Returns:

See Also:



1171
1172
1173
1174
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1171

def create_simulation_application(params = {}, options = {})
  req = build_request(:create_simulation_application, params)
  req.send_request(options)
end

#create_simulation_application_version(params = {}) ⇒ Types::CreateSimulationApplicationVersionResponse

Creates a simulation application with a specific revision id.

Examples:

Request syntax with placeholder values


resp = client.create_simulation_application_version({
  application: "Arn", # required
  current_revision_id: "RevisionId",
  s3_etags: ["S3Etag"],
  image_digest: "ImageDigest",
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version #=> String
resp.sources #=> Array
resp.sources[0].s3_bucket #=> String
resp.sources[0].s3_key #=> String
resp.sources[0].etag #=> String
resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.simulation_software_suite.name #=> String, one of "Gazebo", "RosbagPlay", "SimulationRuntime"
resp.simulation_software_suite.version #=> String
resp.robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.rendering_engine.name #=> String, one of "OGRE"
resp.rendering_engine.version #=> String
resp.last_updated_at #=> Time
resp.revision_id #=> String
resp.environment.uri #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application (required, String) —

    The application information for the simulation application.

  • :current_revision_id (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.

  • :s3_etags (Array<String>) —

    The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application.

  • :image_digest (String) —

    The SHA256 digest used to identify the Docker image URI used to created the simulation application.

Returns:

See Also:



1240
1241
1242
1243
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1240

def create_simulation_application_version(params = {}, options = {})
  req = build_request(:create_simulation_application_version, params)
  req.send_request(options)
end

#create_simulation_job(params = {}) ⇒ Types::CreateSimulationJobResponse

Creates a simulation job.

<note markdown=“1”> After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.

</note>

Examples:

Request syntax with placeholder values


resp = client.create_simulation_job({
  client_request_token: "ClientRequestToken",
  output_location: {
    s3_bucket: "S3Bucket",
    s3_prefix: "S3Key",
  },
  logging_config: {
    record_all_ros_topics: false,
  },
  max_job_duration_in_seconds: 1, # required
  iam_role: "IamRole", # required
  failure_behavior: "Fail", # accepts Fail, Continue
  robot_applications: [
    {
      application: "Arn", # required
      application_version: "Version",
      launch_config: { # required
        package_name: "Command",
        launch_file: "Command",
        environment_variables: {
          "EnvironmentVariableKey" => "EnvironmentVariableValue",
        },
        port_forwarding_config: {
          port_mappings: [
            {
              job_port: 1, # required
              application_port: 1, # required
              enable_on_public_ip: false,
            },
          ],
        },
        stream_ui: false,
        command: ["NonEmptyString"],
      },
      upload_configurations: [
        {
          name: "Name", # required
          path: "Path", # required
          upload_behavior: "UPLOAD_ON_TERMINATE", # required, accepts UPLOAD_ON_TERMINATE, UPLOAD_ROLLING_AUTO_REMOVE
        },
      ],
      use_default_upload_configurations: false,
      tools: [
        {
          stream_ui: false,
          name: "Name", # required
          command: "UnrestrictedCommand", # required
          stream_output_to_cloud_watch: false,
          exit_behavior: "FAIL", # accepts FAIL, RESTART
        },
      ],
      use_default_tools: false,
    },
  ],
  simulation_applications: [
    {
      application: "Arn", # required
      application_version: "Version",
      launch_config: { # required
        package_name: "Command",
        launch_file: "Command",
        environment_variables: {
          "EnvironmentVariableKey" => "EnvironmentVariableValue",
        },
        port_forwarding_config: {
          port_mappings: [
            {
              job_port: 1, # required
              application_port: 1, # required
              enable_on_public_ip: false,
            },
          ],
        },
        stream_ui: false,
        command: ["NonEmptyString"],
      },
      upload_configurations: [
        {
          name: "Name", # required
          path: "Path", # required
          upload_behavior: "UPLOAD_ON_TERMINATE", # required, accepts UPLOAD_ON_TERMINATE, UPLOAD_ROLLING_AUTO_REMOVE
        },
      ],
      world_configs: [
        {
          world: "Arn",
        },
      ],
      use_default_upload_configurations: false,
      tools: [
        {
          stream_ui: false,
          name: "Name", # required
          command: "UnrestrictedCommand", # required
          stream_output_to_cloud_watch: false,
          exit_behavior: "FAIL", # accepts FAIL, RESTART
        },
      ],
      use_default_tools: false,
    },
  ],
  data_sources: [
    {
      name: "Name", # required
      s3_bucket: "S3Bucket", # required
      s3_keys: ["S3KeyOrPrefix"], # required
      type: "Prefix", # accepts Prefix, Archive, File
      destination: "Path",
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  vpc_config: {
    subnets: ["NonEmptyString"], # required
    security_groups: ["NonEmptyString"],
    assign_public_ip: false,
  },
  compute: {
    simulation_unit_limit: 1,
    compute_type: "CPU", # accepts CPU, GPU_AND_CPU
    gpu_unit_limit: 1,
  },
})

Response structure


resp.arn #=> String
resp.status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
resp.last_started_at #=> Time
resp.last_updated_at #=> Time
resp.failure_behavior #=> String, one of "Fail", "Continue"
resp.failure_code #=> String, one of "InternalServiceError", "RobotApplicationCrash", "SimulationApplicationCrash", "RobotApplicationHealthCheckFailure", "SimulationApplicationHealthCheckFailure", "BadPermissionsRobotApplication", "BadPermissionsSimulationApplication", "BadPermissionsS3Object", "BadPermissionsS3Output", "BadPermissionsCloudwatchLogs", "SubnetIpLimitExceeded", "ENILimitExceeded", "BadPermissionsUserCredentials", "InvalidBundleRobotApplication", "InvalidBundleSimulationApplication", "InvalidS3Resource", "ThrottlingError", "LimitExceeded", "MismatchedEtag", "RobotApplicationVersionMismatchedEtag", "SimulationApplicationVersionMismatchedEtag", "ResourceNotFound", "RequestThrottled", "BatchTimedOut", "BatchCanceled", "InvalidInput", "WrongRegionS3Bucket", "WrongRegionS3Output", "WrongRegionRobotApplication", "WrongRegionSimulationApplication", "UploadContentMismatchError"
resp.client_request_token #=> String
resp.output_location.s3_bucket #=> String
resp.output_location.s3_prefix #=> String
resp.logging_config.record_all_ros_topics #=> Boolean
resp.max_job_duration_in_seconds #=> Integer
resp.simulation_time_millis #=> Integer
resp.iam_role #=> String
resp.robot_applications #=> Array
resp.robot_applications[0].application #=> String
resp.robot_applications[0].application_version #=> String
resp.robot_applications[0].launch_config.package_name #=> String
resp.robot_applications[0].launch_config.launch_file #=> String
resp.robot_applications[0].launch_config.environment_variables #=> Hash
resp.robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.robot_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.robot_applications[0].launch_config.stream_ui #=> Boolean
resp.robot_applications[0].launch_config.command #=> Array
resp.robot_applications[0].launch_config.command[0] #=> String
resp.robot_applications[0].upload_configurations #=> Array
resp.robot_applications[0].upload_configurations[0].name #=> String
resp.robot_applications[0].upload_configurations[0].path #=> String
resp.robot_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.robot_applications[0].use_default_upload_configurations #=> Boolean
resp.robot_applications[0].tools #=> Array
resp.robot_applications[0].tools[0].stream_ui #=> Boolean
resp.robot_applications[0].tools[0].name #=> String
resp.robot_applications[0].tools[0].command #=> String
resp.robot_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.robot_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.robot_applications[0].use_default_tools #=> Boolean
resp.simulation_applications #=> Array
resp.simulation_applications[0].application #=> String
resp.simulation_applications[0].application_version #=> String
resp.simulation_applications[0].launch_config.package_name #=> String
resp.simulation_applications[0].launch_config.launch_file #=> String
resp.simulation_applications[0].launch_config.environment_variables #=> Hash
resp.simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.simulation_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.simulation_applications[0].launch_config.stream_ui #=> Boolean
resp.simulation_applications[0].launch_config.command #=> Array
resp.simulation_applications[0].launch_config.command[0] #=> String
resp.simulation_applications[0].upload_configurations #=> Array
resp.simulation_applications[0].upload_configurations[0].name #=> String
resp.simulation_applications[0].upload_configurations[0].path #=> String
resp.simulation_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.simulation_applications[0].world_configs #=> Array
resp.simulation_applications[0].world_configs[0].world #=> String
resp.simulation_applications[0].use_default_upload_configurations #=> Boolean
resp.simulation_applications[0].tools #=> Array
resp.simulation_applications[0].tools[0].stream_ui #=> Boolean
resp.simulation_applications[0].tools[0].name #=> String
resp.simulation_applications[0].tools[0].command #=> String
resp.simulation_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.simulation_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.simulation_applications[0].use_default_tools #=> Boolean
resp.data_sources #=> Array
resp.data_sources[0].name #=> String
resp.data_sources[0].s3_bucket #=> String
resp.data_sources[0].s3_keys #=> Array
resp.data_sources[0].s3_keys[0].s3_key #=> String
resp.data_sources[0].s3_keys[0].etag #=> String
resp.data_sources[0].type #=> String, one of "Prefix", "Archive", "File"
resp.data_sources[0].destination #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.vpc_config.subnets #=> Array
resp.vpc_config.subnets[0] #=> String
resp.vpc_config.security_groups #=> Array
resp.vpc_config.security_groups[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.vpc_config.assign_public_ip #=> Boolean
resp.compute.simulation_unit_limit #=> Integer
resp.compute.compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.compute.gpu_unit_limit #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_request_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :output_location (Types::OutputLocation) —

    Location for output files generated by the simulation job.

  • :logging_config (Types::LoggingConfig) —

    The logging configuration.

  • :max_job_duration_in_seconds (required, Integer) —

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

  • :iam_role (required, String) —

    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.

  • :failure_behavior (String) —

    The failure behavior the simulation job.

    Continue

    : Leaves the instance running for its maximum timeout duration after a

    `4XX` error code.

    Fail

    : Stop the simulation job and terminate the instance.

  • :robot_applications (Array<Types::RobotApplicationConfig>) —

    The robot application to use in the simulation job.

  • :simulation_applications (Array<Types::SimulationApplicationConfig>) —

    The simulation application to use in the simulation job.

  • :data_sources (Array<Types::DataSourceConfig>) —

    Specify data sources to mount read-only files from S3 into your simulation. These files are available under ‘/opt/robomaker/datasources/data_source_name`.

    <note markdown=“1”> There is a limit of 100 files and a combined size of 25GB for all ‘DataSourceConfig` objects.

    </note>
  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the simulation job.

  • :vpc_config (Types::VPCConfig) —

    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.

  • :compute (Types::Compute) —

    Compute information for the simulation job.

Returns:

See Also:



1557
1558
1559
1560
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1557

def create_simulation_job(params = {}, options = {})
  req = build_request(:create_simulation_job, params)
  req.send_request(options)
end

#create_world_export_job(params = {}) ⇒ Types::CreateWorldExportJobResponse

Creates a world export job.

Examples:

Request syntax with placeholder values


resp = client.create_world_export_job({
  client_request_token: "ClientRequestToken",
  worlds: ["Arn"], # required
  output_location: { # required
    s3_bucket: "S3Bucket",
    s3_prefix: "S3Key",
  },
  iam_role: "IamRole", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.status #=> String, one of "Pending", "Running", "Completed", "Failed", "Canceling", "Canceled"
resp.created_at #=> Time
resp.failure_code #=> String, one of "InternalServiceError", "LimitExceeded", "ResourceNotFound", "RequestThrottled", "InvalidInput", "AccessDenied"
resp.client_request_token #=> String
resp.output_location.s3_bucket #=> String
resp.output_location.s3_prefix #=> String
resp.iam_role #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_request_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :worlds (required, Array<String>) —

    A list of Amazon Resource Names (arns) that correspond to worlds to export.

  • :output_location (required, Types::OutputLocation) —

    The output location.

  • :iam_role (required, String) —

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

  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the world export job.

Returns:

See Also:



1629
1630
1631
1632
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1629

def create_world_export_job(params = {}, options = {})
  req = build_request(:create_world_export_job, params)
  req.send_request(options)
end

#create_world_generation_job(params = {}) ⇒ Types::CreateWorldGenerationJobResponse

Creates worlds using the specified template.

Examples:

Request syntax with placeholder values


resp = client.create_world_generation_job({
  client_request_token: "ClientRequestToken",
  template: "Arn", # required
  world_count: { # required
    floorplan_count: 1,
    interior_count_per_floorplan: 1,
  },
  tags: {
    "TagKey" => "TagValue",
  },
  world_tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.status #=> String, one of "Pending", "Running", "Completed", "Failed", "PartialFailed", "Canceling", "Canceled"
resp.created_at #=> Time
resp.failure_code #=> String, one of "InternalServiceError", "LimitExceeded", "ResourceNotFound", "RequestThrottled", "InvalidInput", "AllWorldGenerationFailed"
resp.client_request_token #=> String
resp.template #=> String
resp.world_count.floorplan_count #=> Integer
resp.world_count.interior_count_per_floorplan #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.world_tags #=> Hash
resp.world_tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_request_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :template (required, String) —

    The Amazon Resource Name (arn) of the world template describing the worlds you want to create.

  • :world_count (required, Types::WorldCount) —

    Information about the world count.

  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the world generator job.

  • :world_tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the generated worlds.

Returns:

See Also:



1706
1707
1708
1709
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1706

def create_world_generation_job(params = {}, options = {})
  req = build_request(:create_world_generation_job, params)
  req.send_request(options)
end

#create_world_template(params = {}) ⇒ Types::CreateWorldTemplateResponse

Creates a world template.

Examples:

Request syntax with placeholder values


resp = client.create_world_template({
  client_request_token: "ClientRequestToken",
  name: "TemplateName",
  template_body: "Json",
  template_location: {
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key", # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.client_request_token #=> String
resp.created_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_request_token (String) —

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

  • :name (String) —

    The name of the world template.

  • :template_body (String) —

    The world template body.

  • :template_location (Types::TemplateLocation) —

    The location of the world template.

  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the world template.

Returns:

See Also:



1766
1767
1768
1769
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1766

def create_world_template(params = {}, options = {})
  req = build_request(:create_world_template, params)
  req.send_request(options)
end

#delete_fleet(params = {}) ⇒ Struct

Deletes a fleet.

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Examples:

Request syntax with placeholder values


resp = client.delete_fleet({
  fleet: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :fleet (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1791
1792
1793
1794
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1791

def delete_fleet(params = {}, options = {})
  req = build_request(:delete_fleet, params)
  req.send_request(options)
end

#delete_robot(params = {}) ⇒ Struct

Deletes a robot.

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Examples:

Request syntax with placeholder values


resp = client.delete_robot({
  robot: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :robot (required, String) —

    The Amazon Resource Name (ARN) of the robot.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1816
1817
1818
1819
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1816

def delete_robot(params = {}, options = {})
  req = build_request(:delete_robot, params)
  req.send_request(options)
end

#delete_robot_application(params = {}) ⇒ Struct

Deletes a robot application.

Examples:

Request syntax with placeholder values


resp = client.delete_robot_application({
  application: "Arn", # required
  application_version: "Version",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application (required, String) —

    The Amazon Resource Name (ARN) of the the robot application.

  • :application_version (String) —

    The version of the robot application to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1842
1843
1844
1845
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1842

def delete_robot_application(params = {}, options = {})
  req = build_request(:delete_robot_application, params)
  req.send_request(options)
end

#delete_simulation_application(params = {}) ⇒ Struct

Deletes a simulation application.

Examples:

Request syntax with placeholder values


resp = client.delete_simulation_application({
  application: "Arn", # required
  application_version: "Version",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application (required, String) —

    The application information for the simulation application to delete.

  • :application_version (String) —

    The version of the simulation application to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1868
1869
1870
1871
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1868

def delete_simulation_application(params = {}, options = {})
  req = build_request(:delete_simulation_application, params)
  req.send_request(options)
end

#delete_world_template(params = {}) ⇒ Struct

Deletes a world template.

Examples:

Request syntax with placeholder values


resp = client.delete_world_template({
  template: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template (required, String) —

    The Amazon Resource Name (arn) of the world template you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1891
1892
1893
1894
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1891

def delete_world_template(params = {}, options = {})
  req = build_request(:delete_world_template, params)
  req.send_request(options)
end

#deregister_robot(params = {}) ⇒ Types::DeregisterRobotResponse

Deregisters a robot.

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Examples:

Request syntax with placeholder values


resp = client.deregister_robot({
  fleet: "Arn", # required
  robot: "Arn", # required
})

Response structure


resp.fleet #=> String
resp.robot #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :fleet (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

  • :robot (required, String) —

    The Amazon Resource Name (ARN) of the robot.

Returns:

See Also:



1928
1929
1930
1931
 
# File 'lib/aws-sdk-robomaker/client.rb', line 1928

def deregister_robot(params = {}, options = {})
  req = build_request(:deregister_robot, params)
  req.send_request(options)
end

#describe_deployment_job(params = {}) ⇒ Types::DescribeDeploymentJobResponse

Describes a deployment job.

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Examples:

Request syntax with placeholder values


resp = client.describe_deployment_job({
  job: "Arn", # required
})

Response structure


resp.arn #=> String
resp.fleet #=> String
resp.status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded", "Canceled"
resp.deployment_config.concurrent_deployment_percentage #=> Integer
resp.deployment_config.failure_threshold_percentage #=> Integer
resp.deployment_config.robot_deployment_timeout_in_seconds #=> Integer
resp.deployment_config.download_condition_file.bucket #=> String
resp.deployment_config.download_condition_file.key #=> String
resp.deployment_config.download_condition_file.etag #=> String
resp.deployment_application_configs #=> Array
resp.deployment_application_configs[0].application #=> String
resp.deployment_application_configs[0].application_version #=> String
resp.deployment_application_configs[0].launch_config.package_name #=> String
resp.deployment_application_configs[0].launch_config.pre_launch_file #=> String
resp.deployment_application_configs[0].launch_config.launch_file #=> String
resp.deployment_application_configs[0].launch_config.post_launch_file #=> String
resp.deployment_application_configs[0].launch_config.environment_variables #=> Hash
resp.deployment_application_configs[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.failure_reason #=> String
resp.failure_code #=> String, one of "ResourceNotFound", "EnvironmentSetupError", "EtagMismatch", "FailureThresholdBreached", "RobotDeploymentAborted", "RobotDeploymentNoResponse", "RobotAgentConnectionTimeout", "GreengrassDeploymentFailed", "InvalidGreengrassGroup", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "LambdaDeleted", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "DownloadConditionFailed", "BadLambdaAssociated", "InternalServerError", "RobotApplicationDoesNotExist", "DeploymentFleetDoesNotExist", "FleetDeploymentTimeout"
resp.created_at #=> Time
resp.robot_deployment_summary #=> Array
resp.robot_deployment_summary[0].arn #=> String
resp.robot_deployment_summary[0].deployment_start_time #=> Time
resp.robot_deployment_summary[0].deployment_finish_time #=> Time
resp.robot_deployment_summary[0].status #=> String, one of "Available", "Registered", "PendingNewDeployment", "Deploying", "Failed", "InSync", "NoResponse"
resp.robot_deployment_summary[0].progress_detail.current_progress #=> String, one of "Validating", "DownloadingExtracting", "ExecutingDownloadCondition", "ExecutingPreLaunch", "Launching", "ExecutingPostLaunch", "Finished"
resp.robot_deployment_summary[0].progress_detail.percent_done #=> Float
resp.robot_deployment_summary[0].progress_detail.estimated_time_remaining_seconds #=> Integer
resp.robot_deployment_summary[0].progress_detail.target_resource #=> String
resp.robot_deployment_summary[0].failure_reason #=> String
resp.robot_deployment_summary[0].failure_code #=> String, one of "ResourceNotFound", "EnvironmentSetupError", "EtagMismatch", "FailureThresholdBreached", "RobotDeploymentAborted", "RobotDeploymentNoResponse", "RobotAgentConnectionTimeout", "GreengrassDeploymentFailed", "InvalidGreengrassGroup", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "LambdaDeleted", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "DownloadConditionFailed", "BadLambdaAssociated", "InternalServerError", "RobotApplicationDoesNotExist", "DeploymentFleetDoesNotExist", "FleetDeploymentTimeout"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job (required, String) —

    The Amazon Resource Name (ARN) of the deployment job.

Returns:

See Also:



2001
2002
2003
2004
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2001

def describe_deployment_job(params = {}, options = {})
  req = build_request(:describe_deployment_job, params)
  req.send_request(options)
end

#describe_fleet(params = {}) ⇒ Types::DescribeFleetResponse

Describes a fleet.

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Examples:

Request syntax with placeholder values


resp = client.describe_fleet({
  fleet: "Arn", # required
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.robots #=> Array
resp.robots[0].arn #=> String
resp.robots[0].name #=> String
resp.robots[0].fleet_arn #=> String
resp.robots[0].status #=> String, one of "Available", "Registered", "PendingNewDeployment", "Deploying", "Failed", "InSync", "NoResponse"
resp.robots[0].green_grass_group_id #=> String
resp.robots[0].created_at #=> Time
resp.robots[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.robots[0].last_deployment_job #=> String
resp.robots[0].last_deployment_time #=> Time
resp.created_at #=> Time
resp.last_deployment_status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded", "Canceled"
resp.last_deployment_job #=> String
resp.last_deployment_time #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :fleet (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

Returns:

See Also:



2056
2057
2058
2059
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2056

def describe_fleet(params = {}, options = {})
  req = build_request(:describe_fleet, params)
  req.send_request(options)
end

#describe_robot(params = {}) ⇒ Types::DescribeRobotResponse

Describes a robot.

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Examples:

Request syntax with placeholder values


resp = client.describe_robot({
  robot: "Arn", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.fleet_arn #=> String
resp.status #=> String, one of "Available", "Registered", "PendingNewDeployment", "Deploying", "Failed", "InSync", "NoResponse"
resp.greengrass_group_id #=> String
resp.created_at #=> Time
resp.architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.last_deployment_job #=> String
resp.last_deployment_time #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :robot (required, String) —

    The Amazon Resource Name (ARN) of the robot to be described.

Returns:

See Also:



2106
2107
2108
2109
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2106

def describe_robot(params = {}, options = {})
  req = build_request(:describe_robot, params)
  req.send_request(options)
end

#describe_robot_application(params = {}) ⇒ Types::DescribeRobotApplicationResponse

Describes a robot application.

Examples:

Request syntax with placeholder values


resp = client.describe_robot_application({
  application: "Arn", # required
  application_version: "Version",
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version #=> String
resp.sources #=> Array
resp.sources[0].s3_bucket #=> String
resp.sources[0].s3_key #=> String
resp.sources[0].etag #=> String
resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.revision_id #=> String
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.environment.uri #=> String
resp.image_digest #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application (required, String) —

    The Amazon Resource Name (ARN) of the robot application.

  • :application_version (String) —

    The version of the robot application to describe.

Returns:

See Also:



2162
2163
2164
2165
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2162

def describe_robot_application(params = {}, options = {})
  req = build_request(:describe_robot_application, params)
  req.send_request(options)
end

#describe_simulation_application(params = {}) ⇒ Types::DescribeSimulationApplicationResponse

Describes a simulation application.

Examples:

Request syntax with placeholder values


resp = client.describe_simulation_application({
  application: "Arn", # required
  application_version: "Version",
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version #=> String
resp.sources #=> Array
resp.sources[0].s3_bucket #=> String
resp.sources[0].s3_key #=> String
resp.sources[0].etag #=> String
resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.simulation_software_suite.name #=> String, one of "Gazebo", "RosbagPlay", "SimulationRuntime"
resp.simulation_software_suite.version #=> String
resp.robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.rendering_engine.name #=> String, one of "OGRE"
resp.rendering_engine.version #=> String
resp.revision_id #=> String
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.environment.uri #=> String
resp.image_digest #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application (required, String) —

    The application information for the simulation application.

  • :application_version (String) —

    The version of the simulation application to describe.

Returns:

See Also:



2224
2225
2226
2227
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2224

def describe_simulation_application(params = {}, options = {})
  req = build_request(:describe_simulation_application, params)
  req.send_request(options)
end

#describe_simulation_job(params = {}) ⇒ Types::DescribeSimulationJobResponse

Describes a simulation job.

Examples:

Request syntax with placeholder values


resp = client.describe_simulation_job({
  job: "Arn", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
resp.last_started_at #=> Time
resp.last_updated_at #=> Time
resp.failure_behavior #=> String, one of "Fail", "Continue"
resp.failure_code #=> String, one of "InternalServiceError", "RobotApplicationCrash", "SimulationApplicationCrash", "RobotApplicationHealthCheckFailure", "SimulationApplicationHealthCheckFailure", "BadPermissionsRobotApplication", "BadPermissionsSimulationApplication", "BadPermissionsS3Object", "BadPermissionsS3Output", "BadPermissionsCloudwatchLogs", "SubnetIpLimitExceeded", "ENILimitExceeded", "BadPermissionsUserCredentials", "InvalidBundleRobotApplication", "InvalidBundleSimulationApplication", "InvalidS3Resource", "ThrottlingError", "LimitExceeded", "MismatchedEtag", "RobotApplicationVersionMismatchedEtag", "SimulationApplicationVersionMismatchedEtag", "ResourceNotFound", "RequestThrottled", "BatchTimedOut", "BatchCanceled", "InvalidInput", "WrongRegionS3Bucket", "WrongRegionS3Output", "WrongRegionRobotApplication", "WrongRegionSimulationApplication", "UploadContentMismatchError"
resp.failure_reason #=> String
resp.client_request_token #=> String
resp.output_location.s3_bucket #=> String
resp.output_location.s3_prefix #=> String
resp.logging_config.record_all_ros_topics #=> Boolean
resp.max_job_duration_in_seconds #=> Integer
resp.simulation_time_millis #=> Integer
resp.iam_role #=> String
resp.robot_applications #=> Array
resp.robot_applications[0].application #=> String
resp.robot_applications[0].application_version #=> String
resp.robot_applications[0].launch_config.package_name #=> String
resp.robot_applications[0].launch_config.launch_file #=> String
resp.robot_applications[0].launch_config.environment_variables #=> Hash
resp.robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.robot_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.robot_applications[0].launch_config.stream_ui #=> Boolean
resp.robot_applications[0].launch_config.command #=> Array
resp.robot_applications[0].launch_config.command[0] #=> String
resp.robot_applications[0].upload_configurations #=> Array
resp.robot_applications[0].upload_configurations[0].name #=> String
resp.robot_applications[0].upload_configurations[0].path #=> String
resp.robot_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.robot_applications[0].use_default_upload_configurations #=> Boolean
resp.robot_applications[0].tools #=> Array
resp.robot_applications[0].tools[0].stream_ui #=> Boolean
resp.robot_applications[0].tools[0].name #=> String
resp.robot_applications[0].tools[0].command #=> String
resp.robot_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.robot_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.robot_applications[0].use_default_tools #=> Boolean
resp.simulation_applications #=> Array
resp.simulation_applications[0].application #=> String
resp.simulation_applications[0].application_version #=> String
resp.simulation_applications[0].launch_config.package_name #=> String
resp.simulation_applications[0].launch_config.launch_file #=> String
resp.simulation_applications[0].launch_config.environment_variables #=> Hash
resp.simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.simulation_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.simulation_applications[0].launch_config.stream_ui #=> Boolean
resp.simulation_applications[0].launch_config.command #=> Array
resp.simulation_applications[0].launch_config.command[0] #=> String
resp.simulation_applications[0].upload_configurations #=> Array
resp.simulation_applications[0].upload_configurations[0].name #=> String
resp.simulation_applications[0].upload_configurations[0].path #=> String
resp.simulation_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.simulation_applications[0].world_configs #=> Array
resp.simulation_applications[0].world_configs[0].world #=> String
resp.simulation_applications[0].use_default_upload_configurations #=> Boolean
resp.simulation_applications[0].tools #=> Array
resp.simulation_applications[0].tools[0].stream_ui #=> Boolean
resp.simulation_applications[0].tools[0].name #=> String
resp.simulation_applications[0].tools[0].command #=> String
resp.simulation_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.simulation_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.simulation_applications[0].use_default_tools #=> Boolean
resp.data_sources #=> Array
resp.data_sources[0].name #=> String
resp.data_sources[0].s3_bucket #=> String
resp.data_sources[0].s3_keys #=> Array
resp.data_sources[0].s3_keys[0].s3_key #=> String
resp.data_sources[0].s3_keys[0].etag #=> String
resp.data_sources[0].type #=> String, one of "Prefix", "Archive", "File"
resp.data_sources[0].destination #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.vpc_config.subnets #=> Array
resp.vpc_config.subnets[0] #=> String
resp.vpc_config.security_groups #=> Array
resp.vpc_config.security_groups[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.vpc_config.assign_public_ip #=> Boolean
resp.network_interface.network_interface_id #=> String
resp.network_interface.private_ip_address #=> String
resp.network_interface.public_ip_address #=> String
resp.compute.simulation_unit_limit #=> Integer
resp.compute.compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.compute.gpu_unit_limit #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job (required, String) —

    The Amazon Resource Name (ARN) of the simulation job to be described.

Returns:

See Also:



2362
2363
2364
2365
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2362

def describe_simulation_job(params = {}, options = {})
  req = build_request(:describe_simulation_job, params)
  req.send_request(options)
end

#describe_simulation_job_batch(params = {}) ⇒ Types::DescribeSimulationJobBatchResponse

Describes a simulation job batch.

Examples:

Request syntax with placeholder values


resp = client.describe_simulation_job_batch({
  batch: "Arn", # required
})

Response structure


resp.arn #=> String
resp.status #=> String, one of "Pending", "InProgress", "Failed", "Completed", "Canceled", "Canceling", "Completing", "TimingOut", "TimedOut"
resp.last_updated_at #=> Time
resp.created_at #=> Time
resp.client_request_token #=> String
resp.batch_policy.timeout_in_seconds #=> Integer
resp.batch_policy.max_concurrency #=> Integer
resp.failure_code #=> String, one of "InternalServiceError"
resp.failure_reason #=> String
resp.failed_requests #=> Array
resp.failed_requests[0].request.output_location.s3_bucket #=> String
resp.failed_requests[0].request.output_location.s3_prefix #=> String
resp.failed_requests[0].request.logging_config.record_all_ros_topics #=> Boolean
resp.failed_requests[0].request.max_job_duration_in_seconds #=> Integer
resp.failed_requests[0].request.iam_role #=> String
resp.failed_requests[0].request.failure_behavior #=> String, one of "Fail", "Continue"
resp.failed_requests[0].request.use_default_applications #=> Boolean
resp.failed_requests[0].request.robot_applications #=> Array
resp.failed_requests[0].request.robot_applications[0].application #=> String
resp.failed_requests[0].request.robot_applications[0].application_version #=> String
resp.failed_requests[0].request.robot_applications[0].launch_config.package_name #=> String
resp.failed_requests[0].request.robot_applications[0].launch_config.launch_file #=> String
resp.failed_requests[0].request.robot_applications[0].launch_config.environment_variables #=> Hash
resp.failed_requests[0].request.robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.failed_requests[0].request.robot_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.failed_requests[0].request.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.failed_requests[0].request.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.failed_requests[0].request.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.failed_requests[0].request.robot_applications[0].launch_config.stream_ui #=> Boolean
resp.failed_requests[0].request.robot_applications[0].launch_config.command #=> Array
resp.failed_requests[0].request.robot_applications[0].launch_config.command[0] #=> String
resp.failed_requests[0].request.robot_applications[0].upload_configurations #=> Array
resp.failed_requests[0].request.robot_applications[0].upload_configurations[0].name #=> String
resp.failed_requests[0].request.robot_applications[0].upload_configurations[0].path #=> String
resp.failed_requests[0].request.robot_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.failed_requests[0].request.robot_applications[0].use_default_upload_configurations #=> Boolean
resp.failed_requests[0].request.robot_applications[0].tools #=> Array
resp.failed_requests[0].request.robot_applications[0].tools[0].stream_ui #=> Boolean
resp.failed_requests[0].request.robot_applications[0].tools[0].name #=> String
resp.failed_requests[0].request.robot_applications[0].tools[0].command #=> String
resp.failed_requests[0].request.robot_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.failed_requests[0].request.robot_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.failed_requests[0].request.robot_applications[0].use_default_tools #=> Boolean
resp.failed_requests[0].request.simulation_applications #=> Array
resp.failed_requests[0].request.simulation_applications[0].application #=> String
resp.failed_requests[0].request.simulation_applications[0].application_version #=> String
resp.failed_requests[0].request.simulation_applications[0].launch_config.package_name #=> String
resp.failed_requests[0].request.simulation_applications[0].launch_config.launch_file #=> String
resp.failed_requests[0].request.simulation_applications[0].launch_config.environment_variables #=> Hash
resp.failed_requests[0].request.simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.failed_requests[0].request.simulation_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.failed_requests[0].request.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.failed_requests[0].request.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.failed_requests[0].request.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].launch_config.stream_ui #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].launch_config.command #=> Array
resp.failed_requests[0].request.simulation_applications[0].launch_config.command[0] #=> String
resp.failed_requests[0].request.simulation_applications[0].upload_configurations #=> Array
resp.failed_requests[0].request.simulation_applications[0].upload_configurations[0].name #=> String
resp.failed_requests[0].request.simulation_applications[0].upload_configurations[0].path #=> String
resp.failed_requests[0].request.simulation_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.failed_requests[0].request.simulation_applications[0].world_configs #=> Array
resp.failed_requests[0].request.simulation_applications[0].world_configs[0].world #=> String
resp.failed_requests[0].request.simulation_applications[0].use_default_upload_configurations #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].tools #=> Array
resp.failed_requests[0].request.simulation_applications[0].tools[0].stream_ui #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].tools[0].name #=> String
resp.failed_requests[0].request.simulation_applications[0].tools[0].command #=> String
resp.failed_requests[0].request.simulation_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.failed_requests[0].request.simulation_applications[0].use_default_tools #=> Boolean
resp.failed_requests[0].request.data_sources #=> Array
resp.failed_requests[0].request.data_sources[0].name #=> String
resp.failed_requests[0].request.data_sources[0].s3_bucket #=> String
resp.failed_requests[0].request.data_sources[0].s3_keys #=> Array
resp.failed_requests[0].request.data_sources[0].s3_keys[0] #=> String
resp.failed_requests[0].request.data_sources[0].type #=> String, one of "Prefix", "Archive", "File"
resp.failed_requests[0].request.data_sources[0].destination #=> String
resp.failed_requests[0].request.vpc_config.subnets #=> Array
resp.failed_requests[0].request.vpc_config.subnets[0] #=> String
resp.failed_requests[0].request.vpc_config.security_groups #=> Array
resp.failed_requests[0].request.vpc_config.security_groups[0] #=> String
resp.failed_requests[0].request.vpc_config.assign_public_ip #=> Boolean
resp.failed_requests[0].request.compute.simulation_unit_limit #=> Integer
resp.failed_requests[0].request.compute.compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.failed_requests[0].request.compute.gpu_unit_limit #=> Integer
resp.failed_requests[0].request.tags #=> Hash
resp.failed_requests[0].request.tags["TagKey"] #=> String
resp.failed_requests[0].failure_reason #=> String
resp.failed_requests[0].failure_code #=> String, one of "InternalServiceError", "RobotApplicationCrash", "SimulationApplicationCrash", "RobotApplicationHealthCheckFailure", "SimulationApplicationHealthCheckFailure", "BadPermissionsRobotApplication", "BadPermissionsSimulationApplication", "BadPermissionsS3Object", "BadPermissionsS3Output", "BadPermissionsCloudwatchLogs", "SubnetIpLimitExceeded", "ENILimitExceeded", "BadPermissionsUserCredentials", "InvalidBundleRobotApplication", "InvalidBundleSimulationApplication", "InvalidS3Resource", "ThrottlingError", "LimitExceeded", "MismatchedEtag", "RobotApplicationVersionMismatchedEtag", "SimulationApplicationVersionMismatchedEtag", "ResourceNotFound", "RequestThrottled", "BatchTimedOut", "BatchCanceled", "InvalidInput", "WrongRegionS3Bucket", "WrongRegionS3Output", "WrongRegionRobotApplication", "WrongRegionSimulationApplication", "UploadContentMismatchError"
resp.failed_requests[0].failed_at #=> Time
resp.pending_requests #=> Array
resp.pending_requests[0].output_location.s3_bucket #=> String
resp.pending_requests[0].output_location.s3_prefix #=> String
resp.pending_requests[0].logging_config.record_all_ros_topics #=> Boolean
resp.pending_requests[0].max_job_duration_in_seconds #=> Integer
resp.pending_requests[0].iam_role #=> String
resp.pending_requests[0].failure_behavior #=> String, one of "Fail", "Continue"
resp.pending_requests[0].use_default_applications #=> Boolean
resp.pending_requests[0].robot_applications #=> Array
resp.pending_requests[0].robot_applications[0].application #=> String
resp.pending_requests[0].robot_applications[0].application_version #=> String
resp.pending_requests[0].robot_applications[0].launch_config.package_name #=> String
resp.pending_requests[0].robot_applications[0].launch_config.launch_file #=> String
resp.pending_requests[0].robot_applications[0].launch_config.environment_variables #=> Hash
resp.pending_requests[0].robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.pending_requests[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.pending_requests[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.pending_requests[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.pending_requests[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.pending_requests[0].robot_applications[0].launch_config.stream_ui #=> Boolean
resp.pending_requests[0].robot_applications[0].launch_config.command #=> Array
resp.pending_requests[0].robot_applications[0].launch_config.command[0] #=> String
resp.pending_requests[0].robot_applications[0].upload_configurations #=> Array
resp.pending_requests[0].robot_applications[0].upload_configurations[0].name #=> String
resp.pending_requests[0].robot_applications[0].upload_configurations[0].path #=> String
resp.pending_requests[0].robot_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.pending_requests[0].robot_applications[0].use_default_upload_configurations #=> Boolean
resp.pending_requests[0].robot_applications[0].tools #=> Array
resp.pending_requests[0].robot_applications[0].tools[0].stream_ui #=> Boolean
resp.pending_requests[0].robot_applications[0].tools[0].name #=> String
resp.pending_requests[0].robot_applications[0].tools[0].command #=> String
resp.pending_requests[0].robot_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.pending_requests[0].robot_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.pending_requests[0].robot_applications[0].use_default_tools #=> Boolean
resp.pending_requests[0].simulation_applications #=> Array
resp.pending_requests[0].simulation_applications[0].application #=> String
resp.pending_requests[0].simulation_applications[0].application_version #=> String
resp.pending_requests[0].simulation_applications[0].launch_config.package_name #=> String
resp.pending_requests[0].simulation_applications[0].launch_config.launch_file #=> String
resp.pending_requests[0].simulation_applications[0].launch_config.environment_variables #=> Hash
resp.pending_requests[0].simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.pending_requests[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.pending_requests[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.pending_requests[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.pending_requests[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.pending_requests[0].simulation_applications[0].launch_config.stream_ui #=> Boolean
resp.pending_requests[0].simulation_applications[0].launch_config.command #=> Array
resp.pending_requests[0].simulation_applications[0].launch_config.command[0] #=> String
resp.pending_requests[0].simulation_applications[0].upload_configurations #=> Array
resp.pending_requests[0].simulation_applications[0].upload_configurations[0].name #=> String
resp.pending_requests[0].simulation_applications[0].upload_configurations[0].path #=> String
resp.pending_requests[0].simulation_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.pending_requests[0].simulation_applications[0].world_configs #=> Array
resp.pending_requests[0].simulation_applications[0].world_configs[0].world #=> String
resp.pending_requests[0].simulation_applications[0].use_default_upload_configurations #=> Boolean
resp.pending_requests[0].simulation_applications[0].tools #=> Array
resp.pending_requests[0].simulation_applications[0].tools[0].stream_ui #=> Boolean
resp.pending_requests[0].simulation_applications[0].tools[0].name #=> String
resp.pending_requests[0].simulation_applications[0].tools[0].command #=> String
resp.pending_requests[0].simulation_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.pending_requests[0].simulation_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.pending_requests[0].simulation_applications[0].use_default_tools #=> Boolean
resp.pending_requests[0].data_sources #=> Array
resp.pending_requests[0].data_sources[0].name #=> String
resp.pending_requests[0].data_sources[0].s3_bucket #=> String
resp.pending_requests[0].data_sources[0].s3_keys #=> Array
resp.pending_requests[0].data_sources[0].s3_keys[0] #=> String
resp.pending_requests[0].data_sources[0].type #=> String, one of "Prefix", "Archive", "File"
resp.pending_requests[0].data_sources[0].destination #=> String
resp.pending_requests[0].vpc_config.subnets #=> Array
resp.pending_requests[0].vpc_config.subnets[0] #=> String
resp.pending_requests[0].vpc_config.security_groups #=> Array
resp.pending_requests[0].vpc_config.security_groups[0] #=> String
resp.pending_requests[0].vpc_config.assign_public_ip #=> Boolean
resp.pending_requests[0].compute.simulation_unit_limit #=> Integer
resp.pending_requests[0].compute.compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.pending_requests[0].compute.gpu_unit_limit #=> Integer
resp.pending_requests[0].tags #=> Hash
resp.pending_requests[0].tags["TagKey"] #=> String
resp.created_requests #=> Array
resp.created_requests[0].arn #=> String
resp.created_requests[0].last_updated_at #=> Time
resp.created_requests[0].name #=> String
resp.created_requests[0].status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
resp.created_requests[0].simulation_application_names #=> Array
resp.created_requests[0].simulation_application_names[0] #=> String
resp.created_requests[0].robot_application_names #=> Array
resp.created_requests[0].robot_application_names[0] #=> String
resp.created_requests[0].data_source_names #=> Array
resp.created_requests[0].data_source_names[0] #=> String
resp.created_requests[0].compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :batch (required, String) —

    The id of the batch to describe.

Returns:

See Also:



2584
2585
2586
2587
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2584

def describe_simulation_job_batch(params = {}, options = {})
  req = build_request(:describe_simulation_job_batch, params)
  req.send_request(options)
end

#describe_world(params = {}) ⇒ Types::DescribeWorldResponse

Describes a world.

Examples:

Request syntax with placeholder values


resp = client.describe_world({
  world: "Arn", # required
})

Response structure


resp.arn #=> String
resp.generation_job #=> String
resp.template #=> String
resp.created_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.world_description_body #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :world (required, String) —

    The Amazon Resource Name (arn) of the world you want to describe.

Returns:

See Also:



2623
2624
2625
2626
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2623

def describe_world(params = {}, options = {})
  req = build_request(:describe_world, params)
  req.send_request(options)
end

#describe_world_export_job(params = {}) ⇒ Types::DescribeWorldExportJobResponse

Describes a world export job.

Examples:

Request syntax with placeholder values


resp = client.describe_world_export_job({
  job: "Arn", # required
})

Response structure


resp.arn #=> String
resp.status #=> String, one of "Pending", "Running", "Completed", "Failed", "Canceling", "Canceled"
resp.created_at #=> Time
resp.failure_code #=> String, one of "InternalServiceError", "LimitExceeded", "ResourceNotFound", "RequestThrottled", "InvalidInput", "AccessDenied"
resp.failure_reason #=> String
resp.client_request_token #=> String
resp.worlds #=> Array
resp.worlds[0] #=> String
resp.output_location.s3_bucket #=> String
resp.output_location.s3_prefix #=> String
resp.iam_role #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job (required, String) —

    The Amazon Resource Name (arn) of the world export job to describe.

Returns:

See Also:



2672
2673
2674
2675
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2672

def describe_world_export_job(params = {}, options = {})
  req = build_request(:describe_world_export_job, params)
  req.send_request(options)
end

#describe_world_generation_job(params = {}) ⇒ Types::DescribeWorldGenerationJobResponse

Describes a world generation job.

Examples:

Request syntax with placeholder values


resp = client.describe_world_generation_job({
  job: "Arn", # required
})

Response structure


resp.arn #=> String
resp.status #=> String, one of "Pending", "Running", "Completed", "Failed", "PartialFailed", "Canceling", "Canceled"
resp.created_at #=> Time
resp.failure_code #=> String, one of "InternalServiceError", "LimitExceeded", "ResourceNotFound", "RequestThrottled", "InvalidInput", "AllWorldGenerationFailed"
resp.failure_reason #=> String
resp.client_request_token #=> String
resp.template #=> String
resp.world_count.floorplan_count #=> Integer
resp.world_count.interior_count_per_floorplan #=> Integer
resp.finished_worlds_summary.finished_count #=> Integer
resp.finished_worlds_summary.succeeded_worlds #=> Array
resp.finished_worlds_summary.succeeded_worlds[0] #=> String
resp.finished_worlds_summary.failure_summary.total_failure_count #=> Integer
resp.finished_worlds_summary.failure_summary.failures #=> Array
resp.finished_worlds_summary.failure_summary.failures[0].failure_code #=> String, one of "InternalServiceError", "LimitExceeded", "ResourceNotFound", "RequestThrottled", "InvalidInput", "AllWorldGenerationFailed"
resp.finished_worlds_summary.failure_summary.failures[0].sample_failure_reason #=> String
resp.finished_worlds_summary.failure_summary.failures[0].failure_count #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.world_tags #=> Hash
resp.world_tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job (required, String) —

    The Amazon Resource Name (arn) of the world generation job to describe.

Returns:

See Also:



2731
2732
2733
2734
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2731

def describe_world_generation_job(params = {}, options = {})
  req = build_request(:describe_world_generation_job, params)
  req.send_request(options)
end

#describe_world_template(params = {}) ⇒ Types::DescribeWorldTemplateResponse

Describes a world template.

Examples:

Request syntax with placeholder values


resp = client.describe_world_template({
  template: "Arn", # required
})

Response structure


resp.arn #=> String
resp.client_request_token #=> String
resp.name #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template (required, String) —

    The Amazon Resource Name (arn) of the world template you want to describe.

Returns:

See Also:



2773
2774
2775
2776
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2773

def describe_world_template(params = {}, options = {})
  req = build_request(:describe_world_template, params)
  req.send_request(options)
end

#get_world_template_body(params = {}) ⇒ Types::GetWorldTemplateBodyResponse

Gets the world template body.

Examples:

Request syntax with placeholder values


resp = client.get_world_template_body({
  template: "Arn",
  generation_job: "Arn",
})

Response structure


resp.template_body #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template (String) —

    The Amazon Resource Name (arn) of the world template.

  • :generation_job (String) —

    The Amazon Resource Name (arn) of the world generator job.

Returns:

See Also:



2805
2806
2807
2808
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2805

def get_world_template_body(params = {}, options = {})
  req = build_request(:get_world_template_body, params)
  req.send_request(options)
end

#list_deployment_jobs(params = {}) ⇒ Types::ListDeploymentJobsResponse

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

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_deployment_jobs({
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.deployment_jobs #=> Array
resp.deployment_jobs[0].arn #=> String
resp.deployment_jobs[0].fleet #=> String
resp.deployment_jobs[0].status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded", "Canceled"
resp.deployment_jobs[0].deployment_application_configs #=> Array
resp.deployment_jobs[0].deployment_application_configs[0].application #=> String
resp.deployment_jobs[0].deployment_application_configs[0].application_version #=> String
resp.deployment_jobs[0].deployment_application_configs[0].launch_config.package_name #=> String
resp.deployment_jobs[0].deployment_application_configs[0].launch_config.pre_launch_file #=> String
resp.deployment_jobs[0].deployment_application_configs[0].launch_config.launch_file #=> String
resp.deployment_jobs[0].deployment_application_configs[0].launch_config.post_launch_file #=> String
resp.deployment_jobs[0].deployment_application_configs[0].launch_config.environment_variables #=> Hash
resp.deployment_jobs[0].deployment_application_configs[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.deployment_jobs[0].deployment_config.concurrent_deployment_percentage #=> Integer
resp.deployment_jobs[0].deployment_config.failure_threshold_percentage #=> Integer
resp.deployment_jobs[0].deployment_config.robot_deployment_timeout_in_seconds #=> Integer
resp.deployment_jobs[0].deployment_config.download_condition_file.bucket #=> String
resp.deployment_jobs[0].deployment_config.download_condition_file.key #=> String
resp.deployment_jobs[0].deployment_config.download_condition_file.etag #=> String
resp.deployment_jobs[0].failure_reason #=> String
resp.deployment_jobs[0].failure_code #=> String, one of "ResourceNotFound", "EnvironmentSetupError", "EtagMismatch", "FailureThresholdBreached", "RobotDeploymentAborted", "RobotDeploymentNoResponse", "RobotAgentConnectionTimeout", "GreengrassDeploymentFailed", "InvalidGreengrassGroup", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "LambdaDeleted", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "DownloadConditionFailed", "BadLambdaAssociated", "InternalServerError", "RobotApplicationDoesNotExist", "DeploymentFleetDoesNotExist", "FleetDeploymentTimeout"
resp.deployment_jobs[0].created_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

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

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

Returns:

See Also:



2892
2893
2894
2895
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2892

def list_deployment_jobs(params = {}, options = {})
  req = build_request(:list_deployment_jobs, params)
  req.send_request(options)
end

#list_fleets(params = {}) ⇒ Types::ListFleetsResponse

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

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_fleets({
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
})

Response structure


resp.fleet_details #=> Array
resp.fleet_details[0].name #=> String
resp.fleet_details[0].arn #=> String
resp.fleet_details[0].created_at #=> Time
resp.fleet_details[0].last_deployment_status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded", "Canceled"
resp.fleet_details[0].last_deployment_job #=> String
resp.fleet_details[0].last_deployment_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

    <note markdown=“1”> 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.

    </note>
  • :max_results (Integer) —

    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.

  • :filters (Array<Types::Filter>) —

    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.

Returns:

See Also:



2967
2968
2969
2970
 
# File 'lib/aws-sdk-robomaker/client.rb', line 2967

def list_fleets(params = {}, options = {})
  req = build_request(:list_fleets, params)
  req.send_request(options)
end

#list_robot_applications(params = {}) ⇒ Types::ListRobotApplicationsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_robot_applications({
  version_qualifier: "VersionQualifier",
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
})

Response structure


resp.robot_application_summaries #=> Array
resp.robot_application_summaries[0].name #=> String
resp.robot_application_summaries[0].arn #=> String
resp.robot_application_summaries[0].version #=> String
resp.robot_application_summaries[0].last_updated_at #=> Time
resp.robot_application_summaries[0].robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.robot_application_summaries[0].robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :version_qualifier (String) —

    The version qualifier of the robot application.

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

  • :filters (Array<Types::Filter>) —

    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.

Returns:

See Also:



3037
3038
3039
3040
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3037

def list_robot_applications(params = {}, options = {})
  req = build_request(:list_robot_applications, params)
  req.send_request(options)
end

#list_robots(params = {}) ⇒ Types::ListRobotsResponse

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

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_robots({
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
})

Response structure


resp.robots #=> Array
resp.robots[0].arn #=> String
resp.robots[0].name #=> String
resp.robots[0].fleet_arn #=> String
resp.robots[0].status #=> String, one of "Available", "Registered", "PendingNewDeployment", "Deploying", "Failed", "InSync", "NoResponse"
resp.robots[0].green_grass_group_id #=> String
resp.robots[0].created_at #=> Time
resp.robots[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.robots[0].last_deployment_job #=> String
resp.robots[0].last_deployment_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

  • :filters (Array<Types::Filter>) —

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

Returns:

See Also:



3112
3113
3114
3115
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3112

def list_robots(params = {}, options = {})
  req = build_request(:list_robots, params)
  req.send_request(options)
end

#list_simulation_applications(params = {}) ⇒ Types::ListSimulationApplicationsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_simulation_applications({
  version_qualifier: "VersionQualifier",
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
})

Response structure


resp.simulation_application_summaries #=> Array
resp.simulation_application_summaries[0].name #=> String
resp.simulation_application_summaries[0].arn #=> String
resp.simulation_application_summaries[0].version #=> String
resp.simulation_application_summaries[0].last_updated_at #=> Time
resp.simulation_application_summaries[0].robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.simulation_application_summaries[0].robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.simulation_application_summaries[0].simulation_software_suite.name #=> String, one of "Gazebo", "RosbagPlay", "SimulationRuntime"
resp.simulation_application_summaries[0].simulation_software_suite.version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :version_qualifier (String) —

    The version qualifier of the simulation application.

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

  • :filters (Array<Types::Filter>) —

    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.

Returns:

See Also:



3185
3186
3187
3188
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3185

def list_simulation_applications(params = {}, options = {})
  req = build_request(:list_simulation_applications, params)
  req.send_request(options)
end

#list_simulation_job_batches(params = {}) ⇒ Types::ListSimulationJobBatchesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_simulation_job_batches({
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
})

Response structure


resp.simulation_job_batch_summaries #=> Array
resp.simulation_job_batch_summaries[0].arn #=> String
resp.simulation_job_batch_summaries[0].last_updated_at #=> Time
resp.simulation_job_batch_summaries[0].created_at #=> Time
resp.simulation_job_batch_summaries[0].status #=> String, one of "Pending", "InProgress", "Failed", "Completed", "Canceled", "Canceling", "Completing", "TimingOut", "TimedOut"
resp.simulation_job_batch_summaries[0].failed_request_count #=> Integer
resp.simulation_job_batch_summaries[0].pending_request_count #=> Integer
resp.simulation_job_batch_summaries[0].created_request_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

  • :filters (Array<Types::Filter>) —

    Optional filters to limit results.

Returns:

See Also:



3247
3248
3249
3250
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3247

def list_simulation_job_batches(params = {}, options = {})
  req = build_request(:list_simulation_job_batches, params)
  req.send_request(options)
end

#list_simulation_jobs(params = {}) ⇒ Types::ListSimulationJobsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_simulation_jobs({
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
})

Response structure


resp.simulation_job_summaries #=> Array
resp.simulation_job_summaries[0].arn #=> String
resp.simulation_job_summaries[0].last_updated_at #=> Time
resp.simulation_job_summaries[0].name #=> String
resp.simulation_job_summaries[0].status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
resp.simulation_job_summaries[0].simulation_application_names #=> Array
resp.simulation_job_summaries[0].simulation_application_names[0] #=> String
resp.simulation_job_summaries[0].robot_application_names #=> Array
resp.simulation_job_summaries[0].robot_application_names[0] #=> String
resp.simulation_job_summaries[0].data_source_names #=> Array
resp.simulation_job_summaries[0].data_source_names[0] #=> String
resp.simulation_job_summaries[0].compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

  • :filters (Array<Types::Filter>) —

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

Returns:

See Also:



3321
3322
3323
3324
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3321

def list_simulation_jobs(params = {}, options = {})
  req = build_request(:list_simulation_jobs, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags on a AWS RoboMaker resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.

Returns:

See Also:



3350
3351
3352
3353
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3350

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_world_export_jobs(params = {}) ⇒ Types::ListWorldExportJobsResponse

Lists world export jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_world_export_jobs({
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
})

Response structure


resp.world_export_job_summaries #=> Array
resp.world_export_job_summaries[0].arn #=> String
resp.world_export_job_summaries[0].status #=> String, one of "Pending", "Running", "Completed", "Failed", "Canceling", "Canceled"
resp.world_export_job_summaries[0].created_at #=> Time
resp.world_export_job_summaries[0].worlds #=> Array
resp.world_export_job_summaries[0].worlds[0] #=> String
resp.world_export_job_summaries[0].output_location.s3_bucket #=> String
resp.world_export_job_summaries[0].output_location.s3_prefix #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

  • :filters (Array<Types::Filter>) —

    Optional filters to limit results. You can use ‘generationJobId` and `templateId`.

Returns:

See Also:



3414
3415
3416
3417
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3414

def list_world_export_jobs(params = {}, options = {})
  req = build_request(:list_world_export_jobs, params)
  req.send_request(options)
end

#list_world_generation_jobs(params = {}) ⇒ Types::ListWorldGenerationJobsResponse

Lists world generator jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_world_generation_jobs({
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
})

Response structure


resp.world_generation_job_summaries #=> Array
resp.world_generation_job_summaries[0].arn #=> String
resp.world_generation_job_summaries[0].template #=> String
resp.world_generation_job_summaries[0].created_at #=> Time
resp.world_generation_job_summaries[0].status #=> String, one of "Pending", "Running", "Completed", "Failed", "PartialFailed", "Canceling", "Canceled"
resp.world_generation_job_summaries[0].world_count.floorplan_count #=> Integer
resp.world_generation_job_summaries[0].world_count.interior_count_per_floorplan #=> Integer
resp.world_generation_job_summaries[0].succeeded_world_count #=> Integer
resp.world_generation_job_summaries[0].failed_world_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

  • :filters (Array<Types::Filter>) —

    Optional filters to limit results. You can use ‘status` and `templateId`.

Returns:

See Also:



3480
3481
3482
3483
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3480

def list_world_generation_jobs(params = {}, options = {})
  req = build_request(:list_world_generation_jobs, params)
  req.send_request(options)
end

#list_world_templates(params = {}) ⇒ Types::ListWorldTemplatesResponse

Lists world templates.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_world_templates({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.template_summaries #=> Array
resp.template_summaries[0].arn #=> String
resp.template_summaries[0].created_at #=> Time
resp.template_summaries[0].last_updated_at #=> Time
resp.template_summaries[0].name #=> String
resp.template_summaries[0].version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

Returns:

See Also:



3532
3533
3534
3535
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3532

def list_world_templates(params = {}, options = {})
  req = build_request(:list_world_templates, params)
  req.send_request(options)
end

#list_worlds(params = {}) ⇒ Types::ListWorldsResponse

Lists worlds.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_worlds({
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
})

Response structure


resp.world_summaries #=> Array
resp.world_summaries[0].arn #=> String
resp.world_summaries[0].created_at #=> Time
resp.world_summaries[0].generation_job #=> String
resp.world_summaries[0].template #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

  • :filters (Array<Types::Filter>) —

    Optional filters to limit results. You can use ‘status`.

Returns:

See Also:



3592
3593
3594
3595
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3592

def list_worlds(params = {}, options = {})
  req = build_request(:list_worlds, params)
  req.send_request(options)
end

#register_robot(params = {}) ⇒ Types::RegisterRobotResponse

Registers a robot with a fleet.

This API is no longer supported and will throw an error if used.

Examples:

Request syntax with placeholder values


resp = client.register_robot({
  fleet: "Arn", # required
  robot: "Arn", # required
})

Response structure


resp.fleet #=> String
resp.robot #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :fleet (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

  • :robot (required, String) —

    The Amazon Resource Name (ARN) of the robot.

Returns:

See Also:



3628
3629
3630
3631
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3628

def register_robot(params = {}, options = {})
  req = build_request(:register_robot, params)
  req.send_request(options)
end

#restart_simulation_job(params = {}) ⇒ Struct

Restarts a running simulation job.

Examples:

Request syntax with placeholder values


resp = client.restart_simulation_job({
  job: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job (required, String) —

    The Amazon Resource Name (ARN) of the simulation job.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3650
3651
3652
3653
 
# File 'lib/aws-sdk-robomaker/client.rb', line 3650

def restart_simulation_job(params = {}, options = {})
  req = build_request(:restart_simulation_job, params)
  req.send_request(options)
end

#start_simulation_job_batch(params = {}) ⇒ Types::StartSimulationJobBatchResponse

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

Examples:

Request syntax with placeholder values


resp = client.start_simulation_job_batch({
  client_request_token: "ClientRequestToken",
  batch_policy: {
    timeout_in_seconds: 1,
    max_concurrency: 1,
  },
  create_simulation_job_requests: [ # required
    {
      output_location: {
        s3_bucket: "S3Bucket",
        s3_prefix: "S3Key",
      },
      logging_config: {
        record_all_ros_topics: false,
      },
      max_job_duration_in_seconds: 1, # required
      iam_role: "IamRole",
      failure_behavior: "Fail", # accepts Fail, Continue
      use_default_applications: false,
      robot_applications: [
        {
          application: "Arn", # required
          application_version: "Version",
          launch_config: { # required
            package_name: "Command",
            launch_file: "Command",
            environment_variables: {
              "EnvironmentVariableKey" => "EnvironmentVariableValue",
            },
            port_forwarding_config: {
              port_mappings: [
                {
                  job_port: 1, # required
                  application_port: 1, # required
                  enable_on_public_ip: false,
                },
              ],
            },
            stream_ui: false,
            command: ["NonEmptyString"],
          },
          upload_configurations: [
            {
              name: "Name", # required
              path: "Path", # required
              upload_behavior: "UPLOAD_ON_TERMINATE", # required, accepts UPLOAD_ON_TERMINATE, UPLOAD_ROLLING_AUTO_REMOVE
            },
          ],
          use_default_upload_configurations: false,
          tools: [
            {
              stream_ui: false,
              name: "Name", # required
              command: "UnrestrictedCommand", # required
              stream_output_to_cloud_watch: false,
              exit_behavior: "FAIL", # accepts FAIL, RESTART
            },
          ],
          use_default_tools: false,
        },
      ],
      simulation_applications: [
        {
          application: "Arn", # required
          application_version: "Version",
          launch_config: { # required
            package_name: "Command",
            launch_file: "Command",
            environment_variables: {
              "EnvironmentVariableKey" => "EnvironmentVariableValue",
            },
            port_forwarding_config: {
              port_mappings: [
                {
                  job_port: 1, # required
                  application_port: 1, # required
                  enable_on_public_ip: false,
                },
              ],
            },
            stream_ui: false,
            command: ["NonEmptyString"],
          },
          upload_configurations: [
            {
              name: "Name", # required
              path: "Path", # required
              upload_behavior: "UPLOAD_ON_TERMINATE", # required, accepts UPLOAD_ON_TERMINATE, UPLOAD_ROLLING_AUTO_REMOVE
            },
          ],
          world_configs: [
            {
              world: "Arn",
            },
          ],
          use_default_upload_configurations: false,
          tools: [
            {
              stream_ui: false,
              name: "Name", # required
              command: "UnrestrictedCommand", # required
              stream_output_to_cloud_watch: false,
              exit_behavior: "FAIL", # accepts FAIL, RESTART
            },
          ],
          use_default_tools: false,
        },
      ],
      data_sources: [
        {
          name: "Name", # required
          s3_bucket: "S3Bucket", # required
          s3_keys: ["S3KeyOrPrefix"], # required
          type: "Prefix", # accepts Prefix, Archive, File
          destination: "Path",
        },
      ],
      vpc_config: {
        subnets: ["NonEmptyString"], # required
        security_groups: ["NonEmptyString"],
        assign_public_ip: false,
      },
      compute: {
        simulation_unit_limit: 1,
        compute_type: "CPU", # accepts CPU, GPU_AND_CPU
        gpu_unit_limit: 1,
      },
      tags: {
        "TagKey" => "TagValue",
      },
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.status #=> String, one of "Pending", "InProgress", "Failed", "Completed", "Canceled", "Canceling", "Completing", "TimingOut", "TimedOut"
resp.created_at #=> Time
resp.client_request_token #=> String
resp.batch_policy.timeout_in_seconds #=> Integer
resp.batch_policy.max_concurrency #=> Integer
resp.failure_code #=> String, one of "InternalServiceError"
resp.failure_reason #=> String
resp.failed_requests #=> Array
resp.failed_requests[0].request.output_location.s3_bucket #=> String
resp.failed_requests[0].request.output_location.s3_prefix #=> String
resp.failed_requests[0].request.logging_config.record_all_ros_topics #=> Boolean
resp.failed_requests[0].request.max_job_duration_in_seconds #=> Integer
resp.failed_requests[0].request.iam_role #=> String
resp.failed_requests[0].request.failure_behavior #=> String, one of "Fail", "Continue"
resp.failed_requests[0].request.use_default_applications #=> Boolean
resp.failed_requests[0].request.robot_applications #=> Array
resp.failed_requests[0].request.robot_applications[0].application #=> String
resp.failed_requests[0].request.robot_applications[0].application_version #=> String
resp.failed_requests[0].request.robot_applications[0].launch_config.package_name #=> String
resp.failed_requests[0].request.robot_applications[0].launch_config.launch_file #=> String
resp.failed_requests[0].request.robot_applications[0].launch_config.environment_variables #=> Hash
resp.failed_requests[0].request.robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.failed_requests[0].request.robot_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.failed_requests[0].request.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.failed_requests[0].request.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.failed_requests[0].request.robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.failed_requests[0].request.robot_applications[0].launch_config.stream_ui #=> Boolean
resp.failed_requests[0].request.robot_applications[0].launch_config.command #=> Array
resp.failed_requests[0].request.robot_applications[0].launch_config.command[0] #=> String
resp.failed_requests[0].request.robot_applications[0].upload_configurations #=> Array
resp.failed_requests[0].request.robot_applications[0].upload_configurations[0].name #=> String
resp.failed_requests[0].request.robot_applications[0].upload_configurations[0].path #=> String
resp.failed_requests[0].request.robot_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.failed_requests[0].request.robot_applications[0].use_default_upload_configurations #=> Boolean
resp.failed_requests[0].request.robot_applications[0].tools #=> Array
resp.failed_requests[0].request.robot_applications[0].tools[0].stream_ui #=> Boolean
resp.failed_requests[0].request.robot_applications[0].tools[0].name #=> String
resp.failed_requests[0].request.robot_applications[0].tools[0].command #=> String
resp.failed_requests[0].request.robot_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.failed_requests[0].request.robot_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.failed_requests[0].request.robot_applications[0].use_default_tools #=> Boolean
resp.failed_requests[0].request.simulation_applications #=> Array
resp.failed_requests[0].request.simulation_applications[0].application #=> String
resp.failed_requests[0].request.simulation_applications[0].application_version #=> String
resp.failed_requests[0].request.simulation_applications[0].launch_config.package_name #=> String
resp.failed_requests[0].request.simulation_applications[0].launch_config.launch_file #=> String
resp.failed_requests[0].request.simulation_applications[0].launch_config.environment_variables #=> Hash
resp.failed_requests[0].request.simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.failed_requests[0].request.simulation_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.failed_requests[0].request.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.failed_requests[0].request.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.failed_requests[0].request.simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].launch_config.stream_ui #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].launch_config.command #=> Array
resp.failed_requests[0].request.simulation_applications[0].launch_config.command[0] #=> String
resp.failed_requests[0].request.simulation_applications[0].upload_configurations #=> Array
resp.failed_requests[0].request.simulation_applications[0].upload_configurations[0].name #=> String
resp.failed_requests[0].request.simulation_applications[0].upload_configurations[0].path #=> String
resp.failed_requests[0].request.simulation_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.failed_requests[0].request.simulation_applications[0].world_configs #=> Array
resp.failed_requests[0].request.simulation_applications[0].world_configs[0].world #=> String
resp.failed_requests[0].request.simulation_applications[0].use_default_upload_configurations #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].tools #=> Array
resp.failed_requests[0].request.simulation_applications[0].tools[0].stream_ui #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].tools[0].name #=> String
resp.failed_requests[0].request.simulation_applications[0].tools[0].command #=> String
resp.failed_requests[0].request.simulation_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.failed_requests[0].request.simulation_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.failed_requests[0].request.simulation_applications[0].use_default_tools #=> Boolean
resp.failed_requests[0].request.data_sources #=> Array
resp.failed_requests[0].request.data_sources[0].name #=> String
resp.failed_requests[0].request.data_sources[0].s3_bucket #=> String
resp.failed_requests[0].request.data_sources[0].s3_keys #=> Array
resp.failed_requests[0].request.data_sources[0].s3_keys[0] #=> String
resp.failed_requests[0].request.data_sources[0].type #=> String, one of "Prefix", "Archive", "File"
resp.failed_requests[0].request.data_sources[0].destination #=> String
resp.failed_requests[0].request.vpc_config.subnets #=> Array
resp.failed_requests[0].request.vpc_config.subnets[0] #=> String
resp.failed_requests[0].request.vpc_config.security_groups #=> Array
resp.failed_requests[0].request.vpc_config.security_groups[0] #=> String
resp.failed_requests[0].request.vpc_config.assign_public_ip #=> Boolean
resp.failed_requests[0].request.compute.simulation_unit_limit #=> Integer
resp.failed_requests[0].request.compute.compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.failed_requests[0].request.compute.gpu_unit_limit #=> Integer
resp.failed_requests[0].request.tags #=> Hash
resp.failed_requests[0].request.tags["TagKey"] #=> String
resp.failed_requests[0].failure_reason #=> String
resp.failed_requests[0].failure_code #=> String, one of "InternalServiceError", "RobotApplicationCrash", "SimulationApplicationCrash", "RobotApplicationHealthCheckFailure", "SimulationApplicationHealthCheckFailure", "BadPermissionsRobotApplication", "BadPermissionsSimulationApplication", "BadPermissionsS3Object", "BadPermissionsS3Output", "BadPermissionsCloudwatchLogs", "SubnetIpLimitExceeded", "ENILimitExceeded", "BadPermissionsUserCredentials", "InvalidBundleRobotApplication", "InvalidBundleSimulationApplication", "InvalidS3Resource", "ThrottlingError", "LimitExceeded", "MismatchedEtag", "RobotApplicationVersionMismatchedEtag", "SimulationApplicationVersionMismatchedEtag", "ResourceNotFound", "RequestThrottled", "BatchTimedOut", "BatchCanceled", "InvalidInput", "WrongRegionS3Bucket", "WrongRegionS3Output", "WrongRegionRobotApplication", "WrongRegionSimulationApplication", "UploadContentMismatchError"
resp.failed_requests[0].failed_at #=> Time
resp.pending_requests #=> Array
resp.pending_requests[0].output_location.s3_bucket #=> String
resp.pending_requests[0].output_location.s3_prefix #=> String
resp.pending_requests[0].logging_config.record_all_ros_topics #=> Boolean
resp.pending_requests[0].max_job_duration_in_seconds #=> Integer
resp.pending_requests[0].iam_role #=> String
resp.pending_requests[0].failure_behavior #=> String, one of "Fail", "Continue"
resp.pending_requests[0].use_default_applications #=> Boolean
resp.pending_requests[0].robot_applications #=> Array
resp.pending_requests[0].robot_applications[0].application #=> String
resp.pending_requests[0].robot_applications[0].application_version #=> String
resp.pending_requests[0].robot_applications[0].launch_config.package_name #=> String
resp.pending_requests[0].robot_applications[0].launch_config.launch_file #=> String
resp.pending_requests[0].robot_applications[0].launch_config.environment_variables #=> Hash
resp.pending_requests[0].robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.pending_requests[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.pending_requests[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.pending_requests[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.pending_requests[0].robot_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.pending_requests[0].robot_applications[0].launch_config.stream_ui #=> Boolean
resp.pending_requests[0].robot_applications[0].launch_config.command #=> Array
resp.pending_requests[0].robot_applications[0].launch_config.command[0] #=> String
resp.pending_requests[0].robot_applications[0].upload_configurations #=> Array
resp.pending_requests[0].robot_applications[0].upload_configurations[0].name #=> String
resp.pending_requests[0].robot_applications[0].upload_configurations[0].path #=> String
resp.pending_requests[0].robot_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.pending_requests[0].robot_applications[0].use_default_upload_configurations #=> Boolean
resp.pending_requests[0].robot_applications[0].tools #=> Array
resp.pending_requests[0].robot_applications[0].tools[0].stream_ui #=> Boolean
resp.pending_requests[0].robot_applications[0].tools[0].name #=> String
resp.pending_requests[0].robot_applications[0].tools[0].command #=> String
resp.pending_requests[0].robot_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.pending_requests[0].robot_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.pending_requests[0].robot_applications[0].use_default_tools #=> Boolean
resp.pending_requests[0].simulation_applications #=> Array
resp.pending_requests[0].simulation_applications[0].application #=> String
resp.pending_requests[0].simulation_applications[0].application_version #=> String
resp.pending_requests[0].simulation_applications[0].launch_config.package_name #=> String
resp.pending_requests[0].simulation_applications[0].launch_config.launch_file #=> String
resp.pending_requests[0].simulation_applications[0].launch_config.environment_variables #=> Hash
resp.pending_requests[0].simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.pending_requests[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings #=> Array
resp.pending_requests[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].job_port #=> Integer
resp.pending_requests[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].application_port #=> Integer
resp.pending_requests[0].simulation_applications[0].launch_config.port_forwarding_config.port_mappings[0].enable_on_public_ip #=> Boolean
resp.pending_requests[0].simulation_applications[0].launch_config.stream_ui #=> Boolean
resp.pending_requests[0].simulation_applications[0].launch_config.command #=> Array
resp.pending_requests[0].simulation_applications[0].launch_config.command[0] #=> String
resp.pending_requests[0].simulation_applications[0].upload_configurations #=> Array
resp.pending_requests[0].simulation_applications[0].upload_configurations[0].name #=> String
resp.pending_requests[0].simulation_applications[0].upload_configurations[0].path #=> String
resp.pending_requests[0].simulation_applications[0].upload_configurations[0].upload_behavior #=> String, one of "UPLOAD_ON_TERMINATE", "UPLOAD_ROLLING_AUTO_REMOVE"
resp.pending_requests[0].simulation_applications[0].world_configs #=> Array
resp.pending_requests[0].simulation_applications[0].world_configs[0].world #=> String
resp.pending_requests[0].simulation_applications[0].use_default_upload_configurations #=> Boolean
resp.pending_requests[0].simulation_applications[0].tools #=> Array
resp.pending_requests[0].simulation_applications[0].tools[0].stream_ui #=> Boolean
resp.pending_requests[0].simulation_applications[0].tools[0].name #=> String
resp.pending_requests[0].simulation_applications[0].tools[0].command #=> String
resp.pending_requests[0].simulation_applications[0].tools[0].stream_output_to_cloud_watch #=> Boolean
resp.pending_requests[0].simulation_applications[0].tools[0].exit_behavior #=> String, one of "FAIL", "RESTART"
resp.pending_requests[0].simulation_applications[0].use_default_tools #=> Boolean
resp.pending_requests[0].data_sources #=> Array
resp.pending_requests[0].data_sources[0].name #=> String
resp.pending_requests[0].data_sources[0].s3_bucket #=> String
resp.pending_requests[0].data_sources[0].s3_keys #=> Array
resp.pending_requests[0].data_sources[0].s3_keys[0] #=> String
resp.pending_requests[0].data_sources[0].type #=> String, one of "Prefix", "Archive", "File"
resp.pending_requests[0].data_sources[0].destination #=> String
resp.pending_requests[0].vpc_config.subnets #=> Array
resp.pending_requests[0].vpc_config.subnets[0] #=> String
resp.pending_requests[0].vpc_config.security_groups #=> Array
resp.pending_requests[0].vpc_config.security_groups[0] #=> String
resp.pending_requests[0].vpc_config.assign_public_ip #=> Boolean
resp.pending_requests[0].compute.simulation_unit_limit #=> Integer
resp.pending_requests[0].compute.compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.pending_requests[0].compute.gpu_unit_limit #=> Integer
resp.pending_requests[0].tags #=> Hash
resp.pending_requests[0].tags["TagKey"] #=> String
resp.created_requests #=> Array
resp.created_requests[0].arn #=> String
resp.created_requests[0].last_updated_at #=> Time
resp.created_requests[0].name #=> String
resp.created_requests[0].status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
resp.created_requests[0].simulation_application_names #=> Array
resp.created_requests[0].simulation_application_names[0] #=> String
resp.created_requests[0].robot_application_names #=> Array
resp.created_requests[0].robot_application_names[0] #=> String
resp.created_requests[0].data_source_names #=> Array
resp.created_requests[0].data_source_names[0] #=> String
resp.created_requests[0].compute_type #=> String, one of "CPU", "GPU_AND_CPU"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_request_token (String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :batch_policy (Types::BatchPolicy) —

    The batch policy.

  • :create_simulation_job_requests (required, Array<Types::SimulationJobRequest>) —

    A list of simulation job requests to create in the batch.

  • :tags (Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the deployment job batch.

Returns:

See Also:



4018
4019
4020
4021
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4018

def start_simulation_job_batch(params = {}, options = {})
  req = build_request(:start_simulation_job_batch, params)
  req.send_request(options)
end

#sync_deployment_job(params = {}) ⇒ Types::SyncDeploymentJobResponse

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

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

Examples:

Request syntax with placeholder values


resp = client.sync_deployment_job({
  client_request_token: "ClientRequestToken", # required
  fleet: "Arn", # required
})

Response structure


resp.arn #=> String
resp.fleet #=> String
resp.status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded", "Canceled"
resp.deployment_config.concurrent_deployment_percentage #=> Integer
resp.deployment_config.failure_threshold_percentage #=> Integer
resp.deployment_config.robot_deployment_timeout_in_seconds #=> Integer
resp.deployment_config.download_condition_file.bucket #=> String
resp.deployment_config.download_condition_file.key #=> String
resp.deployment_config.download_condition_file.etag #=> String
resp.deployment_application_configs #=> Array
resp.deployment_application_configs[0].application #=> String
resp.deployment_application_configs[0].application_version #=> String
resp.deployment_application_configs[0].launch_config.package_name #=> String
resp.deployment_application_configs[0].launch_config.pre_launch_file #=> String
resp.deployment_application_configs[0].launch_config.launch_file #=> String
resp.deployment_application_configs[0].launch_config.post_launch_file #=> String
resp.deployment_application_configs[0].launch_config.environment_variables #=> Hash
resp.deployment_application_configs[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
resp.failure_reason #=> String
resp.failure_code #=> String, one of "ResourceNotFound", "EnvironmentSetupError", "EtagMismatch", "FailureThresholdBreached", "RobotDeploymentAborted", "RobotDeploymentNoResponse", "RobotAgentConnectionTimeout", "GreengrassDeploymentFailed", "InvalidGreengrassGroup", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "LambdaDeleted", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "DownloadConditionFailed", "BadLambdaAssociated", "InternalServerError", "RobotApplicationDoesNotExist", "DeploymentFleetDoesNotExist", "FleetDeploymentTimeout"
resp.created_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_request_token (required, String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :fleet (required, String) —

    The target fleet for the synchronization.

Returns:

See Also:



4085
4086
4087
4088
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4085

def sync_deployment_job(params = {}, options = {})
  req = build_request(:sync_deployment_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.

  • :tags (required, Hash<String,String>) —

    A map that contains tag keys and tag values that are attached to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4126
4127
4128
4129
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4126

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

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` ][1].

[1]: docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.

  • :tag_keys (required, Array<String>) —

    A map that contains tag keys and tag values that will be unattached from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4161
4162
4163
4164
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4161

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_robot_application(params = {}) ⇒ Types::UpdateRobotApplicationResponse

Updates a robot application.

Examples:

Request syntax with placeholder values


resp = client.update_robot_application({
  application: "Arn", # required
  sources: [
    {
      s3_bucket: "S3Bucket",
      s3_key: "S3Key",
      architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
    },
  ],
  robot_software_suite: { # required
    name: "ROS", # accepts ROS, ROS2, General
    version: "Kinetic", # accepts Kinetic, Melodic, Dashing, Foxy
  },
  current_revision_id: "RevisionId",
  environment: {
    uri: "RepositoryUrl",
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version #=> String
resp.sources #=> Array
resp.sources[0].s3_bucket #=> String
resp.sources[0].s3_key #=> String
resp.sources[0].etag #=> String
resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.last_updated_at #=> Time
resp.revision_id #=> String
resp.environment.uri #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application (required, String) —

    The application information for the robot application.

  • :sources (Array<Types::SourceConfig>) —

    The sources of the robot application.

  • :robot_software_suite (required, Types::RobotSoftwareSuite) —

    The robot software suite (ROS distribution) used by the robot application.

  • :current_revision_id (String) —

    The revision id for the robot application.

  • :environment (Types::Environment) —

    The object that contains the Docker image URI for your robot application.

Returns:

See Also:



4237
4238
4239
4240
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4237

def update_robot_application(params = {}, options = {})
  req = build_request(:update_robot_application, params)
  req.send_request(options)
end

#update_simulation_application(params = {}) ⇒ Types::UpdateSimulationApplicationResponse

Updates a simulation application.

Examples:

Request syntax with placeholder values


resp = client.update_simulation_application({
  application: "Arn", # required
  sources: [
    {
      s3_bucket: "S3Bucket",
      s3_key: "S3Key",
      architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
    },
  ],
  simulation_software_suite: { # required
    name: "Gazebo", # accepts Gazebo, RosbagPlay, SimulationRuntime
    version: "SimulationSoftwareSuiteVersionType",
  },
  robot_software_suite: { # required
    name: "ROS", # accepts ROS, ROS2, General
    version: "Kinetic", # accepts Kinetic, Melodic, Dashing, Foxy
  },
  rendering_engine: {
    name: "OGRE", # accepts OGRE
    version: "RenderingEngineVersionType",
  },
  current_revision_id: "RevisionId",
  environment: {
    uri: "RepositoryUrl",
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version #=> String
resp.sources #=> Array
resp.sources[0].s3_bucket #=> String
resp.sources[0].s3_key #=> String
resp.sources[0].etag #=> String
resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
resp.simulation_software_suite.name #=> String, one of "Gazebo", "RosbagPlay", "SimulationRuntime"
resp.simulation_software_suite.version #=> String
resp.robot_software_suite.name #=> String, one of "ROS", "ROS2", "General"
resp.robot_software_suite.version #=> String, one of "Kinetic", "Melodic", "Dashing", "Foxy"
resp.rendering_engine.name #=> String, one of "OGRE"
resp.rendering_engine.version #=> String
resp.last_updated_at #=> Time
resp.revision_id #=> String
resp.environment.uri #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application (required, String) —

    The application information for the simulation application.

  • :sources (Array<Types::SourceConfig>) —

    The sources of the simulation application.

  • :simulation_software_suite (required, Types::SimulationSoftwareSuite) —

    The simulation software suite used by the simulation application.

  • :robot_software_suite (required, Types::RobotSoftwareSuite) —

    Information about the robot software suite (ROS distribution).

  • :rendering_engine (Types::RenderingEngine) —

    The rendering engine for the simulation application.

  • :current_revision_id (String) —

    The revision id for the robot application.

  • :environment (Types::Environment) —

    The object that contains the Docker image URI for your simulation application.

Returns:

See Also:



4332
4333
4334
4335
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4332

def update_simulation_application(params = {}, options = {})
  req = build_request(:update_simulation_application, params)
  req.send_request(options)
end

#update_world_template(params = {}) ⇒ Types::UpdateWorldTemplateResponse

Updates a world template.

Examples:

Request syntax with placeholder values


resp = client.update_world_template({
  template: "Arn", # required
  name: "TemplateName",
  template_body: "Json",
  template_location: {
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key", # required
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template (required, String) —

    The Amazon Resource Name (arn) of the world template to update.

  • :name (String) —

    The name of the template.

  • :template_body (String) —

    The world template body.

  • :template_location (Types::TemplateLocation) —

    The location of the world template.

Returns:

See Also:



4381
4382
4383
4384
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4381

def update_world_template(params = {}, options = {})
  req = build_request(:update_world_template, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


4410
4411
4412
 
# File 'lib/aws-sdk-robomaker/client.rb', line 4410

def waiter_names
  []
end