aws-sdk-outposts 1.54.0 → 1.56.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-outposts/client.rb +329 -48
- data/lib/aws-sdk-outposts/client_api.rb +180 -0
- data/lib/aws-sdk-outposts/endpoints.rb +70 -0
- data/lib/aws-sdk-outposts/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-outposts/types.rb +378 -4
- data/lib/aws-sdk-outposts.rb +2 -2
- data/sig/client.rbs +85 -0
- data/sig/types.rbs +102 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b4511c9252df25e70dc9b98b4ee9c005da5f9173ae69a5a976737399161cae57
|
4
|
+
data.tar.gz: 23a2bf0be8cdeb8dbab19ab1950f8c200866b2105957b11b10250f9da25af3d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0dfb1b1fb1bca2d218f3d9b322c51daadacf5c609cff03a22f11a1d130d784bc985fc18c3253ff42b59275f7fca335e6fe7141b69c49fbfe676523d28be66847
|
7
|
+
data.tar.gz: cb958fbcca013e84b5375ecfdb9537b2f28b52300158debdb27ba4e1b6f17f747878d6ea7e58209bd78e7749272f0d107d0e6fe88bb24f382cb2c01d5eb2555c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.56.0 (2024-04-25)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.55.0 (2024-04-16)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds new APIs to allow customers to configure their Outpost capacity at order-time.
|
13
|
+
|
4
14
|
1.54.0 (2024-04-12)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.56.0
|
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
|
22
22
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
23
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
24
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id.rb'
|
25
26
|
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
27
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
28
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
@@ -72,6 +73,7 @@ module Aws::Outposts
|
|
72
73
|
add_plugin(Aws::Plugins::ResponsePaging)
|
73
74
|
add_plugin(Aws::Plugins::StubResponses)
|
74
75
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
76
|
+
add_plugin(Aws::Plugins::InvocationId)
|
75
77
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
76
78
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
77
79
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
@@ -196,10 +198,17 @@ module Aws::Outposts
|
|
196
198
|
# When set to 'true' the request body will not be compressed
|
197
199
|
# for supported operations.
|
198
200
|
#
|
199
|
-
# @option options [String] :endpoint
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
201
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
202
|
+
# Normally you should not configure the `:endpoint` option
|
203
|
+
# directly. This is normally constructed from the `:region`
|
204
|
+
# option. Configuring `:endpoint` is normally reserved for
|
205
|
+
# connecting to test or custom endpoints. The endpoint should
|
206
|
+
# be a URI formatted like:
|
207
|
+
#
|
208
|
+
# 'http://example.com'
|
209
|
+
# 'https://example.com'
|
210
|
+
# 'http://example.com:123'
|
211
|
+
#
|
203
212
|
#
|
204
213
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
205
214
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -337,57 +346,99 @@ module Aws::Outposts
|
|
337
346
|
# @option options [Aws::Outposts::EndpointProvider] :endpoint_provider
|
338
347
|
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Outposts::EndpointParameters`
|
339
348
|
#
|
340
|
-
# @option options [
|
341
|
-
#
|
349
|
+
# @option options [Float] :http_continue_timeout (1)
|
350
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
351
|
+
# request body. This option has no effect unless the request has "Expect"
|
352
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
353
|
+
# behaviour. This value can safely be set per request on the session.
|
354
|
+
#
|
355
|
+
# @option options [Float] :http_idle_timeout (5)
|
356
|
+
# The number of seconds a connection is allowed to sit idle before it
|
357
|
+
# is considered stale. Stale connections are closed and removed from the
|
358
|
+
# pool before making a request.
|
359
|
+
#
|
360
|
+
# @option options [Float] :http_open_timeout (15)
|
361
|
+
# The default number of seconds to wait for response data.
|
362
|
+
# This value can safely be set per-request on the session.
|
363
|
+
#
|
364
|
+
# @option options [URI::HTTP,String] :http_proxy
|
365
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
366
|
+
#
|
367
|
+
# @option options [Float] :http_read_timeout (60)
|
368
|
+
# The default number of seconds to wait for response data.
|
369
|
+
# This value can safely be set per-request on the session.
|
370
|
+
#
|
371
|
+
# @option options [Boolean] :http_wire_trace (false)
|
372
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
373
|
+
#
|
374
|
+
# @option options [Proc] :on_chunk_received
|
375
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
376
|
+
# of the response body is received. It provides three arguments: the chunk,
|
377
|
+
# the number of bytes received, and the total number of
|
378
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
379
|
+
#
|
380
|
+
# @option options [Proc] :on_chunk_sent
|
381
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
382
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
383
|
+
# the number of bytes read from the body, and the total number of
|
384
|
+
# bytes in the body.
|
385
|
+
#
|
386
|
+
# @option options [Boolean] :raise_response_errors (true)
|
387
|
+
# When `true`, response errors are raised.
|
388
|
+
#
|
389
|
+
# @option options [String] :ssl_ca_bundle
|
390
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
391
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
392
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
393
|
+
#
|
394
|
+
# @option options [String] :ssl_ca_directory
|
395
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
396
|
+
# authority files for verifying peer certificates. If you do
|
397
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
398
|
+
# default will be used if available.
|
342
399
|
#
|
343
|
-
# @option options [
|
344
|
-
#
|
345
|
-
# `Timeout::Error`.
|
400
|
+
# @option options [String] :ssl_ca_store
|
401
|
+
# Sets the X509::Store to verify peer certificate.
|
346
402
|
#
|
347
|
-
# @option options [Float] :
|
348
|
-
#
|
349
|
-
# safely be set per-request on the session.
|
403
|
+
# @option options [Float] :ssl_timeout
|
404
|
+
# Sets the SSL timeout in seconds
|
350
405
|
#
|
351
|
-
# @option options [
|
352
|
-
#
|
353
|
-
# considered stale. Stale connections are closed and removed
|
354
|
-
# from the pool before making a request.
|
406
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
407
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
355
408
|
#
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
#
|
361
|
-
|
409
|
+
def initialize(*args)
|
410
|
+
super
|
411
|
+
end
|
412
|
+
|
413
|
+
# @!group API Operations
|
414
|
+
|
415
|
+
# Cancels the capacity task.
|
362
416
|
#
|
363
|
-
#
|
364
|
-
#
|
417
|
+
# @option params [required, String] :capacity_task_id
|
418
|
+
# ID of the capacity task that you want to cancel.
|
365
419
|
#
|
366
|
-
#
|
367
|
-
#
|
420
|
+
# @option params [required, String] :outpost_identifier
|
421
|
+
# ID or ARN of the Outpost associated with the capacity task that you
|
422
|
+
# want to cancel.
|
368
423
|
#
|
369
|
-
#
|
370
|
-
# SSL peer certificates are verified when establishing a
|
371
|
-
# connection.
|
424
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
372
425
|
#
|
373
|
-
#
|
374
|
-
# certificate authority bundle file that should be used when
|
375
|
-
# verifying peer certificates. If you do not pass
|
376
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
377
|
-
# will be used if available.
|
426
|
+
# @example Request syntax with placeholder values
|
378
427
|
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
# system default will be used if available.
|
428
|
+
# resp = client.cancel_capacity_task({
|
429
|
+
# capacity_task_id: "CapacityTaskId", # required
|
430
|
+
# outpost_identifier: "OutpostIdentifier", # required
|
431
|
+
# })
|
384
432
|
#
|
385
|
-
|
386
|
-
|
433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/CancelCapacityTask AWS API Documentation
|
434
|
+
#
|
435
|
+
# @overload cancel_capacity_task(params = {})
|
436
|
+
# @param [Hash] params ({})
|
437
|
+
def cancel_capacity_task(params = {}, options = {})
|
438
|
+
req = build_request(:cancel_capacity_task, params)
|
439
|
+
req.send_request(options)
|
387
440
|
end
|
388
441
|
|
389
|
-
# @!group API Operations
|
390
|
-
|
391
442
|
# Cancels the specified order for an Outpost.
|
392
443
|
#
|
393
444
|
# @option params [required, String] :order_id
|
@@ -665,7 +716,7 @@ module Aws::Outposts
|
|
665
716
|
# Deletes the specified Outpost.
|
666
717
|
#
|
667
718
|
# @option params [required, String] :outpost_id
|
668
|
-
# The ID or
|
719
|
+
# The ID or ARN of the Outpost.
|
669
720
|
#
|
670
721
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
671
722
|
#
|
@@ -706,6 +757,59 @@ module Aws::Outposts
|
|
706
757
|
req.send_request(options)
|
707
758
|
end
|
708
759
|
|
760
|
+
# Gets details of the specified capacity task.
|
761
|
+
#
|
762
|
+
# @option params [required, String] :capacity_task_id
|
763
|
+
# ID of the capacity task.
|
764
|
+
#
|
765
|
+
# @option params [required, String] :outpost_identifier
|
766
|
+
# ID or ARN of the Outpost associated with the specified capacity task.
|
767
|
+
#
|
768
|
+
# @return [Types::GetCapacityTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
769
|
+
#
|
770
|
+
# * {Types::GetCapacityTaskOutput#capacity_task_id #capacity_task_id} => String
|
771
|
+
# * {Types::GetCapacityTaskOutput#outpost_id #outpost_id} => String
|
772
|
+
# * {Types::GetCapacityTaskOutput#order_id #order_id} => String
|
773
|
+
# * {Types::GetCapacityTaskOutput#requested_instance_pools #requested_instance_pools} => Array<Types::InstanceTypeCapacity>
|
774
|
+
# * {Types::GetCapacityTaskOutput#dry_run #dry_run} => Boolean
|
775
|
+
# * {Types::GetCapacityTaskOutput#capacity_task_status #capacity_task_status} => String
|
776
|
+
# * {Types::GetCapacityTaskOutput#failed #failed} => Types::CapacityTaskFailure
|
777
|
+
# * {Types::GetCapacityTaskOutput#creation_date #creation_date} => Time
|
778
|
+
# * {Types::GetCapacityTaskOutput#completion_date #completion_date} => Time
|
779
|
+
# * {Types::GetCapacityTaskOutput#last_modified_date #last_modified_date} => Time
|
780
|
+
#
|
781
|
+
# @example Request syntax with placeholder values
|
782
|
+
#
|
783
|
+
# resp = client.get_capacity_task({
|
784
|
+
# capacity_task_id: "CapacityTaskId", # required
|
785
|
+
# outpost_identifier: "OutpostIdentifier", # required
|
786
|
+
# })
|
787
|
+
#
|
788
|
+
# @example Response structure
|
789
|
+
#
|
790
|
+
# resp.capacity_task_id #=> String
|
791
|
+
# resp.outpost_id #=> String
|
792
|
+
# resp.order_id #=> String
|
793
|
+
# resp.requested_instance_pools #=> Array
|
794
|
+
# resp.requested_instance_pools[0].instance_type #=> String
|
795
|
+
# resp.requested_instance_pools[0].count #=> Integer
|
796
|
+
# resp.dry_run #=> Boolean
|
797
|
+
# resp.capacity_task_status #=> String, one of "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "CANCELLED"
|
798
|
+
# resp.failed.reason #=> String
|
799
|
+
# resp.failed.type #=> String, one of "UNSUPPORTED_CAPACITY_CONFIGURATION"
|
800
|
+
# resp.creation_date #=> Time
|
801
|
+
# resp.completion_date #=> Time
|
802
|
+
# resp.last_modified_date #=> Time
|
803
|
+
#
|
804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetCapacityTask AWS API Documentation
|
805
|
+
#
|
806
|
+
# @overload get_capacity_task(params = {})
|
807
|
+
# @param [Hash] params ({})
|
808
|
+
def get_capacity_task(params = {}, options = {})
|
809
|
+
req = build_request(:get_capacity_task, params)
|
810
|
+
req.send_request(options)
|
811
|
+
end
|
812
|
+
|
709
813
|
# Gets information about the specified catalog item.
|
710
814
|
#
|
711
815
|
# @option params [required, String] :catalog_item_id
|
@@ -848,7 +952,7 @@ module Aws::Outposts
|
|
848
952
|
# Gets information about the specified Outpost.
|
849
953
|
#
|
850
954
|
# @option params [required, String] :outpost_id
|
851
|
-
# The ID or
|
955
|
+
# The ID or ARN of the Outpost.
|
852
956
|
#
|
853
957
|
# @return [Types::GetOutpostOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
854
958
|
#
|
@@ -888,7 +992,7 @@ module Aws::Outposts
|
|
888
992
|
# Gets the instance types for the specified Outpost.
|
889
993
|
#
|
890
994
|
# @option params [required, String] :outpost_id
|
891
|
-
# The ID or
|
995
|
+
# The ID or ARN of the Outpost.
|
892
996
|
#
|
893
997
|
# @option params [String] :next_token
|
894
998
|
# The pagination token.
|
@@ -930,6 +1034,54 @@ module Aws::Outposts
|
|
930
1034
|
req.send_request(options)
|
931
1035
|
end
|
932
1036
|
|
1037
|
+
# Gets the instance types that an Outpost can support in
|
1038
|
+
# `InstanceTypeCapacity`. This will generally include instance types
|
1039
|
+
# that are not currently configured and therefore cannot be launched
|
1040
|
+
# with the current Outpost capacity configuration.
|
1041
|
+
#
|
1042
|
+
# @option params [required, String] :outpost_identifier
|
1043
|
+
# The ID or ARN of the Outpost.
|
1044
|
+
#
|
1045
|
+
# @option params [required, String] :order_id
|
1046
|
+
# The ID for the Amazon Web Services Outposts order.
|
1047
|
+
#
|
1048
|
+
# @option params [Integer] :max_results
|
1049
|
+
# The maximum page size.
|
1050
|
+
#
|
1051
|
+
# @option params [String] :next_token
|
1052
|
+
# The pagination token.
|
1053
|
+
#
|
1054
|
+
# @return [Types::GetOutpostSupportedInstanceTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1055
|
+
#
|
1056
|
+
# * {Types::GetOutpostSupportedInstanceTypesOutput#instance_types #instance_types} => Array<Types::InstanceTypeItem>
|
1057
|
+
# * {Types::GetOutpostSupportedInstanceTypesOutput#next_token #next_token} => String
|
1058
|
+
#
|
1059
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1060
|
+
#
|
1061
|
+
# @example Request syntax with placeholder values
|
1062
|
+
#
|
1063
|
+
# resp = client.get_outpost_supported_instance_types({
|
1064
|
+
# outpost_identifier: "OutpostIdentifier", # required
|
1065
|
+
# order_id: "OrderId", # required
|
1066
|
+
# max_results: 1,
|
1067
|
+
# next_token: "Token",
|
1068
|
+
# })
|
1069
|
+
#
|
1070
|
+
# @example Response structure
|
1071
|
+
#
|
1072
|
+
# resp.instance_types #=> Array
|
1073
|
+
# resp.instance_types[0].instance_type #=> String
|
1074
|
+
# resp.next_token #=> String
|
1075
|
+
#
|
1076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetOutpostSupportedInstanceTypes AWS API Documentation
|
1077
|
+
#
|
1078
|
+
# @overload get_outpost_supported_instance_types(params = {})
|
1079
|
+
# @param [Hash] params ({})
|
1080
|
+
def get_outpost_supported_instance_types(params = {}, options = {})
|
1081
|
+
req = build_request(:get_outpost_supported_instance_types, params)
|
1082
|
+
req.send_request(options)
|
1083
|
+
end
|
1084
|
+
|
933
1085
|
# Gets information about the specified Outpost site.
|
934
1086
|
#
|
935
1087
|
# @option params [required, String] :site_id
|
@@ -1085,6 +1237,64 @@ module Aws::Outposts
|
|
1085
1237
|
req.send_request(options)
|
1086
1238
|
end
|
1087
1239
|
|
1240
|
+
# Lists the capacity tasks for your Amazon Web Services account.
|
1241
|
+
#
|
1242
|
+
# Use filters to return specific results. If you specify multiple
|
1243
|
+
# filters, the results include only the resources that match all of the
|
1244
|
+
# specified filters. For a filter where you can specify multiple values,
|
1245
|
+
# the results include items that match any of the values that you
|
1246
|
+
# specify for the filter.
|
1247
|
+
#
|
1248
|
+
# @option params [String] :outpost_identifier_filter
|
1249
|
+
# Filters the results by an Outpost ID or an Outpost ARN.
|
1250
|
+
#
|
1251
|
+
# @option params [Integer] :max_results
|
1252
|
+
# The maximum page size.
|
1253
|
+
#
|
1254
|
+
# @option params [String] :next_token
|
1255
|
+
# The pagination token.
|
1256
|
+
#
|
1257
|
+
# @option params [Array<String>] :capacity_task_status_filter
|
1258
|
+
# A list of statuses. For example, `REQUESTED` or
|
1259
|
+
# `WAITING_FOR_EVACUATION`.
|
1260
|
+
#
|
1261
|
+
# @return [Types::ListCapacityTasksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1262
|
+
#
|
1263
|
+
# * {Types::ListCapacityTasksOutput#capacity_tasks #capacity_tasks} => Array<Types::CapacityTaskSummary>
|
1264
|
+
# * {Types::ListCapacityTasksOutput#next_token #next_token} => String
|
1265
|
+
#
|
1266
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1267
|
+
#
|
1268
|
+
# @example Request syntax with placeholder values
|
1269
|
+
#
|
1270
|
+
# resp = client.list_capacity_tasks({
|
1271
|
+
# outpost_identifier_filter: "OutpostIdentifier",
|
1272
|
+
# max_results: 1,
|
1273
|
+
# next_token: "Token",
|
1274
|
+
# capacity_task_status_filter: ["REQUESTED"], # accepts REQUESTED, IN_PROGRESS, FAILED, COMPLETED, CANCELLED
|
1275
|
+
# })
|
1276
|
+
#
|
1277
|
+
# @example Response structure
|
1278
|
+
#
|
1279
|
+
# resp.capacity_tasks #=> Array
|
1280
|
+
# resp.capacity_tasks[0].capacity_task_id #=> String
|
1281
|
+
# resp.capacity_tasks[0].outpost_id #=> String
|
1282
|
+
# resp.capacity_tasks[0].order_id #=> String
|
1283
|
+
# resp.capacity_tasks[0].capacity_task_status #=> String, one of "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "CANCELLED"
|
1284
|
+
# resp.capacity_tasks[0].creation_date #=> Time
|
1285
|
+
# resp.capacity_tasks[0].completion_date #=> Time
|
1286
|
+
# resp.capacity_tasks[0].last_modified_date #=> Time
|
1287
|
+
# resp.next_token #=> String
|
1288
|
+
#
|
1289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListCapacityTasks AWS API Documentation
|
1290
|
+
#
|
1291
|
+
# @overload list_capacity_tasks(params = {})
|
1292
|
+
# @param [Hash] params ({})
|
1293
|
+
def list_capacity_tasks(params = {}, options = {})
|
1294
|
+
req = build_request(:list_capacity_tasks, params)
|
1295
|
+
req.send_request(options)
|
1296
|
+
end
|
1297
|
+
|
1088
1298
|
# Lists the items in the catalog.
|
1089
1299
|
#
|
1090
1300
|
# Use filters to return specific results. If you specify multiple
|
@@ -1370,6 +1580,77 @@ module Aws::Outposts
|
|
1370
1580
|
req.send_request(options)
|
1371
1581
|
end
|
1372
1582
|
|
1583
|
+
# Starts the specified capacity task. You can have one active capacity
|
1584
|
+
# task for an order.
|
1585
|
+
#
|
1586
|
+
# @option params [required, String] :outpost_identifier
|
1587
|
+
# The ID or ARN of the Outposts associated with the specified capacity
|
1588
|
+
# task.
|
1589
|
+
#
|
1590
|
+
# @option params [required, String] :order_id
|
1591
|
+
# The ID of the Amazon Web Services Outposts order associated with the
|
1592
|
+
# specified capacity task.
|
1593
|
+
#
|
1594
|
+
# @option params [required, Array<Types::InstanceTypeCapacity>] :instance_pools
|
1595
|
+
# The instance pools specified in the capacity task.
|
1596
|
+
#
|
1597
|
+
# @option params [Boolean] :dry_run
|
1598
|
+
# You can request a dry run to determine if the instance type and
|
1599
|
+
# instance size changes is above or below available instance capacity.
|
1600
|
+
# Requesting a dry run does not make any changes to your plan.
|
1601
|
+
#
|
1602
|
+
# @return [Types::StartCapacityTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1603
|
+
#
|
1604
|
+
# * {Types::StartCapacityTaskOutput#capacity_task_id #capacity_task_id} => String
|
1605
|
+
# * {Types::StartCapacityTaskOutput#outpost_id #outpost_id} => String
|
1606
|
+
# * {Types::StartCapacityTaskOutput#order_id #order_id} => String
|
1607
|
+
# * {Types::StartCapacityTaskOutput#requested_instance_pools #requested_instance_pools} => Array<Types::InstanceTypeCapacity>
|
1608
|
+
# * {Types::StartCapacityTaskOutput#dry_run #dry_run} => Boolean
|
1609
|
+
# * {Types::StartCapacityTaskOutput#capacity_task_status #capacity_task_status} => String
|
1610
|
+
# * {Types::StartCapacityTaskOutput#failed #failed} => Types::CapacityTaskFailure
|
1611
|
+
# * {Types::StartCapacityTaskOutput#creation_date #creation_date} => Time
|
1612
|
+
# * {Types::StartCapacityTaskOutput#completion_date #completion_date} => Time
|
1613
|
+
# * {Types::StartCapacityTaskOutput#last_modified_date #last_modified_date} => Time
|
1614
|
+
#
|
1615
|
+
# @example Request syntax with placeholder values
|
1616
|
+
#
|
1617
|
+
# resp = client.start_capacity_task({
|
1618
|
+
# outpost_identifier: "OutpostIdentifier", # required
|
1619
|
+
# order_id: "OrderId", # required
|
1620
|
+
# instance_pools: [ # required
|
1621
|
+
# {
|
1622
|
+
# instance_type: "InstanceTypeName", # required
|
1623
|
+
# count: 1, # required
|
1624
|
+
# },
|
1625
|
+
# ],
|
1626
|
+
# dry_run: false,
|
1627
|
+
# })
|
1628
|
+
#
|
1629
|
+
# @example Response structure
|
1630
|
+
#
|
1631
|
+
# resp.capacity_task_id #=> String
|
1632
|
+
# resp.outpost_id #=> String
|
1633
|
+
# resp.order_id #=> String
|
1634
|
+
# resp.requested_instance_pools #=> Array
|
1635
|
+
# resp.requested_instance_pools[0].instance_type #=> String
|
1636
|
+
# resp.requested_instance_pools[0].count #=> Integer
|
1637
|
+
# resp.dry_run #=> Boolean
|
1638
|
+
# resp.capacity_task_status #=> String, one of "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "CANCELLED"
|
1639
|
+
# resp.failed.reason #=> String
|
1640
|
+
# resp.failed.type #=> String, one of "UNSUPPORTED_CAPACITY_CONFIGURATION"
|
1641
|
+
# resp.creation_date #=> Time
|
1642
|
+
# resp.completion_date #=> Time
|
1643
|
+
# resp.last_modified_date #=> Time
|
1644
|
+
#
|
1645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/StartCapacityTask AWS API Documentation
|
1646
|
+
#
|
1647
|
+
# @overload start_capacity_task(params = {})
|
1648
|
+
# @param [Hash] params ({})
|
1649
|
+
def start_capacity_task(params = {}, options = {})
|
1650
|
+
req = build_request(:start_capacity_task, params)
|
1651
|
+
req.send_request(options)
|
1652
|
+
end
|
1653
|
+
|
1373
1654
|
# <note markdown="1"> Amazon Web Services uses this action to install Outpost servers.
|
1374
1655
|
#
|
1375
1656
|
# </note>
|
@@ -1485,7 +1766,7 @@ module Aws::Outposts
|
|
1485
1766
|
# Updates an Outpost.
|
1486
1767
|
#
|
1487
1768
|
# @option params [required, String] :outpost_id
|
1488
|
-
# The ID or
|
1769
|
+
# The ID or ARN of the Outpost.
|
1489
1770
|
#
|
1490
1771
|
# @option params [String] :name
|
1491
1772
|
# The name of the Outpost.
|
@@ -1833,7 +2114,7 @@ module Aws::Outposts
|
|
1833
2114
|
params: params,
|
1834
2115
|
config: config)
|
1835
2116
|
context[:gem_name] = 'aws-sdk-outposts'
|
1836
|
-
context[:gem_version] = '1.
|
2117
|
+
context[:gem_version] = '1.56.0'
|
1837
2118
|
Seahorse::Client::Request.new(handlers, context)
|
1838
2119
|
end
|
1839
2120
|
|