aws-sdk-robomaker 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-robomaker.rb +47 -0
- data/lib/aws-sdk-robomaker/client.rb +2047 -0
- data/lib/aws-sdk-robomaker/client_api.rb +1146 -0
- data/lib/aws-sdk-robomaker/customizations.rb +0 -0
- data/lib/aws-sdk-robomaker/errors.rb +14 -0
- data/lib/aws-sdk-robomaker/resource.rb +23 -0
- data/lib/aws-sdk-robomaker/types.rb +3111 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 287c2f95209215c30ca509124ed75e649a306511
|
4
|
+
data.tar.gz: f72f914b40ee61fe5c067f5914a010069c1598d6
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1d8c0a5dfd9ce29d3e65f6cc028db9e19ae35cdd318ed993d9f634ba50fe2207124035544782a8e2589c745ebc652f4f697cee04245fd55c0caab1a964a22c9e
|
7
|
+
data.tar.gz: 4bbfc39729abd25778bc17637937a5fa4af926a055710ffa4997c4cb5753b927670f41c5f931d46c3038ce49acf54aaf15c02bd9b031a84d20895f5cad7fa1bb
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-robomaker/types'
|
12
|
+
require_relative 'aws-sdk-robomaker/client_api'
|
13
|
+
require_relative 'aws-sdk-robomaker/client'
|
14
|
+
require_relative 'aws-sdk-robomaker/errors'
|
15
|
+
require_relative 'aws-sdk-robomaker/resource'
|
16
|
+
require_relative 'aws-sdk-robomaker/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS RoboMaker. This module is available in the
|
19
|
+
# `aws-sdk-robomaker` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS RoboMaker all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::RoboMaker::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::RoboMaker
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,2047 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
20
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
21
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
22
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
27
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
28
|
+
|
29
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:robomaker)
|
30
|
+
|
31
|
+
module Aws::RoboMaker
|
32
|
+
class Client < Seahorse::Client::Base
|
33
|
+
|
34
|
+
include Aws::ClientStubs
|
35
|
+
|
36
|
+
@identifier = :robomaker
|
37
|
+
|
38
|
+
set_api(ClientApi::API)
|
39
|
+
|
40
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
41
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
42
|
+
add_plugin(Aws::Plugins::Logging)
|
43
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
44
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
45
|
+
add_plugin(Aws::Plugins::UserAgent)
|
46
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
47
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
48
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
49
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
50
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
51
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
52
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
53
|
+
add_plugin(Aws::Plugins::StubResponses)
|
54
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
55
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
56
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
57
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
58
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
59
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
60
|
+
|
61
|
+
# @overload initialize(options)
|
62
|
+
# @param [Hash] options
|
63
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
64
|
+
# Your AWS credentials. This can be an instance of any one of the
|
65
|
+
# following classes:
|
66
|
+
#
|
67
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
68
|
+
# credentials.
|
69
|
+
#
|
70
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
71
|
+
# from an EC2 IMDS on an EC2 instance.
|
72
|
+
#
|
73
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
74
|
+
# shared file, such as `~/.aws/config`.
|
75
|
+
#
|
76
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
77
|
+
#
|
78
|
+
# When `:credentials` are not configured directly, the following
|
79
|
+
# locations will be searched for credentials:
|
80
|
+
#
|
81
|
+
# * `Aws.config[:credentials]`
|
82
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
83
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
84
|
+
# * `~/.aws/credentials`
|
85
|
+
# * `~/.aws/config`
|
86
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
87
|
+
# very aggressive. Construct and pass an instance of
|
88
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
89
|
+
# timeouts.
|
90
|
+
#
|
91
|
+
# @option options [required, String] :region
|
92
|
+
# The AWS region to connect to. The configured `:region` is
|
93
|
+
# used to determine the service `:endpoint`. When not passed,
|
94
|
+
# a default `:region` is search for in the following locations:
|
95
|
+
#
|
96
|
+
# * `Aws.config[:region]`
|
97
|
+
# * `ENV['AWS_REGION']`
|
98
|
+
# * `ENV['AMAZON_REGION']`
|
99
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
100
|
+
# * `~/.aws/credentials`
|
101
|
+
# * `~/.aws/config`
|
102
|
+
#
|
103
|
+
# @option options [String] :access_key_id
|
104
|
+
#
|
105
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
106
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
107
|
+
# the background every 60 secs (default). Defaults to `false`.
|
108
|
+
#
|
109
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
110
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
111
|
+
# this client.
|
112
|
+
#
|
113
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
114
|
+
# Allows you to provide an identifier for this client which will be attached to
|
115
|
+
# all generated client side metrics. Defaults to an empty string.
|
116
|
+
#
|
117
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
118
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
119
|
+
# agent is running on, where client metrics will be published via UDP.
|
120
|
+
#
|
121
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
122
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
123
|
+
# will use the Client Side Monitoring Agent Publisher.
|
124
|
+
#
|
125
|
+
# @option options [Boolean] :convert_params (true)
|
126
|
+
# When `true`, an attempt is made to coerce request parameters into
|
127
|
+
# the required types.
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
130
|
+
# Set to true to disable SDK automatically adding host prefix
|
131
|
+
# to default service endpoint when available.
|
132
|
+
#
|
133
|
+
# @option options [String] :endpoint
|
134
|
+
# The client endpoint is normally constructed from the `:region`
|
135
|
+
# option. You should only configure an `:endpoint` when connecting
|
136
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
137
|
+
#
|
138
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
139
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
140
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
141
|
+
#
|
142
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
143
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
144
|
+
#
|
145
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
146
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
147
|
+
# Use this option to config the time interval in seconds for making
|
148
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
149
|
+
#
|
150
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
151
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
152
|
+
#
|
153
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
154
|
+
# The log formatter.
|
155
|
+
#
|
156
|
+
# @option options [Symbol] :log_level (:info)
|
157
|
+
# The log level to send messages to the `:logger` at.
|
158
|
+
#
|
159
|
+
# @option options [Logger] :logger
|
160
|
+
# The Logger instance to send log messages to. If this option
|
161
|
+
# is not set, logging will be disabled.
|
162
|
+
#
|
163
|
+
# @option options [String] :profile ("default")
|
164
|
+
# Used when loading credentials from the shared credentials file
|
165
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
166
|
+
#
|
167
|
+
# @option options [Float] :retry_base_delay (0.3)
|
168
|
+
# The base delay in seconds used by the default backoff function.
|
169
|
+
#
|
170
|
+
# @option options [Symbol] :retry_jitter (:none)
|
171
|
+
# 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.
|
172
|
+
#
|
173
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
174
|
+
#
|
175
|
+
# @option options [Integer] :retry_limit (3)
|
176
|
+
# The maximum number of times to retry failed requests. Only
|
177
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
178
|
+
# are retried. Generally, these are throttling errors, data
|
179
|
+
# checksum errors, networking errors, timeout errors and auth
|
180
|
+
# errors from expired credentials.
|
181
|
+
#
|
182
|
+
# @option options [Integer] :retry_max_delay (0)
|
183
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
184
|
+
#
|
185
|
+
# @option options [String] :secret_access_key
|
186
|
+
#
|
187
|
+
# @option options [String] :session_token
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :stub_responses (false)
|
190
|
+
# Causes the client to return stubbed responses. By default
|
191
|
+
# fake responses are generated and returned. You can specify
|
192
|
+
# the response data to return or errors to raise by calling
|
193
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
194
|
+
#
|
195
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
196
|
+
# requests are made, and retries are disabled.
|
197
|
+
#
|
198
|
+
# @option options [Boolean] :validate_params (true)
|
199
|
+
# When `true`, request parameters are validated before
|
200
|
+
# sending the request.
|
201
|
+
#
|
202
|
+
def initialize(*args)
|
203
|
+
super
|
204
|
+
end
|
205
|
+
|
206
|
+
# @!group API Operations
|
207
|
+
|
208
|
+
# Describes one or more simulation jobs.
|
209
|
+
#
|
210
|
+
# @option params [required, Array<String>] :jobs
|
211
|
+
# A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
|
212
|
+
#
|
213
|
+
# @return [Types::BatchDescribeSimulationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
214
|
+
#
|
215
|
+
# * {Types::BatchDescribeSimulationJobResponse#jobs #jobs} => Array<Types::SimulationJob>
|
216
|
+
# * {Types::BatchDescribeSimulationJobResponse#unprocessed_jobs #unprocessed_jobs} => Array<String>
|
217
|
+
#
|
218
|
+
# @example Request syntax with placeholder values
|
219
|
+
#
|
220
|
+
# resp = client.batch_describe_simulation_job({
|
221
|
+
# jobs: ["Arn"], # required
|
222
|
+
# })
|
223
|
+
#
|
224
|
+
# @example Response structure
|
225
|
+
#
|
226
|
+
# resp.jobs #=> Array
|
227
|
+
# resp.jobs[0].arn #=> String
|
228
|
+
# resp.jobs[0].name #=> String
|
229
|
+
# resp.jobs[0].status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
|
230
|
+
# resp.jobs[0].last_updated_at #=> Time
|
231
|
+
# resp.jobs[0].failure_behavior #=> String, one of "Fail", "Continue"
|
232
|
+
# resp.jobs[0].failure_code #=> String, one of "InternalServiceError", "RobotApplicationCrash", "SimulationApplicationCrash", "BadPermissionsRobotApplication", "BadPermissionsSimulationApplication", "BadPermissionsS3Output", "BadPermissionsCloudwatchLogs", "SubnetIpLimitExceeded", "ENILimitExceeded", "BadPermissionsUserCredentials", "InvalidBundleRobotApplication", "InvalidBundleSimulationApplication", "RobotApplicationVersionMismatchedEtag", "SimulationApplicationVersionMismatchedEtag"
|
233
|
+
# resp.jobs[0].client_request_token #=> String
|
234
|
+
# resp.jobs[0].output_location.s3_bucket #=> String
|
235
|
+
# resp.jobs[0].output_location.s3_prefix #=> String
|
236
|
+
# resp.jobs[0].max_job_duration_in_seconds #=> Integer
|
237
|
+
# resp.jobs[0].simulation_time_millis #=> Integer
|
238
|
+
# resp.jobs[0].iam_role #=> String
|
239
|
+
# resp.jobs[0].robot_applications #=> Array
|
240
|
+
# resp.jobs[0].robot_applications[0].application #=> String
|
241
|
+
# resp.jobs[0].robot_applications[0].application_version #=> String
|
242
|
+
# resp.jobs[0].robot_applications[0].launch_config.package_name #=> String
|
243
|
+
# resp.jobs[0].robot_applications[0].launch_config.launch_file #=> String
|
244
|
+
# resp.jobs[0].robot_applications[0].launch_config.environment_variables #=> Hash
|
245
|
+
# resp.jobs[0].robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
246
|
+
# resp.jobs[0].simulation_applications #=> Array
|
247
|
+
# resp.jobs[0].simulation_applications[0].application #=> String
|
248
|
+
# resp.jobs[0].simulation_applications[0].application_version #=> String
|
249
|
+
# resp.jobs[0].simulation_applications[0].launch_config.package_name #=> String
|
250
|
+
# resp.jobs[0].simulation_applications[0].launch_config.launch_file #=> String
|
251
|
+
# resp.jobs[0].simulation_applications[0].launch_config.environment_variables #=> Hash
|
252
|
+
# resp.jobs[0].simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
253
|
+
# resp.jobs[0].vpc_config.subnets #=> Array
|
254
|
+
# resp.jobs[0].vpc_config.subnets[0] #=> String
|
255
|
+
# resp.jobs[0].vpc_config.security_groups #=> Array
|
256
|
+
# resp.jobs[0].vpc_config.security_groups[0] #=> String
|
257
|
+
# resp.jobs[0].vpc_config.vpc_id #=> String
|
258
|
+
# resp.jobs[0].vpc_config.assign_public_ip #=> Boolean
|
259
|
+
# resp.unprocessed_jobs #=> Array
|
260
|
+
# resp.unprocessed_jobs[0] #=> String
|
261
|
+
#
|
262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/BatchDescribeSimulationJob AWS API Documentation
|
263
|
+
#
|
264
|
+
# @overload batch_describe_simulation_job(params = {})
|
265
|
+
# @param [Hash] params ({})
|
266
|
+
def batch_describe_simulation_job(params = {}, options = {})
|
267
|
+
req = build_request(:batch_describe_simulation_job, params)
|
268
|
+
req.send_request(options)
|
269
|
+
end
|
270
|
+
|
271
|
+
# Cancels the specified simulation job.
|
272
|
+
#
|
273
|
+
# @option params [required, String] :job
|
274
|
+
# The simulation job ARN to cancel.
|
275
|
+
#
|
276
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
277
|
+
#
|
278
|
+
# @example Request syntax with placeholder values
|
279
|
+
#
|
280
|
+
# resp = client.cancel_simulation_job({
|
281
|
+
# job: "Arn", # required
|
282
|
+
# })
|
283
|
+
#
|
284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelSimulationJob AWS API Documentation
|
285
|
+
#
|
286
|
+
# @overload cancel_simulation_job(params = {})
|
287
|
+
# @param [Hash] params ({})
|
288
|
+
def cancel_simulation_job(params = {}, options = {})
|
289
|
+
req = build_request(:cancel_simulation_job, params)
|
290
|
+
req.send_request(options)
|
291
|
+
end
|
292
|
+
|
293
|
+
# Creates a deployment job.
|
294
|
+
#
|
295
|
+
# @option params [Types::DeploymentConfig] :deployment_config
|
296
|
+
# The requested deployment configuration.
|
297
|
+
#
|
298
|
+
# @option params [required, String] :client_request_token
|
299
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
300
|
+
# idempotency of the request.
|
301
|
+
#
|
302
|
+
# **A suitable default value is auto-generated.** You should normally
|
303
|
+
# not need to pass this option.**
|
304
|
+
#
|
305
|
+
# @option params [required, String] :fleet
|
306
|
+
# The Amazon Resource Name (ARN) of the fleet to deploy.
|
307
|
+
#
|
308
|
+
# @option params [required, Array<Types::DeploymentApplicationConfig>] :deployment_application_configs
|
309
|
+
# The deployment application configuration.
|
310
|
+
#
|
311
|
+
# @return [Types::CreateDeploymentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
312
|
+
#
|
313
|
+
# * {Types::CreateDeploymentJobResponse#arn #arn} => String
|
314
|
+
# * {Types::CreateDeploymentJobResponse#fleet #fleet} => String
|
315
|
+
# * {Types::CreateDeploymentJobResponse#status #status} => String
|
316
|
+
# * {Types::CreateDeploymentJobResponse#deployment_application_configs #deployment_application_configs} => Array<Types::DeploymentApplicationConfig>
|
317
|
+
# * {Types::CreateDeploymentJobResponse#failure_reason #failure_reason} => String
|
318
|
+
# * {Types::CreateDeploymentJobResponse#failure_code #failure_code} => String
|
319
|
+
# * {Types::CreateDeploymentJobResponse#created_at #created_at} => Time
|
320
|
+
# * {Types::CreateDeploymentJobResponse#deployment_config #deployment_config} => Types::DeploymentConfig
|
321
|
+
#
|
322
|
+
# @example Request syntax with placeholder values
|
323
|
+
#
|
324
|
+
# resp = client.create_deployment_job({
|
325
|
+
# deployment_config: {
|
326
|
+
# concurrent_deployment_percentage: 1,
|
327
|
+
# failure_threshold_percentage: 1,
|
328
|
+
# },
|
329
|
+
# client_request_token: "ClientRequestToken", # required
|
330
|
+
# fleet: "Arn", # required
|
331
|
+
# deployment_application_configs: [ # required
|
332
|
+
# {
|
333
|
+
# application: "Arn", # required
|
334
|
+
# application_version: "Version", # required
|
335
|
+
# launch_config: { # required
|
336
|
+
# package_name: "GenericString", # required
|
337
|
+
# pre_launch_file: "GenericString",
|
338
|
+
# launch_file: "GenericString", # required
|
339
|
+
# post_launch_file: "GenericString",
|
340
|
+
# environment_variables: {
|
341
|
+
# "EnvironmentVariableKey" => "EnvironmentVariableValue",
|
342
|
+
# },
|
343
|
+
# },
|
344
|
+
# },
|
345
|
+
# ],
|
346
|
+
# })
|
347
|
+
#
|
348
|
+
# @example Response structure
|
349
|
+
#
|
350
|
+
# resp.arn #=> String
|
351
|
+
# resp.fleet #=> String
|
352
|
+
# resp.status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded"
|
353
|
+
# resp.deployment_application_configs #=> Array
|
354
|
+
# resp.deployment_application_configs[0].application #=> String
|
355
|
+
# resp.deployment_application_configs[0].application_version #=> String
|
356
|
+
# resp.deployment_application_configs[0].launch_config.package_name #=> String
|
357
|
+
# resp.deployment_application_configs[0].launch_config.pre_launch_file #=> String
|
358
|
+
# resp.deployment_application_configs[0].launch_config.launch_file #=> String
|
359
|
+
# resp.deployment_application_configs[0].launch_config.post_launch_file #=> String
|
360
|
+
# resp.deployment_application_configs[0].launch_config.environment_variables #=> Hash
|
361
|
+
# resp.deployment_application_configs[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
362
|
+
# resp.failure_reason #=> String
|
363
|
+
# resp.failure_code #=> String, one of "ResourceNotFound", "FailureThresholdBreached", "RobotDeploymentNoResponse", "GreengrassDeploymentFailed", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "InternalServerError"
|
364
|
+
# resp.created_at #=> Time
|
365
|
+
# resp.deployment_config.concurrent_deployment_percentage #=> Integer
|
366
|
+
# resp.deployment_config.failure_threshold_percentage #=> Integer
|
367
|
+
#
|
368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateDeploymentJob AWS API Documentation
|
369
|
+
#
|
370
|
+
# @overload create_deployment_job(params = {})
|
371
|
+
# @param [Hash] params ({})
|
372
|
+
def create_deployment_job(params = {}, options = {})
|
373
|
+
req = build_request(:create_deployment_job, params)
|
374
|
+
req.send_request(options)
|
375
|
+
end
|
376
|
+
|
377
|
+
# Creates a fleet, a logical group of robots running the same robot
|
378
|
+
# application.
|
379
|
+
#
|
380
|
+
# @option params [required, String] :name
|
381
|
+
# The name of the fleet.
|
382
|
+
#
|
383
|
+
# @return [Types::CreateFleetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
384
|
+
#
|
385
|
+
# * {Types::CreateFleetResponse#arn #arn} => String
|
386
|
+
# * {Types::CreateFleetResponse#name #name} => String
|
387
|
+
# * {Types::CreateFleetResponse#created_at #created_at} => Time
|
388
|
+
#
|
389
|
+
# @example Request syntax with placeholder values
|
390
|
+
#
|
391
|
+
# resp = client.create_fleet({
|
392
|
+
# name: "Name", # required
|
393
|
+
# })
|
394
|
+
#
|
395
|
+
# @example Response structure
|
396
|
+
#
|
397
|
+
# resp.arn #=> String
|
398
|
+
# resp.name #=> String
|
399
|
+
# resp.created_at #=> Time
|
400
|
+
#
|
401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateFleet AWS API Documentation
|
402
|
+
#
|
403
|
+
# @overload create_fleet(params = {})
|
404
|
+
# @param [Hash] params ({})
|
405
|
+
def create_fleet(params = {}, options = {})
|
406
|
+
req = build_request(:create_fleet, params)
|
407
|
+
req.send_request(options)
|
408
|
+
end
|
409
|
+
|
410
|
+
# Creates a robot.
|
411
|
+
#
|
412
|
+
# @option params [required, String] :name
|
413
|
+
# The name for the robot.
|
414
|
+
#
|
415
|
+
# @option params [required, String] :architecture
|
416
|
+
# The target architecture of the robot.
|
417
|
+
#
|
418
|
+
# @option params [required, String] :greengrass_group_id
|
419
|
+
# The Greengrass group id.
|
420
|
+
#
|
421
|
+
# @return [Types::CreateRobotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
422
|
+
#
|
423
|
+
# * {Types::CreateRobotResponse#arn #arn} => String
|
424
|
+
# * {Types::CreateRobotResponse#name #name} => String
|
425
|
+
# * {Types::CreateRobotResponse#created_at #created_at} => Time
|
426
|
+
# * {Types::CreateRobotResponse#greengrass_group_id #greengrass_group_id} => String
|
427
|
+
# * {Types::CreateRobotResponse#architecture #architecture} => String
|
428
|
+
#
|
429
|
+
# @example Request syntax with placeholder values
|
430
|
+
#
|
431
|
+
# resp = client.create_robot({
|
432
|
+
# name: "Name", # required
|
433
|
+
# architecture: "X86_64", # required, accepts X86_64, ARM64, ARMHF
|
434
|
+
# greengrass_group_id: "Id", # required
|
435
|
+
# })
|
436
|
+
#
|
437
|
+
# @example Response structure
|
438
|
+
#
|
439
|
+
# resp.arn #=> String
|
440
|
+
# resp.name #=> String
|
441
|
+
# resp.created_at #=> Time
|
442
|
+
# resp.greengrass_group_id #=> String
|
443
|
+
# resp.architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
444
|
+
#
|
445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateRobot AWS API Documentation
|
446
|
+
#
|
447
|
+
# @overload create_robot(params = {})
|
448
|
+
# @param [Hash] params ({})
|
449
|
+
def create_robot(params = {}, options = {})
|
450
|
+
req = build_request(:create_robot, params)
|
451
|
+
req.send_request(options)
|
452
|
+
end
|
453
|
+
|
454
|
+
# Creates a robot application.
|
455
|
+
#
|
456
|
+
# @option params [required, String] :name
|
457
|
+
# The name of the robot application.
|
458
|
+
#
|
459
|
+
# @option params [required, Array<Types::SourceConfig>] :sources
|
460
|
+
# The sources of the robot application.
|
461
|
+
#
|
462
|
+
# @option params [required, Types::RobotSoftwareSuite] :robot_software_suite
|
463
|
+
# The robot software suite used by the robot application.
|
464
|
+
#
|
465
|
+
# @return [Types::CreateRobotApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
466
|
+
#
|
467
|
+
# * {Types::CreateRobotApplicationResponse#arn #arn} => String
|
468
|
+
# * {Types::CreateRobotApplicationResponse#name #name} => String
|
469
|
+
# * {Types::CreateRobotApplicationResponse#version #version} => String
|
470
|
+
# * {Types::CreateRobotApplicationResponse#sources #sources} => Array<Types::Source>
|
471
|
+
# * {Types::CreateRobotApplicationResponse#robot_software_suite #robot_software_suite} => Types::RobotSoftwareSuite
|
472
|
+
# * {Types::CreateRobotApplicationResponse#last_updated_at #last_updated_at} => Time
|
473
|
+
# * {Types::CreateRobotApplicationResponse#revision_id #revision_id} => String
|
474
|
+
#
|
475
|
+
# @example Request syntax with placeholder values
|
476
|
+
#
|
477
|
+
# resp = client.create_robot_application({
|
478
|
+
# name: "Name", # required
|
479
|
+
# sources: [ # required
|
480
|
+
# {
|
481
|
+
# s3_bucket: "S3Bucket",
|
482
|
+
# s3_key: "S3Key",
|
483
|
+
# architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
|
484
|
+
# },
|
485
|
+
# ],
|
486
|
+
# robot_software_suite: { # required
|
487
|
+
# name: "ROS", # accepts ROS
|
488
|
+
# version: "Kinetic", # accepts Kinetic
|
489
|
+
# },
|
490
|
+
# })
|
491
|
+
#
|
492
|
+
# @example Response structure
|
493
|
+
#
|
494
|
+
# resp.arn #=> String
|
495
|
+
# resp.name #=> String
|
496
|
+
# resp.version #=> String
|
497
|
+
# resp.sources #=> Array
|
498
|
+
# resp.sources[0].s3_bucket #=> String
|
499
|
+
# resp.sources[0].s3_key #=> String
|
500
|
+
# resp.sources[0].etag #=> String
|
501
|
+
# resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
502
|
+
# resp.robot_software_suite.name #=> String, one of "ROS"
|
503
|
+
# resp.robot_software_suite.version #=> String, one of "Kinetic"
|
504
|
+
# resp.last_updated_at #=> Time
|
505
|
+
# resp.revision_id #=> String
|
506
|
+
#
|
507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateRobotApplication AWS API Documentation
|
508
|
+
#
|
509
|
+
# @overload create_robot_application(params = {})
|
510
|
+
# @param [Hash] params ({})
|
511
|
+
def create_robot_application(params = {}, options = {})
|
512
|
+
req = build_request(:create_robot_application, params)
|
513
|
+
req.send_request(options)
|
514
|
+
end
|
515
|
+
|
516
|
+
# Creates a version of a robot application.
|
517
|
+
#
|
518
|
+
# @option params [required, String] :application
|
519
|
+
# The application information for the robot application.
|
520
|
+
#
|
521
|
+
# @option params [String] :current_revision_id
|
522
|
+
# The current revision id for the robot application. If you provide a
|
523
|
+
# value and it matches the latest revision ID, a new version will be
|
524
|
+
# created.
|
525
|
+
#
|
526
|
+
# @return [Types::CreateRobotApplicationVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
527
|
+
#
|
528
|
+
# * {Types::CreateRobotApplicationVersionResponse#arn #arn} => String
|
529
|
+
# * {Types::CreateRobotApplicationVersionResponse#name #name} => String
|
530
|
+
# * {Types::CreateRobotApplicationVersionResponse#version #version} => String
|
531
|
+
# * {Types::CreateRobotApplicationVersionResponse#sources #sources} => Array<Types::Source>
|
532
|
+
# * {Types::CreateRobotApplicationVersionResponse#robot_software_suite #robot_software_suite} => Types::RobotSoftwareSuite
|
533
|
+
# * {Types::CreateRobotApplicationVersionResponse#last_updated_at #last_updated_at} => Time
|
534
|
+
# * {Types::CreateRobotApplicationVersionResponse#revision_id #revision_id} => String
|
535
|
+
#
|
536
|
+
# @example Request syntax with placeholder values
|
537
|
+
#
|
538
|
+
# resp = client.create_robot_application_version({
|
539
|
+
# application: "Arn", # required
|
540
|
+
# current_revision_id: "RevisionId",
|
541
|
+
# })
|
542
|
+
#
|
543
|
+
# @example Response structure
|
544
|
+
#
|
545
|
+
# resp.arn #=> String
|
546
|
+
# resp.name #=> String
|
547
|
+
# resp.version #=> String
|
548
|
+
# resp.sources #=> Array
|
549
|
+
# resp.sources[0].s3_bucket #=> String
|
550
|
+
# resp.sources[0].s3_key #=> String
|
551
|
+
# resp.sources[0].etag #=> String
|
552
|
+
# resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
553
|
+
# resp.robot_software_suite.name #=> String, one of "ROS"
|
554
|
+
# resp.robot_software_suite.version #=> String, one of "Kinetic"
|
555
|
+
# resp.last_updated_at #=> Time
|
556
|
+
# resp.revision_id #=> String
|
557
|
+
#
|
558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateRobotApplicationVersion AWS API Documentation
|
559
|
+
#
|
560
|
+
# @overload create_robot_application_version(params = {})
|
561
|
+
# @param [Hash] params ({})
|
562
|
+
def create_robot_application_version(params = {}, options = {})
|
563
|
+
req = build_request(:create_robot_application_version, params)
|
564
|
+
req.send_request(options)
|
565
|
+
end
|
566
|
+
|
567
|
+
# Creates a simulation application.
|
568
|
+
#
|
569
|
+
# @option params [required, String] :name
|
570
|
+
# The name of the simulation application.
|
571
|
+
#
|
572
|
+
# @option params [required, Array<Types::SourceConfig>] :sources
|
573
|
+
# The sources of the simulation application.
|
574
|
+
#
|
575
|
+
# @option params [required, Types::SimulationSoftwareSuite] :simulation_software_suite
|
576
|
+
# The simulation software suite used by the simulation application.
|
577
|
+
#
|
578
|
+
# @option params [required, Types::RobotSoftwareSuite] :robot_software_suite
|
579
|
+
# The robot software suite of the simulation application.
|
580
|
+
#
|
581
|
+
# @option params [required, Types::RenderingEngine] :rendering_engine
|
582
|
+
# The rendering engine for the simulation application.
|
583
|
+
#
|
584
|
+
# @return [Types::CreateSimulationApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
585
|
+
#
|
586
|
+
# * {Types::CreateSimulationApplicationResponse#arn #arn} => String
|
587
|
+
# * {Types::CreateSimulationApplicationResponse#name #name} => String
|
588
|
+
# * {Types::CreateSimulationApplicationResponse#version #version} => String
|
589
|
+
# * {Types::CreateSimulationApplicationResponse#sources #sources} => Array<Types::Source>
|
590
|
+
# * {Types::CreateSimulationApplicationResponse#simulation_software_suite #simulation_software_suite} => Types::SimulationSoftwareSuite
|
591
|
+
# * {Types::CreateSimulationApplicationResponse#robot_software_suite #robot_software_suite} => Types::RobotSoftwareSuite
|
592
|
+
# * {Types::CreateSimulationApplicationResponse#rendering_engine #rendering_engine} => Types::RenderingEngine
|
593
|
+
# * {Types::CreateSimulationApplicationResponse#last_updated_at #last_updated_at} => Time
|
594
|
+
# * {Types::CreateSimulationApplicationResponse#revision_id #revision_id} => String
|
595
|
+
#
|
596
|
+
# @example Request syntax with placeholder values
|
597
|
+
#
|
598
|
+
# resp = client.create_simulation_application({
|
599
|
+
# name: "Name", # required
|
600
|
+
# sources: [ # required
|
601
|
+
# {
|
602
|
+
# s3_bucket: "S3Bucket",
|
603
|
+
# s3_key: "S3Key",
|
604
|
+
# architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
|
605
|
+
# },
|
606
|
+
# ],
|
607
|
+
# simulation_software_suite: { # required
|
608
|
+
# name: "Gazebo", # accepts Gazebo
|
609
|
+
# version: "SimulationSoftwareSuiteVersionType",
|
610
|
+
# },
|
611
|
+
# robot_software_suite: { # required
|
612
|
+
# name: "ROS", # accepts ROS
|
613
|
+
# version: "Kinetic", # accepts Kinetic
|
614
|
+
# },
|
615
|
+
# rendering_engine: { # required
|
616
|
+
# name: "OGRE", # accepts OGRE
|
617
|
+
# version: "RenderingEngineVersionType",
|
618
|
+
# },
|
619
|
+
# })
|
620
|
+
#
|
621
|
+
# @example Response structure
|
622
|
+
#
|
623
|
+
# resp.arn #=> String
|
624
|
+
# resp.name #=> String
|
625
|
+
# resp.version #=> String
|
626
|
+
# resp.sources #=> Array
|
627
|
+
# resp.sources[0].s3_bucket #=> String
|
628
|
+
# resp.sources[0].s3_key #=> String
|
629
|
+
# resp.sources[0].etag #=> String
|
630
|
+
# resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
631
|
+
# resp.simulation_software_suite.name #=> String, one of "Gazebo"
|
632
|
+
# resp.simulation_software_suite.version #=> String
|
633
|
+
# resp.robot_software_suite.name #=> String, one of "ROS"
|
634
|
+
# resp.robot_software_suite.version #=> String, one of "Kinetic"
|
635
|
+
# resp.rendering_engine.name #=> String, one of "OGRE"
|
636
|
+
# resp.rendering_engine.version #=> String
|
637
|
+
# resp.last_updated_at #=> Time
|
638
|
+
# resp.revision_id #=> String
|
639
|
+
#
|
640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateSimulationApplication AWS API Documentation
|
641
|
+
#
|
642
|
+
# @overload create_simulation_application(params = {})
|
643
|
+
# @param [Hash] params ({})
|
644
|
+
def create_simulation_application(params = {}, options = {})
|
645
|
+
req = build_request(:create_simulation_application, params)
|
646
|
+
req.send_request(options)
|
647
|
+
end
|
648
|
+
|
649
|
+
# Creates a simulation application with a specific revision id.
|
650
|
+
#
|
651
|
+
# @option params [required, String] :application
|
652
|
+
# The application information for the simulation application.
|
653
|
+
#
|
654
|
+
# @option params [String] :current_revision_id
|
655
|
+
# The current revision id for the simulation application. If you provide
|
656
|
+
# a value and it matches the latest revision ID, a new version will be
|
657
|
+
# created.
|
658
|
+
#
|
659
|
+
# @return [Types::CreateSimulationApplicationVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
660
|
+
#
|
661
|
+
# * {Types::CreateSimulationApplicationVersionResponse#arn #arn} => String
|
662
|
+
# * {Types::CreateSimulationApplicationVersionResponse#name #name} => String
|
663
|
+
# * {Types::CreateSimulationApplicationVersionResponse#version #version} => String
|
664
|
+
# * {Types::CreateSimulationApplicationVersionResponse#sources #sources} => Array<Types::Source>
|
665
|
+
# * {Types::CreateSimulationApplicationVersionResponse#simulation_software_suite #simulation_software_suite} => Types::SimulationSoftwareSuite
|
666
|
+
# * {Types::CreateSimulationApplicationVersionResponse#robot_software_suite #robot_software_suite} => Types::RobotSoftwareSuite
|
667
|
+
# * {Types::CreateSimulationApplicationVersionResponse#rendering_engine #rendering_engine} => Types::RenderingEngine
|
668
|
+
# * {Types::CreateSimulationApplicationVersionResponse#last_updated_at #last_updated_at} => Time
|
669
|
+
# * {Types::CreateSimulationApplicationVersionResponse#revision_id #revision_id} => String
|
670
|
+
#
|
671
|
+
# @example Request syntax with placeholder values
|
672
|
+
#
|
673
|
+
# resp = client.create_simulation_application_version({
|
674
|
+
# application: "Arn", # required
|
675
|
+
# current_revision_id: "RevisionId",
|
676
|
+
# })
|
677
|
+
#
|
678
|
+
# @example Response structure
|
679
|
+
#
|
680
|
+
# resp.arn #=> String
|
681
|
+
# resp.name #=> String
|
682
|
+
# resp.version #=> String
|
683
|
+
# resp.sources #=> Array
|
684
|
+
# resp.sources[0].s3_bucket #=> String
|
685
|
+
# resp.sources[0].s3_key #=> String
|
686
|
+
# resp.sources[0].etag #=> String
|
687
|
+
# resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
688
|
+
# resp.simulation_software_suite.name #=> String, one of "Gazebo"
|
689
|
+
# resp.simulation_software_suite.version #=> String
|
690
|
+
# resp.robot_software_suite.name #=> String, one of "ROS"
|
691
|
+
# resp.robot_software_suite.version #=> String, one of "Kinetic"
|
692
|
+
# resp.rendering_engine.name #=> String, one of "OGRE"
|
693
|
+
# resp.rendering_engine.version #=> String
|
694
|
+
# resp.last_updated_at #=> Time
|
695
|
+
# resp.revision_id #=> String
|
696
|
+
#
|
697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateSimulationApplicationVersion AWS API Documentation
|
698
|
+
#
|
699
|
+
# @overload create_simulation_application_version(params = {})
|
700
|
+
# @param [Hash] params ({})
|
701
|
+
def create_simulation_application_version(params = {}, options = {})
|
702
|
+
req = build_request(:create_simulation_application_version, params)
|
703
|
+
req.send_request(options)
|
704
|
+
end
|
705
|
+
|
706
|
+
# Creates a simulation job.
|
707
|
+
#
|
708
|
+
# @option params [String] :client_request_token
|
709
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
710
|
+
# idempotency of the request.
|
711
|
+
#
|
712
|
+
# **A suitable default value is auto-generated.** You should normally
|
713
|
+
# not need to pass this option.**
|
714
|
+
#
|
715
|
+
# @option params [Types::OutputLocation] :output_location
|
716
|
+
# Location for output files generated by the simulation job.
|
717
|
+
#
|
718
|
+
# @option params [required, Integer] :max_job_duration_in_seconds
|
719
|
+
# The maximum simulation job duration in seconds (up to 14 days or
|
720
|
+
# 1,209,600 seconds. When `maxJobDurationInSeconds` is reached, the
|
721
|
+
# simulation job will status will transition to `Completed`.
|
722
|
+
#
|
723
|
+
# @option params [required, String] :iam_role
|
724
|
+
# The IAM role that allows the simulation instance to call the AWS APIs
|
725
|
+
# that are specified in its associated policies on your behalf. This is
|
726
|
+
# how credentials are passed in to your simulation job. See how to
|
727
|
+
# [specify AWS security credentials for your application][1].
|
728
|
+
#
|
729
|
+
#
|
730
|
+
#
|
731
|
+
# [1]: https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/deployment-ecs-specify-credentials
|
732
|
+
#
|
733
|
+
# @option params [String] :failure_behavior
|
734
|
+
# The failure behavior the simulation job.
|
735
|
+
#
|
736
|
+
# Continue
|
737
|
+
#
|
738
|
+
# : Restart the simulation job in the same host instance.
|
739
|
+
#
|
740
|
+
# Fail
|
741
|
+
#
|
742
|
+
# : Stop the simulation job and terminate the instance.
|
743
|
+
#
|
744
|
+
# @option params [Array<Types::RobotApplicationConfig>] :robot_applications
|
745
|
+
# The robot application to use in the simulation job.
|
746
|
+
#
|
747
|
+
# @option params [Array<Types::SimulationApplicationConfig>] :simulation_applications
|
748
|
+
# The simulation application to use in the simulation job.
|
749
|
+
#
|
750
|
+
# @option params [Types::VPCConfig] :vpc_config
|
751
|
+
# If your simulation job accesses resources in a VPC, you provide this
|
752
|
+
# parameter identifying the list of security group IDs and subnet IDs.
|
753
|
+
# These must belong to the same VPC. You must provide at least one
|
754
|
+
# security group and one subnet ID.
|
755
|
+
#
|
756
|
+
# @return [Types::CreateSimulationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
757
|
+
#
|
758
|
+
# * {Types::CreateSimulationJobResponse#arn #arn} => String
|
759
|
+
# * {Types::CreateSimulationJobResponse#status #status} => String
|
760
|
+
# * {Types::CreateSimulationJobResponse#last_updated_at #last_updated_at} => Time
|
761
|
+
# * {Types::CreateSimulationJobResponse#failure_behavior #failure_behavior} => String
|
762
|
+
# * {Types::CreateSimulationJobResponse#failure_code #failure_code} => String
|
763
|
+
# * {Types::CreateSimulationJobResponse#client_request_token #client_request_token} => String
|
764
|
+
# * {Types::CreateSimulationJobResponse#output_location #output_location} => Types::OutputLocation
|
765
|
+
# * {Types::CreateSimulationJobResponse#max_job_duration_in_seconds #max_job_duration_in_seconds} => Integer
|
766
|
+
# * {Types::CreateSimulationJobResponse#simulation_time_millis #simulation_time_millis} => Integer
|
767
|
+
# * {Types::CreateSimulationJobResponse#iam_role #iam_role} => String
|
768
|
+
# * {Types::CreateSimulationJobResponse#robot_applications #robot_applications} => Array<Types::RobotApplicationConfig>
|
769
|
+
# * {Types::CreateSimulationJobResponse#simulation_applications #simulation_applications} => Array<Types::SimulationApplicationConfig>
|
770
|
+
# * {Types::CreateSimulationJobResponse#vpc_config #vpc_config} => Types::VPCConfigResponse
|
771
|
+
#
|
772
|
+
# @example Request syntax with placeholder values
|
773
|
+
#
|
774
|
+
# resp = client.create_simulation_job({
|
775
|
+
# client_request_token: "ClientRequestToken",
|
776
|
+
# output_location: {
|
777
|
+
# s3_bucket: "S3Bucket",
|
778
|
+
# s3_prefix: "S3Key",
|
779
|
+
# },
|
780
|
+
# max_job_duration_in_seconds: 1, # required
|
781
|
+
# iam_role: "IamRole", # required
|
782
|
+
# failure_behavior: "Fail", # accepts Fail, Continue
|
783
|
+
# robot_applications: [
|
784
|
+
# {
|
785
|
+
# application: "Arn", # required
|
786
|
+
# application_version: "Version",
|
787
|
+
# launch_config: { # required
|
788
|
+
# package_name: "GenericString", # required
|
789
|
+
# launch_file: "GenericString", # required
|
790
|
+
# environment_variables: {
|
791
|
+
# "EnvironmentVariableKey" => "EnvironmentVariableValue",
|
792
|
+
# },
|
793
|
+
# },
|
794
|
+
# },
|
795
|
+
# ],
|
796
|
+
# simulation_applications: [
|
797
|
+
# {
|
798
|
+
# application: "Arn", # required
|
799
|
+
# application_version: "Version",
|
800
|
+
# launch_config: { # required
|
801
|
+
# package_name: "GenericString", # required
|
802
|
+
# launch_file: "GenericString", # required
|
803
|
+
# environment_variables: {
|
804
|
+
# "EnvironmentVariableKey" => "EnvironmentVariableValue",
|
805
|
+
# },
|
806
|
+
# },
|
807
|
+
# },
|
808
|
+
# ],
|
809
|
+
# vpc_config: {
|
810
|
+
# subnets: ["GenericString"], # required
|
811
|
+
# security_groups: ["GenericString"],
|
812
|
+
# assign_public_ip: false,
|
813
|
+
# },
|
814
|
+
# })
|
815
|
+
#
|
816
|
+
# @example Response structure
|
817
|
+
#
|
818
|
+
# resp.arn #=> String
|
819
|
+
# resp.status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
|
820
|
+
# resp.last_updated_at #=> Time
|
821
|
+
# resp.failure_behavior #=> String, one of "Fail", "Continue"
|
822
|
+
# resp.failure_code #=> String, one of "InternalServiceError", "RobotApplicationCrash", "SimulationApplicationCrash", "BadPermissionsRobotApplication", "BadPermissionsSimulationApplication", "BadPermissionsS3Output", "BadPermissionsCloudwatchLogs", "SubnetIpLimitExceeded", "ENILimitExceeded", "BadPermissionsUserCredentials", "InvalidBundleRobotApplication", "InvalidBundleSimulationApplication", "RobotApplicationVersionMismatchedEtag", "SimulationApplicationVersionMismatchedEtag"
|
823
|
+
# resp.client_request_token #=> String
|
824
|
+
# resp.output_location.s3_bucket #=> String
|
825
|
+
# resp.output_location.s3_prefix #=> String
|
826
|
+
# resp.max_job_duration_in_seconds #=> Integer
|
827
|
+
# resp.simulation_time_millis #=> Integer
|
828
|
+
# resp.iam_role #=> String
|
829
|
+
# resp.robot_applications #=> Array
|
830
|
+
# resp.robot_applications[0].application #=> String
|
831
|
+
# resp.robot_applications[0].application_version #=> String
|
832
|
+
# resp.robot_applications[0].launch_config.package_name #=> String
|
833
|
+
# resp.robot_applications[0].launch_config.launch_file #=> String
|
834
|
+
# resp.robot_applications[0].launch_config.environment_variables #=> Hash
|
835
|
+
# resp.robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
836
|
+
# resp.simulation_applications #=> Array
|
837
|
+
# resp.simulation_applications[0].application #=> String
|
838
|
+
# resp.simulation_applications[0].application_version #=> String
|
839
|
+
# resp.simulation_applications[0].launch_config.package_name #=> String
|
840
|
+
# resp.simulation_applications[0].launch_config.launch_file #=> String
|
841
|
+
# resp.simulation_applications[0].launch_config.environment_variables #=> Hash
|
842
|
+
# resp.simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
843
|
+
# resp.vpc_config.subnets #=> Array
|
844
|
+
# resp.vpc_config.subnets[0] #=> String
|
845
|
+
# resp.vpc_config.security_groups #=> Array
|
846
|
+
# resp.vpc_config.security_groups[0] #=> String
|
847
|
+
# resp.vpc_config.vpc_id #=> String
|
848
|
+
# resp.vpc_config.assign_public_ip #=> Boolean
|
849
|
+
#
|
850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateSimulationJob AWS API Documentation
|
851
|
+
#
|
852
|
+
# @overload create_simulation_job(params = {})
|
853
|
+
# @param [Hash] params ({})
|
854
|
+
def create_simulation_job(params = {}, options = {})
|
855
|
+
req = build_request(:create_simulation_job, params)
|
856
|
+
req.send_request(options)
|
857
|
+
end
|
858
|
+
|
859
|
+
# Deletes a fleet.
|
860
|
+
#
|
861
|
+
# @option params [required, String] :fleet
|
862
|
+
# The Amazon Resource Name (ARN) of the fleet.
|
863
|
+
#
|
864
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
865
|
+
#
|
866
|
+
# @example Request syntax with placeholder values
|
867
|
+
#
|
868
|
+
# resp = client.delete_fleet({
|
869
|
+
# fleet: "Arn", # required
|
870
|
+
# })
|
871
|
+
#
|
872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteFleet AWS API Documentation
|
873
|
+
#
|
874
|
+
# @overload delete_fleet(params = {})
|
875
|
+
# @param [Hash] params ({})
|
876
|
+
def delete_fleet(params = {}, options = {})
|
877
|
+
req = build_request(:delete_fleet, params)
|
878
|
+
req.send_request(options)
|
879
|
+
end
|
880
|
+
|
881
|
+
# Deletes a robot.
|
882
|
+
#
|
883
|
+
# @option params [required, String] :robot
|
884
|
+
# The Amazon Resource Name (ARN) of the robot.
|
885
|
+
#
|
886
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
887
|
+
#
|
888
|
+
# @example Request syntax with placeholder values
|
889
|
+
#
|
890
|
+
# resp = client.delete_robot({
|
891
|
+
# robot: "Arn", # required
|
892
|
+
# })
|
893
|
+
#
|
894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobot AWS API Documentation
|
895
|
+
#
|
896
|
+
# @overload delete_robot(params = {})
|
897
|
+
# @param [Hash] params ({})
|
898
|
+
def delete_robot(params = {}, options = {})
|
899
|
+
req = build_request(:delete_robot, params)
|
900
|
+
req.send_request(options)
|
901
|
+
end
|
902
|
+
|
903
|
+
# Deletes a robot application.
|
904
|
+
#
|
905
|
+
# @option params [required, String] :application
|
906
|
+
# The Amazon Resource Name (ARN) of the the robot application.
|
907
|
+
#
|
908
|
+
# @option params [String] :application_version
|
909
|
+
# The version of the robot application to delete.
|
910
|
+
#
|
911
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
912
|
+
#
|
913
|
+
# @example Request syntax with placeholder values
|
914
|
+
#
|
915
|
+
# resp = client.delete_robot_application({
|
916
|
+
# application: "Arn", # required
|
917
|
+
# application_version: "Version",
|
918
|
+
# })
|
919
|
+
#
|
920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobotApplication AWS API Documentation
|
921
|
+
#
|
922
|
+
# @overload delete_robot_application(params = {})
|
923
|
+
# @param [Hash] params ({})
|
924
|
+
def delete_robot_application(params = {}, options = {})
|
925
|
+
req = build_request(:delete_robot_application, params)
|
926
|
+
req.send_request(options)
|
927
|
+
end
|
928
|
+
|
929
|
+
# Deletes a simulation application.
|
930
|
+
#
|
931
|
+
# @option params [required, String] :application
|
932
|
+
# The application information for the simulation application to delete.
|
933
|
+
#
|
934
|
+
# @option params [String] :application_version
|
935
|
+
# The version of the simulation application to delete.
|
936
|
+
#
|
937
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
938
|
+
#
|
939
|
+
# @example Request syntax with placeholder values
|
940
|
+
#
|
941
|
+
# resp = client.delete_simulation_application({
|
942
|
+
# application: "Arn", # required
|
943
|
+
# application_version: "Version",
|
944
|
+
# })
|
945
|
+
#
|
946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteSimulationApplication AWS API Documentation
|
947
|
+
#
|
948
|
+
# @overload delete_simulation_application(params = {})
|
949
|
+
# @param [Hash] params ({})
|
950
|
+
def delete_simulation_application(params = {}, options = {})
|
951
|
+
req = build_request(:delete_simulation_application, params)
|
952
|
+
req.send_request(options)
|
953
|
+
end
|
954
|
+
|
955
|
+
# Deregisters a robot.
|
956
|
+
#
|
957
|
+
# @option params [required, String] :fleet
|
958
|
+
# The Amazon Resource Name (ARN) of the fleet.
|
959
|
+
#
|
960
|
+
# @option params [required, String] :robot
|
961
|
+
# The Amazon Resource Name (ARN) of the robot.
|
962
|
+
#
|
963
|
+
# @return [Types::DeregisterRobotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
964
|
+
#
|
965
|
+
# * {Types::DeregisterRobotResponse#fleet #fleet} => String
|
966
|
+
# * {Types::DeregisterRobotResponse#robot #robot} => String
|
967
|
+
#
|
968
|
+
# @example Request syntax with placeholder values
|
969
|
+
#
|
970
|
+
# resp = client.deregister_robot({
|
971
|
+
# fleet: "Arn", # required
|
972
|
+
# robot: "Arn", # required
|
973
|
+
# })
|
974
|
+
#
|
975
|
+
# @example Response structure
|
976
|
+
#
|
977
|
+
# resp.fleet #=> String
|
978
|
+
# resp.robot #=> String
|
979
|
+
#
|
980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeregisterRobot AWS API Documentation
|
981
|
+
#
|
982
|
+
# @overload deregister_robot(params = {})
|
983
|
+
# @param [Hash] params ({})
|
984
|
+
def deregister_robot(params = {}, options = {})
|
985
|
+
req = build_request(:deregister_robot, params)
|
986
|
+
req.send_request(options)
|
987
|
+
end
|
988
|
+
|
989
|
+
# Describes a deployment job. \[Does it work regardless of deployment
|
990
|
+
# status, e.g. Failed?\]
|
991
|
+
#
|
992
|
+
# @option params [required, String] :job
|
993
|
+
# The Amazon Resource Name (ARN) of the deployment job.
|
994
|
+
#
|
995
|
+
# @return [Types::DescribeDeploymentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
996
|
+
#
|
997
|
+
# * {Types::DescribeDeploymentJobResponse#arn #arn} => String
|
998
|
+
# * {Types::DescribeDeploymentJobResponse#fleet #fleet} => String
|
999
|
+
# * {Types::DescribeDeploymentJobResponse#status #status} => String
|
1000
|
+
# * {Types::DescribeDeploymentJobResponse#deployment_config #deployment_config} => Types::DeploymentConfig
|
1001
|
+
# * {Types::DescribeDeploymentJobResponse#deployment_application_configs #deployment_application_configs} => Array<Types::DeploymentApplicationConfig>
|
1002
|
+
# * {Types::DescribeDeploymentJobResponse#failure_reason #failure_reason} => String
|
1003
|
+
# * {Types::DescribeDeploymentJobResponse#failure_code #failure_code} => String
|
1004
|
+
# * {Types::DescribeDeploymentJobResponse#created_at #created_at} => Time
|
1005
|
+
# * {Types::DescribeDeploymentJobResponse#robot_deployment_summary #robot_deployment_summary} => Array<Types::RobotDeployment>
|
1006
|
+
#
|
1007
|
+
# @example Request syntax with placeholder values
|
1008
|
+
#
|
1009
|
+
# resp = client.describe_deployment_job({
|
1010
|
+
# job: "Arn", # required
|
1011
|
+
# })
|
1012
|
+
#
|
1013
|
+
# @example Response structure
|
1014
|
+
#
|
1015
|
+
# resp.arn #=> String
|
1016
|
+
# resp.fleet #=> String
|
1017
|
+
# resp.status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded"
|
1018
|
+
# resp.deployment_config.concurrent_deployment_percentage #=> Integer
|
1019
|
+
# resp.deployment_config.failure_threshold_percentage #=> Integer
|
1020
|
+
# resp.deployment_application_configs #=> Array
|
1021
|
+
# resp.deployment_application_configs[0].application #=> String
|
1022
|
+
# resp.deployment_application_configs[0].application_version #=> String
|
1023
|
+
# resp.deployment_application_configs[0].launch_config.package_name #=> String
|
1024
|
+
# resp.deployment_application_configs[0].launch_config.pre_launch_file #=> String
|
1025
|
+
# resp.deployment_application_configs[0].launch_config.launch_file #=> String
|
1026
|
+
# resp.deployment_application_configs[0].launch_config.post_launch_file #=> String
|
1027
|
+
# resp.deployment_application_configs[0].launch_config.environment_variables #=> Hash
|
1028
|
+
# resp.deployment_application_configs[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
1029
|
+
# resp.failure_reason #=> String
|
1030
|
+
# resp.failure_code #=> String, one of "ResourceNotFound", "FailureThresholdBreached", "RobotDeploymentNoResponse", "GreengrassDeploymentFailed", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "InternalServerError"
|
1031
|
+
# resp.created_at #=> Time
|
1032
|
+
# resp.robot_deployment_summary #=> Array
|
1033
|
+
# resp.robot_deployment_summary[0].arn #=> String
|
1034
|
+
# resp.robot_deployment_summary[0].deployment_start_time #=> Time
|
1035
|
+
# resp.robot_deployment_summary[0].deployment_finish_time #=> Time
|
1036
|
+
# resp.robot_deployment_summary[0].status #=> String, one of "Available", "Registered", "PendingNewDeployment", "Deploying", "Failed", "InSync", "NoResponse"
|
1037
|
+
# resp.robot_deployment_summary[0].progress_detail.current_progress #=> String
|
1038
|
+
# resp.robot_deployment_summary[0].progress_detail.target_resource #=> String
|
1039
|
+
# resp.robot_deployment_summary[0].failure_reason #=> String
|
1040
|
+
# resp.robot_deployment_summary[0].failure_code #=> String, one of "ResourceNotFound", "FailureThresholdBreached", "RobotDeploymentNoResponse", "GreengrassDeploymentFailed", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "InternalServerError"
|
1041
|
+
#
|
1042
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeDeploymentJob AWS API Documentation
|
1043
|
+
#
|
1044
|
+
# @overload describe_deployment_job(params = {})
|
1045
|
+
# @param [Hash] params ({})
|
1046
|
+
def describe_deployment_job(params = {}, options = {})
|
1047
|
+
req = build_request(:describe_deployment_job, params)
|
1048
|
+
req.send_request(options)
|
1049
|
+
end
|
1050
|
+
|
1051
|
+
# Describes a fleet.
|
1052
|
+
#
|
1053
|
+
# @option params [required, String] :fleet
|
1054
|
+
# The Amazon Resource Name (ARN) of the fleet.
|
1055
|
+
#
|
1056
|
+
# @return [Types::DescribeFleetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1057
|
+
#
|
1058
|
+
# * {Types::DescribeFleetResponse#name #name} => String
|
1059
|
+
# * {Types::DescribeFleetResponse#arn #arn} => String
|
1060
|
+
# * {Types::DescribeFleetResponse#robots #robots} => Array<Types::Robot>
|
1061
|
+
# * {Types::DescribeFleetResponse#created_at #created_at} => Time
|
1062
|
+
# * {Types::DescribeFleetResponse#last_deployment_status #last_deployment_status} => String
|
1063
|
+
# * {Types::DescribeFleetResponse#last_deployment_job #last_deployment_job} => String
|
1064
|
+
# * {Types::DescribeFleetResponse#last_deployment_time #last_deployment_time} => Time
|
1065
|
+
#
|
1066
|
+
# @example Request syntax with placeholder values
|
1067
|
+
#
|
1068
|
+
# resp = client.describe_fleet({
|
1069
|
+
# fleet: "Arn", # required
|
1070
|
+
# })
|
1071
|
+
#
|
1072
|
+
# @example Response structure
|
1073
|
+
#
|
1074
|
+
# resp.name #=> String
|
1075
|
+
# resp.arn #=> String
|
1076
|
+
# resp.robots #=> Array
|
1077
|
+
# resp.robots[0].arn #=> String
|
1078
|
+
# resp.robots[0].name #=> String
|
1079
|
+
# resp.robots[0].fleet_arn #=> String
|
1080
|
+
# resp.robots[0].status #=> String, one of "Available", "Registered", "PendingNewDeployment", "Deploying", "Failed", "InSync", "NoResponse"
|
1081
|
+
# resp.robots[0].green_grass_group_id #=> String
|
1082
|
+
# resp.robots[0].created_at #=> Time
|
1083
|
+
# resp.robots[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
1084
|
+
# resp.robots[0].last_deployment_job #=> String
|
1085
|
+
# resp.robots[0].last_deployment_time #=> Time
|
1086
|
+
# resp.created_at #=> Time
|
1087
|
+
# resp.last_deployment_status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded"
|
1088
|
+
# resp.last_deployment_job #=> String
|
1089
|
+
# resp.last_deployment_time #=> Time
|
1090
|
+
#
|
1091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeFleet AWS API Documentation
|
1092
|
+
#
|
1093
|
+
# @overload describe_fleet(params = {})
|
1094
|
+
# @param [Hash] params ({})
|
1095
|
+
def describe_fleet(params = {}, options = {})
|
1096
|
+
req = build_request(:describe_fleet, params)
|
1097
|
+
req.send_request(options)
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# Describes a robot.
|
1101
|
+
#
|
1102
|
+
# @option params [required, String] :robot
|
1103
|
+
# The Amazon Resource Name (ARN) of the robot to be described.
|
1104
|
+
#
|
1105
|
+
# @return [Types::DescribeRobotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1106
|
+
#
|
1107
|
+
# * {Types::DescribeRobotResponse#arn #arn} => String
|
1108
|
+
# * {Types::DescribeRobotResponse#name #name} => String
|
1109
|
+
# * {Types::DescribeRobotResponse#fleet_arn #fleet_arn} => String
|
1110
|
+
# * {Types::DescribeRobotResponse#status #status} => String
|
1111
|
+
# * {Types::DescribeRobotResponse#greengrass_group_id #greengrass_group_id} => String
|
1112
|
+
# * {Types::DescribeRobotResponse#created_at #created_at} => Time
|
1113
|
+
# * {Types::DescribeRobotResponse#architecture #architecture} => String
|
1114
|
+
# * {Types::DescribeRobotResponse#last_deployment_job #last_deployment_job} => String
|
1115
|
+
# * {Types::DescribeRobotResponse#last_deployment_time #last_deployment_time} => Time
|
1116
|
+
#
|
1117
|
+
# @example Request syntax with placeholder values
|
1118
|
+
#
|
1119
|
+
# resp = client.describe_robot({
|
1120
|
+
# robot: "Arn", # required
|
1121
|
+
# })
|
1122
|
+
#
|
1123
|
+
# @example Response structure
|
1124
|
+
#
|
1125
|
+
# resp.arn #=> String
|
1126
|
+
# resp.name #=> String
|
1127
|
+
# resp.fleet_arn #=> String
|
1128
|
+
# resp.status #=> String, one of "Available", "Registered", "PendingNewDeployment", "Deploying", "Failed", "InSync", "NoResponse"
|
1129
|
+
# resp.greengrass_group_id #=> String
|
1130
|
+
# resp.created_at #=> Time
|
1131
|
+
# resp.architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
1132
|
+
# resp.last_deployment_job #=> String
|
1133
|
+
# resp.last_deployment_time #=> Time
|
1134
|
+
#
|
1135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobot AWS API Documentation
|
1136
|
+
#
|
1137
|
+
# @overload describe_robot(params = {})
|
1138
|
+
# @param [Hash] params ({})
|
1139
|
+
def describe_robot(params = {}, options = {})
|
1140
|
+
req = build_request(:describe_robot, params)
|
1141
|
+
req.send_request(options)
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
# Describes a robot application.
|
1145
|
+
#
|
1146
|
+
# @option params [required, String] :application
|
1147
|
+
# The Amazon Resource Name (ARN) of the robot application.
|
1148
|
+
#
|
1149
|
+
# @option params [String] :application_version
|
1150
|
+
# The version of the robot application to describe.
|
1151
|
+
#
|
1152
|
+
# @return [Types::DescribeRobotApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1153
|
+
#
|
1154
|
+
# * {Types::DescribeRobotApplicationResponse#arn #arn} => String
|
1155
|
+
# * {Types::DescribeRobotApplicationResponse#name #name} => String
|
1156
|
+
# * {Types::DescribeRobotApplicationResponse#version #version} => String
|
1157
|
+
# * {Types::DescribeRobotApplicationResponse#sources #sources} => Array<Types::Source>
|
1158
|
+
# * {Types::DescribeRobotApplicationResponse#robot_software_suite #robot_software_suite} => Types::RobotSoftwareSuite
|
1159
|
+
# * {Types::DescribeRobotApplicationResponse#revision_id #revision_id} => String
|
1160
|
+
# * {Types::DescribeRobotApplicationResponse#last_updated_at #last_updated_at} => Time
|
1161
|
+
#
|
1162
|
+
# @example Request syntax with placeholder values
|
1163
|
+
#
|
1164
|
+
# resp = client.describe_robot_application({
|
1165
|
+
# application: "Arn", # required
|
1166
|
+
# application_version: "Version",
|
1167
|
+
# })
|
1168
|
+
#
|
1169
|
+
# @example Response structure
|
1170
|
+
#
|
1171
|
+
# resp.arn #=> String
|
1172
|
+
# resp.name #=> String
|
1173
|
+
# resp.version #=> String
|
1174
|
+
# resp.sources #=> Array
|
1175
|
+
# resp.sources[0].s3_bucket #=> String
|
1176
|
+
# resp.sources[0].s3_key #=> String
|
1177
|
+
# resp.sources[0].etag #=> String
|
1178
|
+
# resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
1179
|
+
# resp.robot_software_suite.name #=> String, one of "ROS"
|
1180
|
+
# resp.robot_software_suite.version #=> String, one of "Kinetic"
|
1181
|
+
# resp.revision_id #=> String
|
1182
|
+
# resp.last_updated_at #=> Time
|
1183
|
+
#
|
1184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobotApplication AWS API Documentation
|
1185
|
+
#
|
1186
|
+
# @overload describe_robot_application(params = {})
|
1187
|
+
# @param [Hash] params ({})
|
1188
|
+
def describe_robot_application(params = {}, options = {})
|
1189
|
+
req = build_request(:describe_robot_application, params)
|
1190
|
+
req.send_request(options)
|
1191
|
+
end
|
1192
|
+
|
1193
|
+
# Describes a simulation application.
|
1194
|
+
#
|
1195
|
+
# @option params [required, String] :application
|
1196
|
+
# The application information for the simulation application.
|
1197
|
+
#
|
1198
|
+
# @option params [String] :application_version
|
1199
|
+
# The version of the simulation application to describe.
|
1200
|
+
#
|
1201
|
+
# @return [Types::DescribeSimulationApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1202
|
+
#
|
1203
|
+
# * {Types::DescribeSimulationApplicationResponse#arn #arn} => String
|
1204
|
+
# * {Types::DescribeSimulationApplicationResponse#name #name} => String
|
1205
|
+
# * {Types::DescribeSimulationApplicationResponse#version #version} => String
|
1206
|
+
# * {Types::DescribeSimulationApplicationResponse#sources #sources} => Array<Types::Source>
|
1207
|
+
# * {Types::DescribeSimulationApplicationResponse#simulation_software_suite #simulation_software_suite} => Types::SimulationSoftwareSuite
|
1208
|
+
# * {Types::DescribeSimulationApplicationResponse#robot_software_suite #robot_software_suite} => Types::RobotSoftwareSuite
|
1209
|
+
# * {Types::DescribeSimulationApplicationResponse#rendering_engine #rendering_engine} => Types::RenderingEngine
|
1210
|
+
# * {Types::DescribeSimulationApplicationResponse#revision_id #revision_id} => String
|
1211
|
+
# * {Types::DescribeSimulationApplicationResponse#last_updated_at #last_updated_at} => Time
|
1212
|
+
#
|
1213
|
+
# @example Request syntax with placeholder values
|
1214
|
+
#
|
1215
|
+
# resp = client.describe_simulation_application({
|
1216
|
+
# application: "Arn", # required
|
1217
|
+
# application_version: "Version",
|
1218
|
+
# })
|
1219
|
+
#
|
1220
|
+
# @example Response structure
|
1221
|
+
#
|
1222
|
+
# resp.arn #=> String
|
1223
|
+
# resp.name #=> String
|
1224
|
+
# resp.version #=> String
|
1225
|
+
# resp.sources #=> Array
|
1226
|
+
# resp.sources[0].s3_bucket #=> String
|
1227
|
+
# resp.sources[0].s3_key #=> String
|
1228
|
+
# resp.sources[0].etag #=> String
|
1229
|
+
# resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
1230
|
+
# resp.simulation_software_suite.name #=> String, one of "Gazebo"
|
1231
|
+
# resp.simulation_software_suite.version #=> String
|
1232
|
+
# resp.robot_software_suite.name #=> String, one of "ROS"
|
1233
|
+
# resp.robot_software_suite.version #=> String, one of "Kinetic"
|
1234
|
+
# resp.rendering_engine.name #=> String, one of "OGRE"
|
1235
|
+
# resp.rendering_engine.version #=> String
|
1236
|
+
# resp.revision_id #=> String
|
1237
|
+
# resp.last_updated_at #=> Time
|
1238
|
+
#
|
1239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationApplication AWS API Documentation
|
1240
|
+
#
|
1241
|
+
# @overload describe_simulation_application(params = {})
|
1242
|
+
# @param [Hash] params ({})
|
1243
|
+
def describe_simulation_application(params = {}, options = {})
|
1244
|
+
req = build_request(:describe_simulation_application, params)
|
1245
|
+
req.send_request(options)
|
1246
|
+
end
|
1247
|
+
|
1248
|
+
# Describes a simulation job.
|
1249
|
+
#
|
1250
|
+
# @option params [required, String] :job
|
1251
|
+
# The Amazon Resource Name (ARN) of the simulation job to be described.
|
1252
|
+
#
|
1253
|
+
# @return [Types::DescribeSimulationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1254
|
+
#
|
1255
|
+
# * {Types::DescribeSimulationJobResponse#arn #arn} => String
|
1256
|
+
# * {Types::DescribeSimulationJobResponse#name #name} => String
|
1257
|
+
# * {Types::DescribeSimulationJobResponse#status #status} => String
|
1258
|
+
# * {Types::DescribeSimulationJobResponse#last_updated_at #last_updated_at} => Time
|
1259
|
+
# * {Types::DescribeSimulationJobResponse#failure_behavior #failure_behavior} => String
|
1260
|
+
# * {Types::DescribeSimulationJobResponse#failure_code #failure_code} => String
|
1261
|
+
# * {Types::DescribeSimulationJobResponse#client_request_token #client_request_token} => String
|
1262
|
+
# * {Types::DescribeSimulationJobResponse#output_location #output_location} => Types::OutputLocation
|
1263
|
+
# * {Types::DescribeSimulationJobResponse#max_job_duration_in_seconds #max_job_duration_in_seconds} => Integer
|
1264
|
+
# * {Types::DescribeSimulationJobResponse#simulation_time_millis #simulation_time_millis} => Integer
|
1265
|
+
# * {Types::DescribeSimulationJobResponse#iam_role #iam_role} => String
|
1266
|
+
# * {Types::DescribeSimulationJobResponse#robot_applications #robot_applications} => Array<Types::RobotApplicationConfig>
|
1267
|
+
# * {Types::DescribeSimulationJobResponse#simulation_applications #simulation_applications} => Array<Types::SimulationApplicationConfig>
|
1268
|
+
# * {Types::DescribeSimulationJobResponse#vpc_config #vpc_config} => Types::VPCConfigResponse
|
1269
|
+
#
|
1270
|
+
# @example Request syntax with placeholder values
|
1271
|
+
#
|
1272
|
+
# resp = client.describe_simulation_job({
|
1273
|
+
# job: "Arn", # required
|
1274
|
+
# })
|
1275
|
+
#
|
1276
|
+
# @example Response structure
|
1277
|
+
#
|
1278
|
+
# resp.arn #=> String
|
1279
|
+
# resp.name #=> String
|
1280
|
+
# resp.status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
|
1281
|
+
# resp.last_updated_at #=> Time
|
1282
|
+
# resp.failure_behavior #=> String, one of "Fail", "Continue"
|
1283
|
+
# resp.failure_code #=> String, one of "InternalServiceError", "RobotApplicationCrash", "SimulationApplicationCrash", "BadPermissionsRobotApplication", "BadPermissionsSimulationApplication", "BadPermissionsS3Output", "BadPermissionsCloudwatchLogs", "SubnetIpLimitExceeded", "ENILimitExceeded", "BadPermissionsUserCredentials", "InvalidBundleRobotApplication", "InvalidBundleSimulationApplication", "RobotApplicationVersionMismatchedEtag", "SimulationApplicationVersionMismatchedEtag"
|
1284
|
+
# resp.client_request_token #=> String
|
1285
|
+
# resp.output_location.s3_bucket #=> String
|
1286
|
+
# resp.output_location.s3_prefix #=> String
|
1287
|
+
# resp.max_job_duration_in_seconds #=> Integer
|
1288
|
+
# resp.simulation_time_millis #=> Integer
|
1289
|
+
# resp.iam_role #=> String
|
1290
|
+
# resp.robot_applications #=> Array
|
1291
|
+
# resp.robot_applications[0].application #=> String
|
1292
|
+
# resp.robot_applications[0].application_version #=> String
|
1293
|
+
# resp.robot_applications[0].launch_config.package_name #=> String
|
1294
|
+
# resp.robot_applications[0].launch_config.launch_file #=> String
|
1295
|
+
# resp.robot_applications[0].launch_config.environment_variables #=> Hash
|
1296
|
+
# resp.robot_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
1297
|
+
# resp.simulation_applications #=> Array
|
1298
|
+
# resp.simulation_applications[0].application #=> String
|
1299
|
+
# resp.simulation_applications[0].application_version #=> String
|
1300
|
+
# resp.simulation_applications[0].launch_config.package_name #=> String
|
1301
|
+
# resp.simulation_applications[0].launch_config.launch_file #=> String
|
1302
|
+
# resp.simulation_applications[0].launch_config.environment_variables #=> Hash
|
1303
|
+
# resp.simulation_applications[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
1304
|
+
# resp.vpc_config.subnets #=> Array
|
1305
|
+
# resp.vpc_config.subnets[0] #=> String
|
1306
|
+
# resp.vpc_config.security_groups #=> Array
|
1307
|
+
# resp.vpc_config.security_groups[0] #=> String
|
1308
|
+
# resp.vpc_config.vpc_id #=> String
|
1309
|
+
# resp.vpc_config.assign_public_ip #=> Boolean
|
1310
|
+
#
|
1311
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJob AWS API Documentation
|
1312
|
+
#
|
1313
|
+
# @overload describe_simulation_job(params = {})
|
1314
|
+
# @param [Hash] params ({})
|
1315
|
+
def describe_simulation_job(params = {}, options = {})
|
1316
|
+
req = build_request(:describe_simulation_job, params)
|
1317
|
+
req.send_request(options)
|
1318
|
+
end
|
1319
|
+
|
1320
|
+
# Returns a list of deployment jobs for a fleet. You can optionally
|
1321
|
+
# provide filters to retrieve specific deployment jobs.
|
1322
|
+
#
|
1323
|
+
# @option params [Array<Types::Filter>] :filters
|
1324
|
+
# Optional filters to limit results.
|
1325
|
+
#
|
1326
|
+
# @option params [String] :next_token
|
1327
|
+
# The `nextToken` value returned from a previous paginated
|
1328
|
+
# `ListDeploymentJobs` request where `maxResults` was used and the
|
1329
|
+
# results exceeded the value of that parameter. Pagination continues
|
1330
|
+
# from the end of the previous results that returned the `nextToken`
|
1331
|
+
# value.
|
1332
|
+
#
|
1333
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
1334
|
+
# to retrieve the next items in a list and not for other programmatic
|
1335
|
+
# purposes.
|
1336
|
+
#
|
1337
|
+
# </note>
|
1338
|
+
#
|
1339
|
+
# @option params [Integer] :max_results
|
1340
|
+
# The maximum number of deployment job results returned by
|
1341
|
+
# `ListDeploymentJobs` in paginated output. When this parameter is used,
|
1342
|
+
# `ListDeploymentJobs` only returns `maxResults` results in a single
|
1343
|
+
# page along with a `nextToken` response element. The remaining results
|
1344
|
+
# of the initial request can be seen by sending another
|
1345
|
+
# `ListDeploymentJobs` request with the returned `nextToken` value. This
|
1346
|
+
# value can be between 1 and 100. If this parameter is not used, then
|
1347
|
+
# `ListDeploymentJobs` returns up to 100 results and a `nextToken` value
|
1348
|
+
# if applicable.
|
1349
|
+
#
|
1350
|
+
# @return [Types::ListDeploymentJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1351
|
+
#
|
1352
|
+
# * {Types::ListDeploymentJobsResponse#deployment_jobs #deployment_jobs} => Array<Types::DeploymentJob>
|
1353
|
+
# * {Types::ListDeploymentJobsResponse#next_token #next_token} => String
|
1354
|
+
#
|
1355
|
+
# @example Request syntax with placeholder values
|
1356
|
+
#
|
1357
|
+
# resp = client.list_deployment_jobs({
|
1358
|
+
# filters: [
|
1359
|
+
# {
|
1360
|
+
# name: "Name",
|
1361
|
+
# values: ["Name"],
|
1362
|
+
# },
|
1363
|
+
# ],
|
1364
|
+
# next_token: "PaginationToken",
|
1365
|
+
# max_results: 1,
|
1366
|
+
# })
|
1367
|
+
#
|
1368
|
+
# @example Response structure
|
1369
|
+
#
|
1370
|
+
# resp.deployment_jobs #=> Array
|
1371
|
+
# resp.deployment_jobs[0].arn #=> String
|
1372
|
+
# resp.deployment_jobs[0].fleet #=> String
|
1373
|
+
# resp.deployment_jobs[0].status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded"
|
1374
|
+
# resp.deployment_jobs[0].deployment_application_configs #=> Array
|
1375
|
+
# resp.deployment_jobs[0].deployment_application_configs[0].application #=> String
|
1376
|
+
# resp.deployment_jobs[0].deployment_application_configs[0].application_version #=> String
|
1377
|
+
# resp.deployment_jobs[0].deployment_application_configs[0].launch_config.package_name #=> String
|
1378
|
+
# resp.deployment_jobs[0].deployment_application_configs[0].launch_config.pre_launch_file #=> String
|
1379
|
+
# resp.deployment_jobs[0].deployment_application_configs[0].launch_config.launch_file #=> String
|
1380
|
+
# resp.deployment_jobs[0].deployment_application_configs[0].launch_config.post_launch_file #=> String
|
1381
|
+
# resp.deployment_jobs[0].deployment_application_configs[0].launch_config.environment_variables #=> Hash
|
1382
|
+
# resp.deployment_jobs[0].deployment_application_configs[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
1383
|
+
# resp.deployment_jobs[0].deployment_config.concurrent_deployment_percentage #=> Integer
|
1384
|
+
# resp.deployment_jobs[0].deployment_config.failure_threshold_percentage #=> Integer
|
1385
|
+
# resp.deployment_jobs[0].failure_reason #=> String
|
1386
|
+
# resp.deployment_jobs[0].failure_code #=> String, one of "ResourceNotFound", "FailureThresholdBreached", "RobotDeploymentNoResponse", "GreengrassDeploymentFailed", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "InternalServerError"
|
1387
|
+
# resp.deployment_jobs[0].created_at #=> Time
|
1388
|
+
# resp.next_token #=> String
|
1389
|
+
#
|
1390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListDeploymentJobs AWS API Documentation
|
1391
|
+
#
|
1392
|
+
# @overload list_deployment_jobs(params = {})
|
1393
|
+
# @param [Hash] params ({})
|
1394
|
+
def list_deployment_jobs(params = {}, options = {})
|
1395
|
+
req = build_request(:list_deployment_jobs, params)
|
1396
|
+
req.send_request(options)
|
1397
|
+
end
|
1398
|
+
|
1399
|
+
# Returns a list of fleets. You can optionally provide filters to
|
1400
|
+
# retrieve specific fleets.
|
1401
|
+
#
|
1402
|
+
# @option params [String] :next_token
|
1403
|
+
# The `nextToken` value returned from a previous paginated `ListFleets`
|
1404
|
+
# request where `maxResults` was used and the results exceeded the value
|
1405
|
+
# of that parameter. Pagination continues from the end of the previous
|
1406
|
+
# results that returned the `nextToken` value.
|
1407
|
+
#
|
1408
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
1409
|
+
# to retrieve the next items in a list and not for other programmatic
|
1410
|
+
# purposes.
|
1411
|
+
#
|
1412
|
+
# </note>
|
1413
|
+
#
|
1414
|
+
# @option params [Integer] :max_results
|
1415
|
+
# The maximum number of deployment job results returned by `ListFleets`
|
1416
|
+
# in paginated output. When this parameter is used, `ListFleets` only
|
1417
|
+
# returns `maxResults` results in a single page along with a `nextToken`
|
1418
|
+
# response element. The remaining results of the initial request can be
|
1419
|
+
# seen by sending another `ListFleets` request with the returned
|
1420
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
1421
|
+
# parameter is not used, then `ListFleets` returns up to 100 results and
|
1422
|
+
# a `nextToken` value if applicable.
|
1423
|
+
#
|
1424
|
+
# @option params [Array<Types::Filter>] :filters
|
1425
|
+
# Optional filters to limit results.
|
1426
|
+
#
|
1427
|
+
# @return [Types::ListFleetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1428
|
+
#
|
1429
|
+
# * {Types::ListFleetsResponse#fleet_details #fleet_details} => Array<Types::Fleet>
|
1430
|
+
# * {Types::ListFleetsResponse#next_token #next_token} => String
|
1431
|
+
#
|
1432
|
+
# @example Request syntax with placeholder values
|
1433
|
+
#
|
1434
|
+
# resp = client.list_fleets({
|
1435
|
+
# next_token: "PaginationToken",
|
1436
|
+
# max_results: 1,
|
1437
|
+
# filters: [
|
1438
|
+
# {
|
1439
|
+
# name: "Name",
|
1440
|
+
# values: ["Name"],
|
1441
|
+
# },
|
1442
|
+
# ],
|
1443
|
+
# })
|
1444
|
+
#
|
1445
|
+
# @example Response structure
|
1446
|
+
#
|
1447
|
+
# resp.fleet_details #=> Array
|
1448
|
+
# resp.fleet_details[0].name #=> String
|
1449
|
+
# resp.fleet_details[0].arn #=> String
|
1450
|
+
# resp.fleet_details[0].created_at #=> Time
|
1451
|
+
# resp.fleet_details[0].last_deployment_status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded"
|
1452
|
+
# resp.fleet_details[0].last_deployment_job #=> String
|
1453
|
+
# resp.fleet_details[0].last_deployment_time #=> Time
|
1454
|
+
# resp.next_token #=> String
|
1455
|
+
#
|
1456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListFleets AWS API Documentation
|
1457
|
+
#
|
1458
|
+
# @overload list_fleets(params = {})
|
1459
|
+
# @param [Hash] params ({})
|
1460
|
+
def list_fleets(params = {}, options = {})
|
1461
|
+
req = build_request(:list_fleets, params)
|
1462
|
+
req.send_request(options)
|
1463
|
+
end
|
1464
|
+
|
1465
|
+
# Returns a list of robot application. You can optionally provide
|
1466
|
+
# filters to retrieve specific robot applications.
|
1467
|
+
#
|
1468
|
+
# @option params [String] :version_qualifier
|
1469
|
+
# The version qualifier of the robot application.
|
1470
|
+
#
|
1471
|
+
# @option params [String] :next_token
|
1472
|
+
# The `nextToken` value returned from a previous paginated
|
1473
|
+
# `ListRobotApplications` request where `maxResults` was used and the
|
1474
|
+
# results exceeded the value of that parameter. Pagination continues
|
1475
|
+
# from the end of the previous results that returned the `nextToken`
|
1476
|
+
# value.
|
1477
|
+
#
|
1478
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
1479
|
+
# to retrieve the next items in a list and not for other programmatic
|
1480
|
+
# purposes.
|
1481
|
+
#
|
1482
|
+
# </note>
|
1483
|
+
#
|
1484
|
+
# @option params [Integer] :max_results
|
1485
|
+
# The maximum number of deployment job results returned by
|
1486
|
+
# `ListRobotApplications` in paginated output. When this parameter is
|
1487
|
+
# used, `ListRobotApplications` only returns `maxResults` results in a
|
1488
|
+
# single page along with a `nextToken` response element. The remaining
|
1489
|
+
# results of the initial request can be seen by sending another
|
1490
|
+
# `ListFleets` request with the returned `nextToken` value. This value
|
1491
|
+
# can be between 1 and 100. If this parameter is not used, then
|
1492
|
+
# `ListRobotApplications` returns up to 100 results and a `nextToken`
|
1493
|
+
# value if applicable.
|
1494
|
+
#
|
1495
|
+
# @option params [Array<Types::Filter>] :filters
|
1496
|
+
# Optional filters to limit results.
|
1497
|
+
#
|
1498
|
+
# @return [Types::ListRobotApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1499
|
+
#
|
1500
|
+
# * {Types::ListRobotApplicationsResponse#robot_application_summaries #robot_application_summaries} => Array<Types::RobotApplicationSummary>
|
1501
|
+
# * {Types::ListRobotApplicationsResponse#next_token #next_token} => String
|
1502
|
+
#
|
1503
|
+
# @example Request syntax with placeholder values
|
1504
|
+
#
|
1505
|
+
# resp = client.list_robot_applications({
|
1506
|
+
# version_qualifier: "VersionQualifier",
|
1507
|
+
# next_token: "PaginationToken",
|
1508
|
+
# max_results: 1,
|
1509
|
+
# filters: [
|
1510
|
+
# {
|
1511
|
+
# name: "Name",
|
1512
|
+
# values: ["Name"],
|
1513
|
+
# },
|
1514
|
+
# ],
|
1515
|
+
# })
|
1516
|
+
#
|
1517
|
+
# @example Response structure
|
1518
|
+
#
|
1519
|
+
# resp.robot_application_summaries #=> Array
|
1520
|
+
# resp.robot_application_summaries[0].name #=> String
|
1521
|
+
# resp.robot_application_summaries[0].arn #=> String
|
1522
|
+
# resp.robot_application_summaries[0].version #=> String
|
1523
|
+
# resp.robot_application_summaries[0].last_updated_at #=> Time
|
1524
|
+
# resp.next_token #=> String
|
1525
|
+
#
|
1526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobotApplications AWS API Documentation
|
1527
|
+
#
|
1528
|
+
# @overload list_robot_applications(params = {})
|
1529
|
+
# @param [Hash] params ({})
|
1530
|
+
def list_robot_applications(params = {}, options = {})
|
1531
|
+
req = build_request(:list_robot_applications, params)
|
1532
|
+
req.send_request(options)
|
1533
|
+
end
|
1534
|
+
|
1535
|
+
# Returns a list of robots. You can optionally provide filters to
|
1536
|
+
# retrieve specific robots.
|
1537
|
+
#
|
1538
|
+
# @option params [String] :next_token
|
1539
|
+
# The `nextToken` value returned from a previous paginated `ListRobots`
|
1540
|
+
# request where `maxResults` was used and the results exceeded the value
|
1541
|
+
# of that parameter. Pagination continues from the end of the previous
|
1542
|
+
# results that returned the `nextToken` value.
|
1543
|
+
#
|
1544
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
1545
|
+
# to retrieve the next items in a list and not for other programmatic
|
1546
|
+
# purposes.
|
1547
|
+
#
|
1548
|
+
# </note>
|
1549
|
+
#
|
1550
|
+
# @option params [Integer] :max_results
|
1551
|
+
# The maximum number of deployment job results returned by `ListRobots`
|
1552
|
+
# in paginated output. When this parameter is used, `ListRobots` only
|
1553
|
+
# returns `maxResults` results in a single page along with a `nextToken`
|
1554
|
+
# response element. The remaining results of the initial request can be
|
1555
|
+
# seen by sending another `ListFleets` request with the returned
|
1556
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
1557
|
+
# parameter is not used, then `ListRobots` returns up to 100 results and
|
1558
|
+
# a `nextToken` value if applicable.
|
1559
|
+
#
|
1560
|
+
# @option params [Array<Types::Filter>] :filters
|
1561
|
+
# Optional filters to limit results.
|
1562
|
+
#
|
1563
|
+
# @return [Types::ListRobotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1564
|
+
#
|
1565
|
+
# * {Types::ListRobotsResponse#robots #robots} => Array<Types::Robot>
|
1566
|
+
# * {Types::ListRobotsResponse#next_token #next_token} => String
|
1567
|
+
#
|
1568
|
+
# @example Request syntax with placeholder values
|
1569
|
+
#
|
1570
|
+
# resp = client.list_robots({
|
1571
|
+
# next_token: "PaginationToken",
|
1572
|
+
# max_results: 1,
|
1573
|
+
# filters: [
|
1574
|
+
# {
|
1575
|
+
# name: "Name",
|
1576
|
+
# values: ["Name"],
|
1577
|
+
# },
|
1578
|
+
# ],
|
1579
|
+
# })
|
1580
|
+
#
|
1581
|
+
# @example Response structure
|
1582
|
+
#
|
1583
|
+
# resp.robots #=> Array
|
1584
|
+
# resp.robots[0].arn #=> String
|
1585
|
+
# resp.robots[0].name #=> String
|
1586
|
+
# resp.robots[0].fleet_arn #=> String
|
1587
|
+
# resp.robots[0].status #=> String, one of "Available", "Registered", "PendingNewDeployment", "Deploying", "Failed", "InSync", "NoResponse"
|
1588
|
+
# resp.robots[0].green_grass_group_id #=> String
|
1589
|
+
# resp.robots[0].created_at #=> Time
|
1590
|
+
# resp.robots[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
1591
|
+
# resp.robots[0].last_deployment_job #=> String
|
1592
|
+
# resp.robots[0].last_deployment_time #=> Time
|
1593
|
+
# resp.next_token #=> String
|
1594
|
+
#
|
1595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobots AWS API Documentation
|
1596
|
+
#
|
1597
|
+
# @overload list_robots(params = {})
|
1598
|
+
# @param [Hash] params ({})
|
1599
|
+
def list_robots(params = {}, options = {})
|
1600
|
+
req = build_request(:list_robots, params)
|
1601
|
+
req.send_request(options)
|
1602
|
+
end
|
1603
|
+
|
1604
|
+
# Returns a list of simulation applications. You can optionally provide
|
1605
|
+
# filters to retrieve specific simulation applications.
|
1606
|
+
#
|
1607
|
+
# @option params [String] :version_qualifier
|
1608
|
+
# The version qualifier of the simulation application.
|
1609
|
+
#
|
1610
|
+
# @option params [String] :next_token
|
1611
|
+
# The `nextToken` value returned from a previous paginated
|
1612
|
+
# `ListSimulationApplications` request where `maxResults` was used and
|
1613
|
+
# the results exceeded the value of that parameter. Pagination continues
|
1614
|
+
# from the end of the previous results that returned the `nextToken`
|
1615
|
+
# value.
|
1616
|
+
#
|
1617
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
1618
|
+
# to retrieve the next items in a list and not for other programmatic
|
1619
|
+
# purposes.
|
1620
|
+
#
|
1621
|
+
# </note>
|
1622
|
+
#
|
1623
|
+
# @option params [Integer] :max_results
|
1624
|
+
# The maximum number of deployment job results returned by
|
1625
|
+
# `ListSimulationApplications` in paginated output. When this parameter
|
1626
|
+
# is used, `ListSimulationApplications` only returns `maxResults`
|
1627
|
+
# results in a single page along with a `nextToken` response element.
|
1628
|
+
# The remaining results of the initial request can be seen by sending
|
1629
|
+
# another `ListFleets` request with the returned `nextToken` value. This
|
1630
|
+
# value can be between 1 and 100. If this parameter is not used, then
|
1631
|
+
# `ListSimulationApplications` returns up to 100 results and a
|
1632
|
+
# `nextToken` value if applicable.
|
1633
|
+
#
|
1634
|
+
# @option params [Array<Types::Filter>] :filters
|
1635
|
+
# Optional list of filters to limit results. The only valid filter name
|
1636
|
+
# is `name`.
|
1637
|
+
#
|
1638
|
+
# @return [Types::ListSimulationApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1639
|
+
#
|
1640
|
+
# * {Types::ListSimulationApplicationsResponse#simulation_application_summaries #simulation_application_summaries} => Array<Types::SimulationApplicationSummary>
|
1641
|
+
# * {Types::ListSimulationApplicationsResponse#next_token #next_token} => String
|
1642
|
+
#
|
1643
|
+
# @example Request syntax with placeholder values
|
1644
|
+
#
|
1645
|
+
# resp = client.list_simulation_applications({
|
1646
|
+
# version_qualifier: "VersionQualifier",
|
1647
|
+
# next_token: "PaginationToken",
|
1648
|
+
# max_results: 1,
|
1649
|
+
# filters: [
|
1650
|
+
# {
|
1651
|
+
# name: "Name",
|
1652
|
+
# values: ["Name"],
|
1653
|
+
# },
|
1654
|
+
# ],
|
1655
|
+
# })
|
1656
|
+
#
|
1657
|
+
# @example Response structure
|
1658
|
+
#
|
1659
|
+
# resp.simulation_application_summaries #=> Array
|
1660
|
+
# resp.simulation_application_summaries[0].name #=> String
|
1661
|
+
# resp.simulation_application_summaries[0].arn #=> String
|
1662
|
+
# resp.simulation_application_summaries[0].version #=> String
|
1663
|
+
# resp.simulation_application_summaries[0].last_updated_at #=> Time
|
1664
|
+
# resp.next_token #=> String
|
1665
|
+
#
|
1666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationApplications AWS API Documentation
|
1667
|
+
#
|
1668
|
+
# @overload list_simulation_applications(params = {})
|
1669
|
+
# @param [Hash] params ({})
|
1670
|
+
def list_simulation_applications(params = {}, options = {})
|
1671
|
+
req = build_request(:list_simulation_applications, params)
|
1672
|
+
req.send_request(options)
|
1673
|
+
end
|
1674
|
+
|
1675
|
+
# Returns a list of simulation jobs. You can optionally provide filters
|
1676
|
+
# to retrieve specific simulation jobs.
|
1677
|
+
#
|
1678
|
+
# @option params [String] :next_token
|
1679
|
+
# The `nextToken` value returned from a previous paginated
|
1680
|
+
# `ListSimulationJobs` request where `maxResults` was used and the
|
1681
|
+
# results exceeded the value of that parameter. Pagination continues
|
1682
|
+
# from the end of the previous results that returned the `nextToken`
|
1683
|
+
# value.
|
1684
|
+
#
|
1685
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
1686
|
+
# to retrieve the next items in a list and not for other programmatic
|
1687
|
+
# purposes.
|
1688
|
+
#
|
1689
|
+
# </note>
|
1690
|
+
#
|
1691
|
+
# @option params [Integer] :max_results
|
1692
|
+
# The maximum number of deployment job results returned by
|
1693
|
+
# `ListSimulationJobs` in paginated output. When this parameter is used,
|
1694
|
+
# `ListSimulationJobs` only returns `maxResults` results in a single
|
1695
|
+
# page along with a `nextToken` response element. The remaining results
|
1696
|
+
# of the initial request can be seen by sending another `ListFleets`
|
1697
|
+
# request with the returned `nextToken` value. This value can be between
|
1698
|
+
# 1 and 100. If this parameter is not used, then `ListSimulationJobs`
|
1699
|
+
# returns up to 100 results and a `nextToken` value if applicable.
|
1700
|
+
#
|
1701
|
+
# @option params [Array<Types::Filter>] :filters
|
1702
|
+
# Optional filters to limit results.
|
1703
|
+
#
|
1704
|
+
# @return [Types::ListSimulationJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1705
|
+
#
|
1706
|
+
# * {Types::ListSimulationJobsResponse#simulation_job_summaries #simulation_job_summaries} => Array<Types::SimulationJobSummary>
|
1707
|
+
# * {Types::ListSimulationJobsResponse#next_token #next_token} => String
|
1708
|
+
#
|
1709
|
+
# @example Request syntax with placeholder values
|
1710
|
+
#
|
1711
|
+
# resp = client.list_simulation_jobs({
|
1712
|
+
# next_token: "PaginationToken",
|
1713
|
+
# max_results: 1,
|
1714
|
+
# filters: [
|
1715
|
+
# {
|
1716
|
+
# name: "Name",
|
1717
|
+
# values: ["Name"],
|
1718
|
+
# },
|
1719
|
+
# ],
|
1720
|
+
# })
|
1721
|
+
#
|
1722
|
+
# @example Response structure
|
1723
|
+
#
|
1724
|
+
# resp.simulation_job_summaries #=> Array
|
1725
|
+
# resp.simulation_job_summaries[0].arn #=> String
|
1726
|
+
# resp.simulation_job_summaries[0].last_updated_at #=> Time
|
1727
|
+
# resp.simulation_job_summaries[0].name #=> String
|
1728
|
+
# resp.simulation_job_summaries[0].status #=> String, one of "Pending", "Preparing", "Running", "Restarting", "Completed", "Failed", "RunningFailed", "Terminating", "Terminated", "Canceled"
|
1729
|
+
# resp.simulation_job_summaries[0].simulation_application_names #=> Array
|
1730
|
+
# resp.simulation_job_summaries[0].simulation_application_names[0] #=> String
|
1731
|
+
# resp.simulation_job_summaries[0].robot_application_names #=> Array
|
1732
|
+
# resp.simulation_job_summaries[0].robot_application_names[0] #=> String
|
1733
|
+
# resp.next_token #=> String
|
1734
|
+
#
|
1735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobs AWS API Documentation
|
1736
|
+
#
|
1737
|
+
# @overload list_simulation_jobs(params = {})
|
1738
|
+
# @param [Hash] params ({})
|
1739
|
+
def list_simulation_jobs(params = {}, options = {})
|
1740
|
+
req = build_request(:list_simulation_jobs, params)
|
1741
|
+
req.send_request(options)
|
1742
|
+
end
|
1743
|
+
|
1744
|
+
# Registers a robot with a fleet.
|
1745
|
+
#
|
1746
|
+
# @option params [required, String] :fleet
|
1747
|
+
# The Amazon Resource Name (ARN) of the fleet.
|
1748
|
+
#
|
1749
|
+
# @option params [required, String] :robot
|
1750
|
+
# The Amazon Resource Name (ARN) of the robot.
|
1751
|
+
#
|
1752
|
+
# @return [Types::RegisterRobotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1753
|
+
#
|
1754
|
+
# * {Types::RegisterRobotResponse#fleet #fleet} => String
|
1755
|
+
# * {Types::RegisterRobotResponse#robot #robot} => String
|
1756
|
+
#
|
1757
|
+
# @example Request syntax with placeholder values
|
1758
|
+
#
|
1759
|
+
# resp = client.register_robot({
|
1760
|
+
# fleet: "Arn", # required
|
1761
|
+
# robot: "Arn", # required
|
1762
|
+
# })
|
1763
|
+
#
|
1764
|
+
# @example Response structure
|
1765
|
+
#
|
1766
|
+
# resp.fleet #=> String
|
1767
|
+
# resp.robot #=> String
|
1768
|
+
#
|
1769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RegisterRobot AWS API Documentation
|
1770
|
+
#
|
1771
|
+
# @overload register_robot(params = {})
|
1772
|
+
# @param [Hash] params ({})
|
1773
|
+
def register_robot(params = {}, options = {})
|
1774
|
+
req = build_request(:register_robot, params)
|
1775
|
+
req.send_request(options)
|
1776
|
+
end
|
1777
|
+
|
1778
|
+
# Restarts a running simulation job.
|
1779
|
+
#
|
1780
|
+
# @option params [required, String] :job
|
1781
|
+
# The Amazon Resource Name (ARN) of the simulation job.
|
1782
|
+
#
|
1783
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1784
|
+
#
|
1785
|
+
# @example Request syntax with placeholder values
|
1786
|
+
#
|
1787
|
+
# resp = client.restart_simulation_job({
|
1788
|
+
# job: "Arn", # required
|
1789
|
+
# })
|
1790
|
+
#
|
1791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RestartSimulationJob AWS API Documentation
|
1792
|
+
#
|
1793
|
+
# @overload restart_simulation_job(params = {})
|
1794
|
+
# @param [Hash] params ({})
|
1795
|
+
def restart_simulation_job(params = {}, options = {})
|
1796
|
+
req = build_request(:restart_simulation_job, params)
|
1797
|
+
req.send_request(options)
|
1798
|
+
end
|
1799
|
+
|
1800
|
+
# Syncrhonizes robots in a fleet to the latest deployment. This is
|
1801
|
+
# helpful if robots were added after a deployment.
|
1802
|
+
#
|
1803
|
+
# @option params [required, String] :client_request_token
|
1804
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
1805
|
+
# idempotency of the request.
|
1806
|
+
#
|
1807
|
+
# **A suitable default value is auto-generated.** You should normally
|
1808
|
+
# not need to pass this option.**
|
1809
|
+
#
|
1810
|
+
# @option params [required, String] :fleet
|
1811
|
+
# The target fleet for the synchronization.
|
1812
|
+
#
|
1813
|
+
# @return [Types::SyncDeploymentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1814
|
+
#
|
1815
|
+
# * {Types::SyncDeploymentJobResponse#arn #arn} => String
|
1816
|
+
# * {Types::SyncDeploymentJobResponse#fleet #fleet} => String
|
1817
|
+
# * {Types::SyncDeploymentJobResponse#status #status} => String
|
1818
|
+
# * {Types::SyncDeploymentJobResponse#deployment_config #deployment_config} => Types::DeploymentConfig
|
1819
|
+
# * {Types::SyncDeploymentJobResponse#deployment_application_configs #deployment_application_configs} => Array<Types::DeploymentApplicationConfig>
|
1820
|
+
# * {Types::SyncDeploymentJobResponse#failure_reason #failure_reason} => String
|
1821
|
+
# * {Types::SyncDeploymentJobResponse#failure_code #failure_code} => String
|
1822
|
+
# * {Types::SyncDeploymentJobResponse#created_at #created_at} => Time
|
1823
|
+
#
|
1824
|
+
# @example Request syntax with placeholder values
|
1825
|
+
#
|
1826
|
+
# resp = client.sync_deployment_job({
|
1827
|
+
# client_request_token: "ClientRequestToken", # required
|
1828
|
+
# fleet: "Arn", # required
|
1829
|
+
# })
|
1830
|
+
#
|
1831
|
+
# @example Response structure
|
1832
|
+
#
|
1833
|
+
# resp.arn #=> String
|
1834
|
+
# resp.fleet #=> String
|
1835
|
+
# resp.status #=> String, one of "Pending", "Preparing", "InProgress", "Failed", "Succeeded"
|
1836
|
+
# resp.deployment_config.concurrent_deployment_percentage #=> Integer
|
1837
|
+
# resp.deployment_config.failure_threshold_percentage #=> Integer
|
1838
|
+
# resp.deployment_application_configs #=> Array
|
1839
|
+
# resp.deployment_application_configs[0].application #=> String
|
1840
|
+
# resp.deployment_application_configs[0].application_version #=> String
|
1841
|
+
# resp.deployment_application_configs[0].launch_config.package_name #=> String
|
1842
|
+
# resp.deployment_application_configs[0].launch_config.pre_launch_file #=> String
|
1843
|
+
# resp.deployment_application_configs[0].launch_config.launch_file #=> String
|
1844
|
+
# resp.deployment_application_configs[0].launch_config.post_launch_file #=> String
|
1845
|
+
# resp.deployment_application_configs[0].launch_config.environment_variables #=> Hash
|
1846
|
+
# resp.deployment_application_configs[0].launch_config.environment_variables["EnvironmentVariableKey"] #=> String
|
1847
|
+
# resp.failure_reason #=> String
|
1848
|
+
# resp.failure_code #=> String, one of "ResourceNotFound", "FailureThresholdBreached", "RobotDeploymentNoResponse", "GreengrassDeploymentFailed", "MissingRobotArchitecture", "MissingRobotApplicationArchitecture", "MissingRobotDeploymentResource", "GreengrassGroupVersionDoesNotExist", "ExtractingBundleFailure", "PreLaunchFileFailure", "PostLaunchFileFailure", "BadPermissionError", "InternalServerError"
|
1849
|
+
# resp.created_at #=> Time
|
1850
|
+
#
|
1851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SyncDeploymentJob AWS API Documentation
|
1852
|
+
#
|
1853
|
+
# @overload sync_deployment_job(params = {})
|
1854
|
+
# @param [Hash] params ({})
|
1855
|
+
def sync_deployment_job(params = {}, options = {})
|
1856
|
+
req = build_request(:sync_deployment_job, params)
|
1857
|
+
req.send_request(options)
|
1858
|
+
end
|
1859
|
+
|
1860
|
+
# Updates a robot application.
|
1861
|
+
#
|
1862
|
+
# @option params [required, String] :application
|
1863
|
+
# The application information for the robot application.
|
1864
|
+
#
|
1865
|
+
# @option params [required, Array<Types::SourceConfig>] :sources
|
1866
|
+
# The sources of the robot application.
|
1867
|
+
#
|
1868
|
+
# @option params [required, Types::RobotSoftwareSuite] :robot_software_suite
|
1869
|
+
# The robot software suite used by the robot application.
|
1870
|
+
#
|
1871
|
+
# @option params [String] :current_revision_id
|
1872
|
+
# The revision id for the robot application.
|
1873
|
+
#
|
1874
|
+
# @return [Types::UpdateRobotApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1875
|
+
#
|
1876
|
+
# * {Types::UpdateRobotApplicationResponse#arn #arn} => String
|
1877
|
+
# * {Types::UpdateRobotApplicationResponse#name #name} => String
|
1878
|
+
# * {Types::UpdateRobotApplicationResponse#version #version} => String
|
1879
|
+
# * {Types::UpdateRobotApplicationResponse#sources #sources} => Array<Types::Source>
|
1880
|
+
# * {Types::UpdateRobotApplicationResponse#robot_software_suite #robot_software_suite} => Types::RobotSoftwareSuite
|
1881
|
+
# * {Types::UpdateRobotApplicationResponse#last_updated_at #last_updated_at} => Time
|
1882
|
+
# * {Types::UpdateRobotApplicationResponse#revision_id #revision_id} => String
|
1883
|
+
#
|
1884
|
+
# @example Request syntax with placeholder values
|
1885
|
+
#
|
1886
|
+
# resp = client.update_robot_application({
|
1887
|
+
# application: "Arn", # required
|
1888
|
+
# sources: [ # required
|
1889
|
+
# {
|
1890
|
+
# s3_bucket: "S3Bucket",
|
1891
|
+
# s3_key: "S3Key",
|
1892
|
+
# architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
|
1893
|
+
# },
|
1894
|
+
# ],
|
1895
|
+
# robot_software_suite: { # required
|
1896
|
+
# name: "ROS", # accepts ROS
|
1897
|
+
# version: "Kinetic", # accepts Kinetic
|
1898
|
+
# },
|
1899
|
+
# current_revision_id: "RevisionId",
|
1900
|
+
# })
|
1901
|
+
#
|
1902
|
+
# @example Response structure
|
1903
|
+
#
|
1904
|
+
# resp.arn #=> String
|
1905
|
+
# resp.name #=> String
|
1906
|
+
# resp.version #=> String
|
1907
|
+
# resp.sources #=> Array
|
1908
|
+
# resp.sources[0].s3_bucket #=> String
|
1909
|
+
# resp.sources[0].s3_key #=> String
|
1910
|
+
# resp.sources[0].etag #=> String
|
1911
|
+
# resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
1912
|
+
# resp.robot_software_suite.name #=> String, one of "ROS"
|
1913
|
+
# resp.robot_software_suite.version #=> String, one of "Kinetic"
|
1914
|
+
# resp.last_updated_at #=> Time
|
1915
|
+
# resp.revision_id #=> String
|
1916
|
+
#
|
1917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateRobotApplication AWS API Documentation
|
1918
|
+
#
|
1919
|
+
# @overload update_robot_application(params = {})
|
1920
|
+
# @param [Hash] params ({})
|
1921
|
+
def update_robot_application(params = {}, options = {})
|
1922
|
+
req = build_request(:update_robot_application, params)
|
1923
|
+
req.send_request(options)
|
1924
|
+
end
|
1925
|
+
|
1926
|
+
# Updates a simulation application.
|
1927
|
+
#
|
1928
|
+
# @option params [required, String] :application
|
1929
|
+
# The application information for the simulation application.
|
1930
|
+
#
|
1931
|
+
# @option params [required, Array<Types::SourceConfig>] :sources
|
1932
|
+
# The sources of the simulation application.
|
1933
|
+
#
|
1934
|
+
# @option params [required, Types::SimulationSoftwareSuite] :simulation_software_suite
|
1935
|
+
# The simulation software suite used by the simulation application.
|
1936
|
+
#
|
1937
|
+
# @option params [required, Types::RobotSoftwareSuite] :robot_software_suite
|
1938
|
+
# Information about the robot software suite.
|
1939
|
+
#
|
1940
|
+
# @option params [required, Types::RenderingEngine] :rendering_engine
|
1941
|
+
# The rendering engine for the simulation application.
|
1942
|
+
#
|
1943
|
+
# @option params [String] :current_revision_id
|
1944
|
+
# The revision id for the robot application.
|
1945
|
+
#
|
1946
|
+
# @return [Types::UpdateSimulationApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1947
|
+
#
|
1948
|
+
# * {Types::UpdateSimulationApplicationResponse#arn #arn} => String
|
1949
|
+
# * {Types::UpdateSimulationApplicationResponse#name #name} => String
|
1950
|
+
# * {Types::UpdateSimulationApplicationResponse#version #version} => String
|
1951
|
+
# * {Types::UpdateSimulationApplicationResponse#sources #sources} => Array<Types::Source>
|
1952
|
+
# * {Types::UpdateSimulationApplicationResponse#simulation_software_suite #simulation_software_suite} => Types::SimulationSoftwareSuite
|
1953
|
+
# * {Types::UpdateSimulationApplicationResponse#robot_software_suite #robot_software_suite} => Types::RobotSoftwareSuite
|
1954
|
+
# * {Types::UpdateSimulationApplicationResponse#rendering_engine #rendering_engine} => Types::RenderingEngine
|
1955
|
+
# * {Types::UpdateSimulationApplicationResponse#last_updated_at #last_updated_at} => Time
|
1956
|
+
# * {Types::UpdateSimulationApplicationResponse#revision_id #revision_id} => String
|
1957
|
+
#
|
1958
|
+
# @example Request syntax with placeholder values
|
1959
|
+
#
|
1960
|
+
# resp = client.update_simulation_application({
|
1961
|
+
# application: "Arn", # required
|
1962
|
+
# sources: [ # required
|
1963
|
+
# {
|
1964
|
+
# s3_bucket: "S3Bucket",
|
1965
|
+
# s3_key: "S3Key",
|
1966
|
+
# architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
|
1967
|
+
# },
|
1968
|
+
# ],
|
1969
|
+
# simulation_software_suite: { # required
|
1970
|
+
# name: "Gazebo", # accepts Gazebo
|
1971
|
+
# version: "SimulationSoftwareSuiteVersionType",
|
1972
|
+
# },
|
1973
|
+
# robot_software_suite: { # required
|
1974
|
+
# name: "ROS", # accepts ROS
|
1975
|
+
# version: "Kinetic", # accepts Kinetic
|
1976
|
+
# },
|
1977
|
+
# rendering_engine: { # required
|
1978
|
+
# name: "OGRE", # accepts OGRE
|
1979
|
+
# version: "RenderingEngineVersionType",
|
1980
|
+
# },
|
1981
|
+
# current_revision_id: "RevisionId",
|
1982
|
+
# })
|
1983
|
+
#
|
1984
|
+
# @example Response structure
|
1985
|
+
#
|
1986
|
+
# resp.arn #=> String
|
1987
|
+
# resp.name #=> String
|
1988
|
+
# resp.version #=> String
|
1989
|
+
# resp.sources #=> Array
|
1990
|
+
# resp.sources[0].s3_bucket #=> String
|
1991
|
+
# resp.sources[0].s3_key #=> String
|
1992
|
+
# resp.sources[0].etag #=> String
|
1993
|
+
# resp.sources[0].architecture #=> String, one of "X86_64", "ARM64", "ARMHF"
|
1994
|
+
# resp.simulation_software_suite.name #=> String, one of "Gazebo"
|
1995
|
+
# resp.simulation_software_suite.version #=> String
|
1996
|
+
# resp.robot_software_suite.name #=> String, one of "ROS"
|
1997
|
+
# resp.robot_software_suite.version #=> String, one of "Kinetic"
|
1998
|
+
# resp.rendering_engine.name #=> String, one of "OGRE"
|
1999
|
+
# resp.rendering_engine.version #=> String
|
2000
|
+
# resp.last_updated_at #=> Time
|
2001
|
+
# resp.revision_id #=> String
|
2002
|
+
#
|
2003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateSimulationApplication AWS API Documentation
|
2004
|
+
#
|
2005
|
+
# @overload update_simulation_application(params = {})
|
2006
|
+
# @param [Hash] params ({})
|
2007
|
+
def update_simulation_application(params = {}, options = {})
|
2008
|
+
req = build_request(:update_simulation_application, params)
|
2009
|
+
req.send_request(options)
|
2010
|
+
end
|
2011
|
+
|
2012
|
+
# @!endgroup
|
2013
|
+
|
2014
|
+
# @param params ({})
|
2015
|
+
# @api private
|
2016
|
+
def build_request(operation_name, params = {})
|
2017
|
+
handlers = @handlers.for(operation_name)
|
2018
|
+
context = Seahorse::Client::RequestContext.new(
|
2019
|
+
operation_name: operation_name,
|
2020
|
+
operation: config.api.operation(operation_name),
|
2021
|
+
client: self,
|
2022
|
+
params: params,
|
2023
|
+
config: config)
|
2024
|
+
context[:gem_name] = 'aws-sdk-robomaker'
|
2025
|
+
context[:gem_version] = '1.0.0'
|
2026
|
+
Seahorse::Client::Request.new(handlers, context)
|
2027
|
+
end
|
2028
|
+
|
2029
|
+
# @api private
|
2030
|
+
# @deprecated
|
2031
|
+
def waiter_names
|
2032
|
+
[]
|
2033
|
+
end
|
2034
|
+
|
2035
|
+
class << self
|
2036
|
+
|
2037
|
+
# @api private
|
2038
|
+
attr_reader :identifier
|
2039
|
+
|
2040
|
+
# @api private
|
2041
|
+
def errors_module
|
2042
|
+
Errors
|
2043
|
+
end
|
2044
|
+
|
2045
|
+
end
|
2046
|
+
end
|
2047
|
+
end
|