aws-sdk-ram 1.12.0 → 1.17.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 +5 -5
- data/lib/aws-sdk-ram.rb +7 -4
- data/lib/aws-sdk-ram/client.rb +413 -22
- data/lib/aws-sdk-ram/client_api.rb +214 -0
- data/lib/aws-sdk-ram/errors.rb +43 -21
- data/lib/aws-sdk-ram/resource.rb +1 -0
- data/lib/aws-sdk-ram/types.rb +491 -9
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: b9176890c001377d01344ab6a14e4ff6ade89e43a3a1510d6baa127db506acbc
|
4
|
+
data.tar.gz: 9a5c7ff5df8d877b9d54c400b47b802722a6d1c14c10a9e4010eb47d887996d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ea5b80134fba83c18e6c99add98e7cad0054814d3bf5ee06f3cecf30f110d6d9480fc2773e8bc22f5469a94bdceb535132fe8e76d55b37f7566d94bdad34f06f
|
7
|
+
data.tar.gz: 0eb106cafcf118993b66201d0b38bf72353d13913fec8d1b5ec89c151609f33c624388d1d2f2b01bcf241efa102accfa967d4d5eb473875e2831d90ca202273c
|
data/lib/aws-sdk-ram.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-ram/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# ram = Aws::RAM::Client.new
|
28
|
+
# resp = ram.accept_resource_share_invitation(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from AWS Resource Access Manager
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from AWS Resource Access Manager are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::RAM::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all AWS Resource Access Manager API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-ram/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::RAM
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.17.0'
|
46
49
|
|
47
50
|
end
|
data/lib/aws-sdk-ram/client.rb
CHANGED
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:ram)
|
31
31
|
|
32
32
|
module Aws::RAM
|
33
|
+
# An API client for RAM. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::RAM::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::RAM
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::RAM
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::RAM
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::RAM
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::RAM
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::RAM
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::RAM
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::RAM
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::RAM
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -358,6 +412,53 @@ module Aws::RAM
|
|
358
412
|
req.send_request(options)
|
359
413
|
end
|
360
414
|
|
415
|
+
# Associates a permission with a resource share.
|
416
|
+
#
|
417
|
+
# @option params [required, String] :resource_share_arn
|
418
|
+
# The Amazon Resource Name (ARN) of the resource share.
|
419
|
+
#
|
420
|
+
# @option params [required, String] :permission_arn
|
421
|
+
# The ARN of the AWS RAM permission to associate with the resource
|
422
|
+
# share.
|
423
|
+
#
|
424
|
+
# @option params [Boolean] :replace
|
425
|
+
# Indicates whether the permission should replace the permissions that
|
426
|
+
# are currently associated with the resource share. Use `true` to
|
427
|
+
# replace the current permissions. Use `false` to add the permission to
|
428
|
+
# the current permission.
|
429
|
+
#
|
430
|
+
# @option params [String] :client_token
|
431
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
432
|
+
# idempotency of the request.
|
433
|
+
#
|
434
|
+
# @return [Types::AssociateResourceSharePermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
435
|
+
#
|
436
|
+
# * {Types::AssociateResourceSharePermissionResponse#return_value #return_value} => Boolean
|
437
|
+
# * {Types::AssociateResourceSharePermissionResponse#client_token #client_token} => String
|
438
|
+
#
|
439
|
+
# @example Request syntax with placeholder values
|
440
|
+
#
|
441
|
+
# resp = client.associate_resource_share_permission({
|
442
|
+
# resource_share_arn: "String", # required
|
443
|
+
# permission_arn: "String", # required
|
444
|
+
# replace: false,
|
445
|
+
# client_token: "String",
|
446
|
+
# })
|
447
|
+
#
|
448
|
+
# @example Response structure
|
449
|
+
#
|
450
|
+
# resp.return_value #=> Boolean
|
451
|
+
# resp.client_token #=> String
|
452
|
+
#
|
453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceSharePermission AWS API Documentation
|
454
|
+
#
|
455
|
+
# @overload associate_resource_share_permission(params = {})
|
456
|
+
# @param [Hash] params ({})
|
457
|
+
def associate_resource_share_permission(params = {}, options = {})
|
458
|
+
req = build_request(:associate_resource_share_permission, params)
|
459
|
+
req.send_request(options)
|
460
|
+
end
|
461
|
+
|
361
462
|
# Creates a resource share.
|
362
463
|
#
|
363
464
|
# @option params [required, String] :name
|
@@ -383,6 +484,11 @@ module Aws::RAM
|
|
383
484
|
# A unique, case-sensitive identifier that you provide to ensure the
|
384
485
|
# idempotency of the request.
|
385
486
|
#
|
487
|
+
# @option params [Array<String>] :permission_arns
|
488
|
+
# The ARNs of the permissions to associate with the resource share. If
|
489
|
+
# you do not specify an ARN for the permission, AWS RAM automatically
|
490
|
+
# attaches the default version of the permission for each resource type.
|
491
|
+
#
|
386
492
|
# @return [Types::CreateResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
387
493
|
#
|
388
494
|
# * {Types::CreateResourceShareResponse#resource_share #resource_share} => Types::ResourceShare
|
@@ -402,6 +508,7 @@ module Aws::RAM
|
|
402
508
|
# ],
|
403
509
|
# allow_external_principals: false,
|
404
510
|
# client_token: "String",
|
511
|
+
# permission_arns: ["String"],
|
405
512
|
# })
|
406
513
|
#
|
407
514
|
# @example Response structure
|
@@ -417,6 +524,7 @@ module Aws::RAM
|
|
417
524
|
# resp.resource_share.tags[0].value #=> String
|
418
525
|
# resp.resource_share.creation_time #=> Time
|
419
526
|
# resp.resource_share.last_updated_time #=> Time
|
527
|
+
# resp.resource_share.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
|
420
528
|
# resp.client_token #=> String
|
421
529
|
#
|
422
530
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/CreateResourceShare AWS API Documentation
|
@@ -470,7 +578,7 @@ module Aws::RAM
|
|
470
578
|
# The Amazon Resource Name (ARN) of the resource share.
|
471
579
|
#
|
472
580
|
# @option params [Array<String>] :resource_arns
|
473
|
-
# The Amazon Resource Names (
|
581
|
+
# The Amazon Resource Names (ARNs) of the resources.
|
474
582
|
#
|
475
583
|
# @option params [Array<String>] :principals
|
476
584
|
# The principals.
|
@@ -516,6 +624,45 @@ module Aws::RAM
|
|
516
624
|
req.send_request(options)
|
517
625
|
end
|
518
626
|
|
627
|
+
# Disassociates an AWS RAM permission from a resource share.
|
628
|
+
#
|
629
|
+
# @option params [required, String] :resource_share_arn
|
630
|
+
# The Amazon Resource Name (ARN) of the resource share.
|
631
|
+
#
|
632
|
+
# @option params [required, String] :permission_arn
|
633
|
+
# The ARN of the permission to disassociate from the resource share.
|
634
|
+
#
|
635
|
+
# @option params [String] :client_token
|
636
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
637
|
+
# idempotency of the request.
|
638
|
+
#
|
639
|
+
# @return [Types::DisassociateResourceSharePermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
640
|
+
#
|
641
|
+
# * {Types::DisassociateResourceSharePermissionResponse#return_value #return_value} => Boolean
|
642
|
+
# * {Types::DisassociateResourceSharePermissionResponse#client_token #client_token} => String
|
643
|
+
#
|
644
|
+
# @example Request syntax with placeholder values
|
645
|
+
#
|
646
|
+
# resp = client.disassociate_resource_share_permission({
|
647
|
+
# resource_share_arn: "String", # required
|
648
|
+
# permission_arn: "String", # required
|
649
|
+
# client_token: "String",
|
650
|
+
# })
|
651
|
+
#
|
652
|
+
# @example Response structure
|
653
|
+
#
|
654
|
+
# resp.return_value #=> Boolean
|
655
|
+
# resp.client_token #=> String
|
656
|
+
#
|
657
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceSharePermission AWS API Documentation
|
658
|
+
#
|
659
|
+
# @overload disassociate_resource_share_permission(params = {})
|
660
|
+
# @param [Hash] params ({})
|
661
|
+
def disassociate_resource_share_permission(params = {}, options = {})
|
662
|
+
req = build_request(:disassociate_resource_share_permission, params)
|
663
|
+
req.send_request(options)
|
664
|
+
end
|
665
|
+
|
519
666
|
# Enables resource sharing within your AWS Organization.
|
520
667
|
#
|
521
668
|
# The caller must be the master account for the AWS Organization.
|
@@ -537,6 +684,45 @@ module Aws::RAM
|
|
537
684
|
req.send_request(options)
|
538
685
|
end
|
539
686
|
|
687
|
+
# Gets the contents of an AWS RAM permission in JSON format.
|
688
|
+
#
|
689
|
+
# @option params [required, String] :permission_arn
|
690
|
+
# The ARN of the permission.
|
691
|
+
#
|
692
|
+
# @option params [Integer] :permission_version
|
693
|
+
# The identifier for the version of the permission.
|
694
|
+
#
|
695
|
+
# @return [Types::GetPermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
696
|
+
#
|
697
|
+
# * {Types::GetPermissionResponse#permission #permission} => Types::ResourceSharePermissionDetail
|
698
|
+
#
|
699
|
+
# @example Request syntax with placeholder values
|
700
|
+
#
|
701
|
+
# resp = client.get_permission({
|
702
|
+
# permission_arn: "String", # required
|
703
|
+
# permission_version: 1,
|
704
|
+
# })
|
705
|
+
#
|
706
|
+
# @example Response structure
|
707
|
+
#
|
708
|
+
# resp.permission.arn #=> String
|
709
|
+
# resp.permission.version #=> String
|
710
|
+
# resp.permission.default_version #=> Boolean
|
711
|
+
# resp.permission.name #=> String
|
712
|
+
# resp.permission.resource_type #=> String
|
713
|
+
# resp.permission.permission #=> String
|
714
|
+
# resp.permission.creation_time #=> Time
|
715
|
+
# resp.permission.last_updated_time #=> Time
|
716
|
+
#
|
717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetPermission AWS API Documentation
|
718
|
+
#
|
719
|
+
# @overload get_permission(params = {})
|
720
|
+
# @param [Hash] params ({})
|
721
|
+
def get_permission(params = {}, options = {})
|
722
|
+
req = build_request(:get_permission, params)
|
723
|
+
req.send_request(options)
|
724
|
+
end
|
725
|
+
|
540
726
|
# Gets the policies for the specified resources that you own and have
|
541
727
|
# shared.
|
542
728
|
#
|
@@ -559,6 +745,8 @@ module Aws::RAM
|
|
559
745
|
# * {Types::GetResourcePoliciesResponse#policies #policies} => Array<String>
|
560
746
|
# * {Types::GetResourcePoliciesResponse#next_token #next_token} => String
|
561
747
|
#
|
748
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
749
|
+
#
|
562
750
|
# @example Request syntax with placeholder values
|
563
751
|
#
|
564
752
|
# resp = client.get_resource_policies({
|
@@ -586,7 +774,10 @@ module Aws::RAM
|
|
586
774
|
# Gets the resources or principals for the resource shares that you own.
|
587
775
|
#
|
588
776
|
# @option params [required, String] :association_type
|
589
|
-
# The association type.
|
777
|
+
# The association type. Specify `PRINCIPAL` to list the principals that
|
778
|
+
# are associated with the specified resource share. Specify `RESOURCE`
|
779
|
+
# to list the resources that are associated with the specified resource
|
780
|
+
# share.
|
590
781
|
#
|
591
782
|
# @option params [Array<String>] :resource_share_arns
|
592
783
|
# The Amazon Resource Names (ARN) of the resource shares.
|
@@ -615,6 +806,8 @@ module Aws::RAM
|
|
615
806
|
# * {Types::GetResourceShareAssociationsResponse#resource_share_associations #resource_share_associations} => Array<Types::ResourceShareAssociation>
|
616
807
|
# * {Types::GetResourceShareAssociationsResponse#next_token #next_token} => String
|
617
808
|
#
|
809
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
810
|
+
#
|
618
811
|
# @example Request syntax with placeholder values
|
619
812
|
#
|
620
813
|
# resp = client.get_resource_share_associations({
|
@@ -671,6 +864,8 @@ module Aws::RAM
|
|
671
864
|
# * {Types::GetResourceShareInvitationsResponse#resource_share_invitations #resource_share_invitations} => Array<Types::ResourceShareInvitation>
|
672
865
|
# * {Types::GetResourceShareInvitationsResponse#next_token #next_token} => String
|
673
866
|
#
|
867
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
868
|
+
#
|
674
869
|
# @example Request syntax with placeholder values
|
675
870
|
#
|
676
871
|
# resp = client.get_resource_share_invitations({
|
@@ -742,6 +937,8 @@ module Aws::RAM
|
|
742
937
|
# * {Types::GetResourceSharesResponse#resource_shares #resource_shares} => Array<Types::ResourceShare>
|
743
938
|
# * {Types::GetResourceSharesResponse#next_token #next_token} => String
|
744
939
|
#
|
940
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
941
|
+
#
|
745
942
|
# @example Request syntax with placeholder values
|
746
943
|
#
|
747
944
|
# resp = client.get_resource_shares({
|
@@ -773,6 +970,7 @@ module Aws::RAM
|
|
773
970
|
# resp.resource_shares[0].tags[0].value #=> String
|
774
971
|
# resp.resource_shares[0].creation_time #=> Time
|
775
972
|
# resp.resource_shares[0].last_updated_time #=> Time
|
973
|
+
# resp.resource_shares[0].feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
|
776
974
|
# resp.next_token #=> String
|
777
975
|
#
|
778
976
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShares AWS API Documentation
|
@@ -803,6 +1001,8 @@ module Aws::RAM
|
|
803
1001
|
# * {Types::ListPendingInvitationResourcesResponse#resources #resources} => Array<Types::Resource>
|
804
1002
|
# * {Types::ListPendingInvitationResourcesResponse#next_token #next_token} => String
|
805
1003
|
#
|
1004
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1005
|
+
#
|
806
1006
|
# @example Request syntax with placeholder values
|
807
1007
|
#
|
808
1008
|
# resp = client.list_pending_invitation_resources({
|
@@ -817,6 +1017,7 @@ module Aws::RAM
|
|
817
1017
|
# resp.resources[0].arn #=> String
|
818
1018
|
# resp.resources[0].type #=> String
|
819
1019
|
# resp.resources[0].resource_share_arn #=> String
|
1020
|
+
# resp.resources[0].resource_group_arn #=> String
|
820
1021
|
# resp.resources[0].status #=> String, one of "AVAILABLE", "ZONAL_RESOURCE_INACCESSIBLE", "LIMIT_EXCEEDED", "UNAVAILABLE", "PENDING"
|
821
1022
|
# resp.resources[0].status_message #=> String
|
822
1023
|
# resp.resources[0].creation_time #=> Time
|
@@ -832,8 +1033,58 @@ module Aws::RAM
|
|
832
1033
|
req.send_request(options)
|
833
1034
|
end
|
834
1035
|
|
835
|
-
# Lists the
|
836
|
-
#
|
1036
|
+
# Lists the AWS RAM permissions.
|
1037
|
+
#
|
1038
|
+
# @option params [String] :resource_type
|
1039
|
+
# Specifies the resource type for which to list permissions. For
|
1040
|
+
# example, to list only permissions that apply to EC2 subnets, specify
|
1041
|
+
# `ec2:Subnet`.
|
1042
|
+
#
|
1043
|
+
# @option params [String] :next_token
|
1044
|
+
# The token for the next page of results.
|
1045
|
+
#
|
1046
|
+
# @option params [Integer] :max_results
|
1047
|
+
# The maximum number of results to return with a single call. To
|
1048
|
+
# retrieve the remaining results, make another call with the returned
|
1049
|
+
# `nextToken` value.
|
1050
|
+
#
|
1051
|
+
# @return [Types::ListPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1052
|
+
#
|
1053
|
+
# * {Types::ListPermissionsResponse#permissions #permissions} => Array<Types::ResourceSharePermissionSummary>
|
1054
|
+
# * {Types::ListPermissionsResponse#next_token #next_token} => String
|
1055
|
+
#
|
1056
|
+
# @example Request syntax with placeholder values
|
1057
|
+
#
|
1058
|
+
# resp = client.list_permissions({
|
1059
|
+
# resource_type: "String",
|
1060
|
+
# next_token: "String",
|
1061
|
+
# max_results: 1,
|
1062
|
+
# })
|
1063
|
+
#
|
1064
|
+
# @example Response structure
|
1065
|
+
#
|
1066
|
+
# resp.permissions #=> Array
|
1067
|
+
# resp.permissions[0].arn #=> String
|
1068
|
+
# resp.permissions[0].version #=> String
|
1069
|
+
# resp.permissions[0].default_version #=> Boolean
|
1070
|
+
# resp.permissions[0].name #=> String
|
1071
|
+
# resp.permissions[0].resource_type #=> String
|
1072
|
+
# resp.permissions[0].status #=> String
|
1073
|
+
# resp.permissions[0].creation_time #=> Time
|
1074
|
+
# resp.permissions[0].last_updated_time #=> Time
|
1075
|
+
# resp.next_token #=> String
|
1076
|
+
#
|
1077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissions AWS API Documentation
|
1078
|
+
#
|
1079
|
+
# @overload list_permissions(params = {})
|
1080
|
+
# @param [Hash] params ({})
|
1081
|
+
def list_permissions(params = {}, options = {})
|
1082
|
+
req = build_request(:list_permissions, params)
|
1083
|
+
req.send_request(options)
|
1084
|
+
end
|
1085
|
+
|
1086
|
+
# Lists the principals that you have shared resources with or that have
|
1087
|
+
# shared resources with you.
|
837
1088
|
#
|
838
1089
|
# @option params [required, String] :resource_owner
|
839
1090
|
# The type of owner.
|
@@ -847,8 +1098,13 @@ module Aws::RAM
|
|
847
1098
|
# @option params [String] :resource_type
|
848
1099
|
# The resource type.
|
849
1100
|
#
|
850
|
-
# Valid values: `
|
851
|
-
# \| `ec2:
|
1101
|
+
# Valid values: `codebuild:Project` \| `codebuild:ReportGroup` \|
|
1102
|
+
# `ec2:CapacityReservation` \| `ec2:DedicatedHost` \| `ec2:Subnet` \|
|
1103
|
+
# `ec2:TrafficMirrorTarget` \| `ec2:TransitGateway` \|
|
1104
|
+
# `imagebuilder:Component` \| `imagebuilder:Image` \|
|
1105
|
+
# `imagebuilder:ImageRecipe` \| `license-manager:LicenseConfiguration` I
|
1106
|
+
# `resource-groups:Group` \| `rds:Cluster` \|
|
1107
|
+
# `route53resolver:ResolverRule`
|
852
1108
|
#
|
853
1109
|
# @option params [Array<String>] :resource_share_arns
|
854
1110
|
# The Amazon Resource Names (ARN) of the resource shares.
|
@@ -866,6 +1122,8 @@ module Aws::RAM
|
|
866
1122
|
# * {Types::ListPrincipalsResponse#principals #principals} => Array<Types::Principal>
|
867
1123
|
# * {Types::ListPrincipalsResponse#next_token #next_token} => String
|
868
1124
|
#
|
1125
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1126
|
+
#
|
869
1127
|
# @example Request syntax with placeholder values
|
870
1128
|
#
|
871
1129
|
# resp = client.list_principals({
|
@@ -897,6 +1155,93 @@ module Aws::RAM
|
|
897
1155
|
req.send_request(options)
|
898
1156
|
end
|
899
1157
|
|
1158
|
+
# Lists the AWS RAM permissions that are associated with a resource
|
1159
|
+
# share.
|
1160
|
+
#
|
1161
|
+
# @option params [required, String] :resource_share_arn
|
1162
|
+
# The Amazon Resource Name (ARN) of the resource share.
|
1163
|
+
#
|
1164
|
+
# @option params [String] :next_token
|
1165
|
+
# The token for the next page of results.
|
1166
|
+
#
|
1167
|
+
# @option params [Integer] :max_results
|
1168
|
+
# The maximum number of results to return with a single call. To
|
1169
|
+
# retrieve the remaining results, make another call with the returned
|
1170
|
+
# `nextToken` value.
|
1171
|
+
#
|
1172
|
+
# @return [Types::ListResourceSharePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1173
|
+
#
|
1174
|
+
# * {Types::ListResourceSharePermissionsResponse#permissions #permissions} => Array<Types::ResourceSharePermissionSummary>
|
1175
|
+
# * {Types::ListResourceSharePermissionsResponse#next_token #next_token} => String
|
1176
|
+
#
|
1177
|
+
# @example Request syntax with placeholder values
|
1178
|
+
#
|
1179
|
+
# resp = client.list_resource_share_permissions({
|
1180
|
+
# resource_share_arn: "String", # required
|
1181
|
+
# next_token: "String",
|
1182
|
+
# max_results: 1,
|
1183
|
+
# })
|
1184
|
+
#
|
1185
|
+
# @example Response structure
|
1186
|
+
#
|
1187
|
+
# resp.permissions #=> Array
|
1188
|
+
# resp.permissions[0].arn #=> String
|
1189
|
+
# resp.permissions[0].version #=> String
|
1190
|
+
# resp.permissions[0].default_version #=> Boolean
|
1191
|
+
# resp.permissions[0].name #=> String
|
1192
|
+
# resp.permissions[0].resource_type #=> String
|
1193
|
+
# resp.permissions[0].status #=> String
|
1194
|
+
# resp.permissions[0].creation_time #=> Time
|
1195
|
+
# resp.permissions[0].last_updated_time #=> Time
|
1196
|
+
# resp.next_token #=> String
|
1197
|
+
#
|
1198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceSharePermissions AWS API Documentation
|
1199
|
+
#
|
1200
|
+
# @overload list_resource_share_permissions(params = {})
|
1201
|
+
# @param [Hash] params ({})
|
1202
|
+
def list_resource_share_permissions(params = {}, options = {})
|
1203
|
+
req = build_request(:list_resource_share_permissions, params)
|
1204
|
+
req.send_request(options)
|
1205
|
+
end
|
1206
|
+
|
1207
|
+
# Lists the shareable resource types supported by AWS RAM.
|
1208
|
+
#
|
1209
|
+
# @option params [String] :next_token
|
1210
|
+
# The token for the next page of results.
|
1211
|
+
#
|
1212
|
+
# @option params [Integer] :max_results
|
1213
|
+
# The maximum number of results to return with a single call. To
|
1214
|
+
# retrieve the remaining results, make another call with the returned
|
1215
|
+
# `nextToken` value.
|
1216
|
+
#
|
1217
|
+
# @return [Types::ListResourceTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1218
|
+
#
|
1219
|
+
# * {Types::ListResourceTypesResponse#resource_types #resource_types} => Array<Types::ServiceNameAndResourceType>
|
1220
|
+
# * {Types::ListResourceTypesResponse#next_token #next_token} => String
|
1221
|
+
#
|
1222
|
+
# @example Request syntax with placeholder values
|
1223
|
+
#
|
1224
|
+
# resp = client.list_resource_types({
|
1225
|
+
# next_token: "String",
|
1226
|
+
# max_results: 1,
|
1227
|
+
# })
|
1228
|
+
#
|
1229
|
+
# @example Response structure
|
1230
|
+
#
|
1231
|
+
# resp.resource_types #=> Array
|
1232
|
+
# resp.resource_types[0].resource_type #=> String
|
1233
|
+
# resp.resource_types[0].service_name #=> String
|
1234
|
+
# resp.next_token #=> String
|
1235
|
+
#
|
1236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypes AWS API Documentation
|
1237
|
+
#
|
1238
|
+
# @overload list_resource_types(params = {})
|
1239
|
+
# @param [Hash] params ({})
|
1240
|
+
def list_resource_types(params = {}, options = {})
|
1241
|
+
req = build_request(:list_resource_types, params)
|
1242
|
+
req.send_request(options)
|
1243
|
+
end
|
1244
|
+
|
900
1245
|
# Lists the resources that you added to a resource shares or the
|
901
1246
|
# resources that are shared with you.
|
902
1247
|
#
|
@@ -909,8 +1254,13 @@ module Aws::RAM
|
|
909
1254
|
# @option params [String] :resource_type
|
910
1255
|
# The resource type.
|
911
1256
|
#
|
912
|
-
# Valid values: `
|
913
|
-
# \| `ec2:
|
1257
|
+
# Valid values: `codebuild:Project` \| `codebuild:ReportGroup` \|
|
1258
|
+
# `ec2:CapacityReservation` \| `ec2:DedicatedHost` \| `ec2:Subnet` \|
|
1259
|
+
# `ec2:TrafficMirrorTarget` \| `ec2:TransitGateway` \|
|
1260
|
+
# `imagebuilder:Component` \| `imagebuilder:Image` \|
|
1261
|
+
# `imagebuilder:ImageRecipe` \| `license-manager:LicenseConfiguration` I
|
1262
|
+
# `resource-groups:Group` \| `rds:Cluster` \|
|
1263
|
+
# `route53resolver:ResolverRule`
|
914
1264
|
#
|
915
1265
|
# @option params [Array<String>] :resource_arns
|
916
1266
|
# The Amazon Resource Names (ARN) of the resources.
|
@@ -931,6 +1281,8 @@ module Aws::RAM
|
|
931
1281
|
# * {Types::ListResourcesResponse#resources #resources} => Array<Types::Resource>
|
932
1282
|
# * {Types::ListResourcesResponse#next_token #next_token} => String
|
933
1283
|
#
|
1284
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1285
|
+
#
|
934
1286
|
# @example Request syntax with placeholder values
|
935
1287
|
#
|
936
1288
|
# resp = client.list_resources({
|
@@ -949,6 +1301,7 @@ module Aws::RAM
|
|
949
1301
|
# resp.resources[0].arn #=> String
|
950
1302
|
# resp.resources[0].type #=> String
|
951
1303
|
# resp.resources[0].resource_share_arn #=> String
|
1304
|
+
# resp.resources[0].resource_group_arn #=> String
|
952
1305
|
# resp.resources[0].status #=> String, one of "AVAILABLE", "ZONAL_RESOURCE_INACCESSIBLE", "LIMIT_EXCEEDED", "UNAVAILABLE", "PENDING"
|
953
1306
|
# resp.resources[0].status_message #=> String
|
954
1307
|
# resp.resources[0].creation_time #=> Time
|
@@ -964,6 +1317,43 @@ module Aws::RAM
|
|
964
1317
|
req.send_request(options)
|
965
1318
|
end
|
966
1319
|
|
1320
|
+
# Resource shares that were created by attaching a policy to a resource
|
1321
|
+
# are visible only to the resource share owner, and the resource share
|
1322
|
+
# cannot be modified in AWS RAM.
|
1323
|
+
#
|
1324
|
+
# Use this API action to promote the resource share. When you promote
|
1325
|
+
# the resource share, it becomes:
|
1326
|
+
#
|
1327
|
+
# * Visible to all principals that it is shared with.
|
1328
|
+
#
|
1329
|
+
# * Modifiable in AWS RAM.
|
1330
|
+
#
|
1331
|
+
# @option params [required, String] :resource_share_arn
|
1332
|
+
# The ARN of the resource share to promote.
|
1333
|
+
#
|
1334
|
+
# @return [Types::PromoteResourceShareCreatedFromPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1335
|
+
#
|
1336
|
+
# * {Types::PromoteResourceShareCreatedFromPolicyResponse#return_value #return_value} => Boolean
|
1337
|
+
#
|
1338
|
+
# @example Request syntax with placeholder values
|
1339
|
+
#
|
1340
|
+
# resp = client.promote_resource_share_created_from_policy({
|
1341
|
+
# resource_share_arn: "String", # required
|
1342
|
+
# })
|
1343
|
+
#
|
1344
|
+
# @example Response structure
|
1345
|
+
#
|
1346
|
+
# resp.return_value #=> Boolean
|
1347
|
+
#
|
1348
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy AWS API Documentation
|
1349
|
+
#
|
1350
|
+
# @overload promote_resource_share_created_from_policy(params = {})
|
1351
|
+
# @param [Hash] params ({})
|
1352
|
+
def promote_resource_share_created_from_policy(params = {}, options = {})
|
1353
|
+
req = build_request(:promote_resource_share_created_from_policy, params)
|
1354
|
+
req.send_request(options)
|
1355
|
+
end
|
1356
|
+
|
967
1357
|
# Rejects an invitation to a resource share from another AWS account.
|
968
1358
|
#
|
969
1359
|
# @option params [required, String] :resource_share_invitation_arn
|
@@ -1116,6 +1506,7 @@ module Aws::RAM
|
|
1116
1506
|
# resp.resource_share.tags[0].value #=> String
|
1117
1507
|
# resp.resource_share.creation_time #=> Time
|
1118
1508
|
# resp.resource_share.last_updated_time #=> Time
|
1509
|
+
# resp.resource_share.feature_set #=> String, one of "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD"
|
1119
1510
|
# resp.client_token #=> String
|
1120
1511
|
#
|
1121
1512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UpdateResourceShare AWS API Documentation
|
@@ -1140,7 +1531,7 @@ module Aws::RAM
|
|
1140
1531
|
params: params,
|
1141
1532
|
config: config)
|
1142
1533
|
context[:gem_name] = 'aws-sdk-ram'
|
1143
|
-
context[:gem_version] = '1.
|
1534
|
+
context[:gem_version] = '1.17.0'
|
1144
1535
|
Seahorse::Client::Request.new(handlers, context)
|
1145
1536
|
end
|
1146
1537
|
|