aws-sdk-identitystore 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-identitystore.rb +52 -0
- data/lib/aws-sdk-identitystore/client.rb +569 -0
- data/lib/aws-sdk-identitystore/client_api.rb +209 -0
- data/lib/aws-sdk-identitystore/customizations.rb +0 -0
- data/lib/aws-sdk-identitystore/errors.rb +153 -0
- data/lib/aws-sdk-identitystore/resource.rb +26 -0
- data/lib/aws-sdk-identitystore/types.rb +472 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 1bc830e43a2dad6fb8de6618fd96499b33920f9b3473c6a18b25627e15878ebb
|
4
|
+
data.tar.gz: ba9b44147ee10562730792cdaf927af9316c06f06b6734957778add190d2d39d
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: dd99555a09fe814efca2fb1ac62eb9ec1d2e870125d3afffd56dca806a3a8afb65cf9dcb88a6b6ff060b0c60e02c434fb7b7a2eee391f7d67133d6781361331f
|
7
|
+
data.tar.gz: 64ccd3dd73b6e34f8ac10da3151101106dc07c792973377f0baa95afce7a071e60daad2086237eea4c0676f0824e1c7e9a77e54b5612b01a13300a6090daac49
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'aws-sdk-core'
|
11
|
+
require 'aws-sigv4'
|
12
|
+
|
13
|
+
require_relative 'aws-sdk-identitystore/types'
|
14
|
+
require_relative 'aws-sdk-identitystore/client_api'
|
15
|
+
require_relative 'aws-sdk-identitystore/client'
|
16
|
+
require_relative 'aws-sdk-identitystore/errors'
|
17
|
+
require_relative 'aws-sdk-identitystore/resource'
|
18
|
+
require_relative 'aws-sdk-identitystore/customizations'
|
19
|
+
|
20
|
+
# This module provides support for AWS SSO Identity Store. This module is available in the
|
21
|
+
# `aws-sdk-identitystore` gem.
|
22
|
+
#
|
23
|
+
# # Client
|
24
|
+
#
|
25
|
+
# The {Client} class provides one method for each API operation. Operation
|
26
|
+
# methods each accept a hash of request parameters and return a response
|
27
|
+
# structure.
|
28
|
+
#
|
29
|
+
# identity_store = Aws::IdentityStore::Client.new
|
30
|
+
# resp = identity_store.describe_group(params)
|
31
|
+
#
|
32
|
+
# See {Client} for more information.
|
33
|
+
#
|
34
|
+
# # Errors
|
35
|
+
#
|
36
|
+
# Errors returned from AWS SSO Identity Store are defined in the
|
37
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
38
|
+
#
|
39
|
+
# begin
|
40
|
+
# # do stuff
|
41
|
+
# rescue Aws::IdentityStore::Errors::ServiceError
|
42
|
+
# # rescues all AWS SSO Identity Store API errors
|
43
|
+
# end
|
44
|
+
#
|
45
|
+
# See {Errors} for more information.
|
46
|
+
#
|
47
|
+
# @service
|
48
|
+
module Aws::IdentityStore
|
49
|
+
|
50
|
+
GEM_VERSION = '1.0.0'
|
51
|
+
|
52
|
+
end
|
@@ -0,0 +1,569 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
|
+
|
33
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:identitystore)
|
34
|
+
|
35
|
+
module Aws::IdentityStore
|
36
|
+
# An API client for IdentityStore. To construct a client, you need to configure a `:region` and `:credentials`.
|
37
|
+
#
|
38
|
+
# client = Aws::IdentityStore::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
43
|
+
#
|
44
|
+
# For details on configuring region and credentials see
|
45
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
46
|
+
#
|
47
|
+
# See {#initialize} for a full list of supported configuration options.
|
48
|
+
class Client < Seahorse::Client::Base
|
49
|
+
|
50
|
+
include Aws::ClientStubs
|
51
|
+
|
52
|
+
@identifier = :identitystore
|
53
|
+
|
54
|
+
set_api(ClientApi::API)
|
55
|
+
|
56
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
57
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
58
|
+
add_plugin(Aws::Plugins::Logging)
|
59
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
60
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
61
|
+
add_plugin(Aws::Plugins::UserAgent)
|
62
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
63
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
64
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
65
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
66
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
67
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
68
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
69
|
+
add_plugin(Aws::Plugins::StubResponses)
|
70
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
71
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
72
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
73
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
77
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
|
+
|
79
|
+
# @overload initialize(options)
|
80
|
+
# @param [Hash] options
|
81
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
82
|
+
# Your AWS credentials. This can be an instance of any one of the
|
83
|
+
# following classes:
|
84
|
+
#
|
85
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
|
+
# credentials.
|
87
|
+
#
|
88
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
|
+
# from an EC2 IMDS on an EC2 instance.
|
90
|
+
#
|
91
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
92
|
+
# shared file, such as `~/.aws/config`.
|
93
|
+
#
|
94
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
95
|
+
#
|
96
|
+
# When `:credentials` are not configured directly, the following
|
97
|
+
# locations will be searched for credentials:
|
98
|
+
#
|
99
|
+
# * `Aws.config[:credentials]`
|
100
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
101
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
|
+
# * `~/.aws/credentials`
|
103
|
+
# * `~/.aws/config`
|
104
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
105
|
+
# very aggressive. Construct and pass an instance of
|
106
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
107
|
+
# timeouts.
|
108
|
+
#
|
109
|
+
# @option options [required, String] :region
|
110
|
+
# The AWS region to connect to. The configured `:region` is
|
111
|
+
# used to determine the service `:endpoint`. When not passed,
|
112
|
+
# a default `:region` is searched for in the following locations:
|
113
|
+
#
|
114
|
+
# * `Aws.config[:region]`
|
115
|
+
# * `ENV['AWS_REGION']`
|
116
|
+
# * `ENV['AMAZON_REGION']`
|
117
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
118
|
+
# * `~/.aws/credentials`
|
119
|
+
# * `~/.aws/config`
|
120
|
+
#
|
121
|
+
# @option options [String] :access_key_id
|
122
|
+
#
|
123
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
124
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
125
|
+
# the background every 60 secs (default). Defaults to `false`.
|
126
|
+
#
|
127
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
128
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
129
|
+
# until there is sufficent client side capacity to retry the request.
|
130
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
131
|
+
# not retry instead of sleeping.
|
132
|
+
#
|
133
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
134
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
135
|
+
# this client.
|
136
|
+
#
|
137
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
138
|
+
# Allows you to provide an identifier for this client which will be attached to
|
139
|
+
# all generated client side metrics. Defaults to an empty string.
|
140
|
+
#
|
141
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
142
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
143
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
144
|
+
#
|
145
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
146
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
147
|
+
# agent is running on, where client metrics will be published via UDP.
|
148
|
+
#
|
149
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
150
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
151
|
+
# will use the Client Side Monitoring Agent Publisher.
|
152
|
+
#
|
153
|
+
# @option options [Boolean] :convert_params (true)
|
154
|
+
# When `true`, an attempt is made to coerce request parameters into
|
155
|
+
# the required types.
|
156
|
+
#
|
157
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
158
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
159
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
160
|
+
#
|
161
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
162
|
+
# Set to true to disable SDK automatically adding host prefix
|
163
|
+
# to default service endpoint when available.
|
164
|
+
#
|
165
|
+
# @option options [String] :endpoint
|
166
|
+
# The client endpoint is normally constructed from the `:region`
|
167
|
+
# option. You should only configure an `:endpoint` when connecting
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
169
|
+
#
|
170
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
171
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
172
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
173
|
+
#
|
174
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
175
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
176
|
+
#
|
177
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
178
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
179
|
+
# Use this option to config the time interval in seconds for making
|
180
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
181
|
+
#
|
182
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
184
|
+
#
|
185
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
186
|
+
# The log formatter.
|
187
|
+
#
|
188
|
+
# @option options [Symbol] :log_level (:info)
|
189
|
+
# The log level to send messages to the `:logger` at.
|
190
|
+
#
|
191
|
+
# @option options [Logger] :logger
|
192
|
+
# The Logger instance to send log messages to. If this option
|
193
|
+
# is not set, logging will be disabled.
|
194
|
+
#
|
195
|
+
# @option options [Integer] :max_attempts (3)
|
196
|
+
# An integer representing the maximum number attempts that will be made for
|
197
|
+
# a single request, including the initial attempt. For example,
|
198
|
+
# setting this value to 5 will result in a request being retried up to
|
199
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
200
|
+
#
|
201
|
+
# @option options [String] :profile ("default")
|
202
|
+
# Used when loading credentials from the shared credentials file
|
203
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
204
|
+
#
|
205
|
+
# @option options [Proc] :retry_backoff
|
206
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
207
|
+
# This option is only used in the `legacy` retry mode.
|
208
|
+
#
|
209
|
+
# @option options [Float] :retry_base_delay (0.3)
|
210
|
+
# The base delay in seconds used by the default backoff function. This option
|
211
|
+
# is only used in the `legacy` retry mode.
|
212
|
+
#
|
213
|
+
# @option options [Symbol] :retry_jitter (:none)
|
214
|
+
# A delay randomiser function used by the default backoff function.
|
215
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
216
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
217
|
+
# in the `legacy` retry mode.
|
218
|
+
#
|
219
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
220
|
+
#
|
221
|
+
# @option options [Integer] :retry_limit (3)
|
222
|
+
# The maximum number of times to retry failed requests. Only
|
223
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
224
|
+
# are retried. Generally, these are throttling errors, data
|
225
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
226
|
+
# endpoint discovery, and errors from expired credentials.
|
227
|
+
# This option is only used in the `legacy` retry mode.
|
228
|
+
#
|
229
|
+
# @option options [Integer] :retry_max_delay (0)
|
230
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
231
|
+
# used by the default backoff function. This option is only used in the
|
232
|
+
# `legacy` retry mode.
|
233
|
+
#
|
234
|
+
# @option options [String] :retry_mode ("legacy")
|
235
|
+
# Specifies which retry algorithm to use. Values are:
|
236
|
+
#
|
237
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
238
|
+
# no retry mode is provided.
|
239
|
+
#
|
240
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
241
|
+
# This includes support for retry quotas, which limit the number of
|
242
|
+
# unsuccessful retries a client can make.
|
243
|
+
#
|
244
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
245
|
+
# functionality of `standard` mode along with automatic client side
|
246
|
+
# throttling. This is a provisional mode that may change behavior
|
247
|
+
# in the future.
|
248
|
+
#
|
249
|
+
#
|
250
|
+
# @option options [String] :secret_access_key
|
251
|
+
#
|
252
|
+
# @option options [String] :session_token
|
253
|
+
#
|
254
|
+
# @option options [Boolean] :simple_json (false)
|
255
|
+
# Disables request parameter conversion, validation, and formatting.
|
256
|
+
# Also disable response data type conversions. This option is useful
|
257
|
+
# when you want to ensure the highest level of performance by
|
258
|
+
# avoiding overhead of walking request parameters and response data
|
259
|
+
# structures.
|
260
|
+
#
|
261
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
262
|
+
# be formatted exactly as the DynamoDB API expects.
|
263
|
+
#
|
264
|
+
# @option options [Boolean] :stub_responses (false)
|
265
|
+
# Causes the client to return stubbed responses. By default
|
266
|
+
# fake responses are generated and returned. You can specify
|
267
|
+
# the response data to return or errors to raise by calling
|
268
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
269
|
+
#
|
270
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
271
|
+
# requests are made, and retries are disabled.
|
272
|
+
#
|
273
|
+
# @option options [Boolean] :validate_params (true)
|
274
|
+
# When `true`, request parameters are validated before
|
275
|
+
# sending the request.
|
276
|
+
#
|
277
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
278
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
279
|
+
#
|
280
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
281
|
+
# seconds to wait when opening a HTTP session before raising a
|
282
|
+
# `Timeout::Error`.
|
283
|
+
#
|
284
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
285
|
+
# number of seconds to wait for response data. This value can
|
286
|
+
# safely be set per-request on the session.
|
287
|
+
#
|
288
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
289
|
+
# seconds a connection is allowed to sit idle before it is
|
290
|
+
# considered stale. Stale connections are closed and removed
|
291
|
+
# from the pool before making a request.
|
292
|
+
#
|
293
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
294
|
+
# seconds to wait for a 100-continue response before sending the
|
295
|
+
# request body. This option has no effect unless the request has
|
296
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
297
|
+
# disables this behaviour. This value can safely be set per
|
298
|
+
# request on the session.
|
299
|
+
#
|
300
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
301
|
+
# HTTP debug output will be sent to the `:logger`.
|
302
|
+
#
|
303
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
304
|
+
# SSL peer certificates are verified when establishing a
|
305
|
+
# connection.
|
306
|
+
#
|
307
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
308
|
+
# certificate authority bundle file that should be used when
|
309
|
+
# verifying peer certificates. If you do not pass
|
310
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
311
|
+
# will be used if available.
|
312
|
+
#
|
313
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
314
|
+
# directory that contains the unbundled SSL certificate
|
315
|
+
# authority files for verifying peer certificates. If you do
|
316
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
317
|
+
# system default will be used if available.
|
318
|
+
#
|
319
|
+
def initialize(*args)
|
320
|
+
super
|
321
|
+
end
|
322
|
+
|
323
|
+
# @!group API Operations
|
324
|
+
|
325
|
+
# Retrieves the group metadata and attributes from `GroupId` in an
|
326
|
+
# identity store.
|
327
|
+
#
|
328
|
+
# @option params [required, String] :identity_store_id
|
329
|
+
# The globally unique identifier for the identity store, such as
|
330
|
+
# d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is
|
331
|
+
# a randomly generated string which contains number and lower case
|
332
|
+
# letters. This value is generated at the time that a new identity store
|
333
|
+
# is created.
|
334
|
+
#
|
335
|
+
# @option params [required, String] :group_id
|
336
|
+
# The identifier for a group in the identity store.
|
337
|
+
#
|
338
|
+
# @return [Types::DescribeGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
339
|
+
#
|
340
|
+
# * {Types::DescribeGroupResponse#group_id #group_id} => String
|
341
|
+
# * {Types::DescribeGroupResponse#display_name #display_name} => String
|
342
|
+
#
|
343
|
+
# @example Request syntax with placeholder values
|
344
|
+
#
|
345
|
+
# resp = client.describe_group({
|
346
|
+
# identity_store_id: "IdentityStoreId", # required
|
347
|
+
# group_id: "ResourceId", # required
|
348
|
+
# })
|
349
|
+
#
|
350
|
+
# @example Response structure
|
351
|
+
#
|
352
|
+
# resp.group_id #=> String
|
353
|
+
# resp.display_name #=> String
|
354
|
+
#
|
355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroup AWS API Documentation
|
356
|
+
#
|
357
|
+
# @overload describe_group(params = {})
|
358
|
+
# @param [Hash] params ({})
|
359
|
+
def describe_group(params = {}, options = {})
|
360
|
+
req = build_request(:describe_group, params)
|
361
|
+
req.send_request(options)
|
362
|
+
end
|
363
|
+
|
364
|
+
# Retrieves the user metadata and attributes from `UserId` in an
|
365
|
+
# identity store.
|
366
|
+
#
|
367
|
+
# @option params [required, String] :identity_store_id
|
368
|
+
# The globally unique identifier for the identity store, such as
|
369
|
+
# d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is
|
370
|
+
# a randomly generated string which contains number and lower case
|
371
|
+
# letters. This value is generated at the time that a new identity store
|
372
|
+
# is created.
|
373
|
+
#
|
374
|
+
# @option params [required, String] :user_id
|
375
|
+
# The identifier for a user in the identity store.
|
376
|
+
#
|
377
|
+
# @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
378
|
+
#
|
379
|
+
# * {Types::DescribeUserResponse#user_name #user_name} => String
|
380
|
+
# * {Types::DescribeUserResponse#user_id #user_id} => String
|
381
|
+
#
|
382
|
+
# @example Request syntax with placeholder values
|
383
|
+
#
|
384
|
+
# resp = client.describe_user({
|
385
|
+
# identity_store_id: "IdentityStoreId", # required
|
386
|
+
# user_id: "ResourceId", # required
|
387
|
+
# })
|
388
|
+
#
|
389
|
+
# @example Response structure
|
390
|
+
#
|
391
|
+
# resp.user_name #=> String
|
392
|
+
# resp.user_id #=> String
|
393
|
+
#
|
394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUser AWS API Documentation
|
395
|
+
#
|
396
|
+
# @overload describe_user(params = {})
|
397
|
+
# @param [Hash] params ({})
|
398
|
+
def describe_user(params = {}, options = {})
|
399
|
+
req = build_request(:describe_user, params)
|
400
|
+
req.send_request(options)
|
401
|
+
end
|
402
|
+
|
403
|
+
# Lists the attribute name and value of the group that you specified in
|
404
|
+
# the search. We only support `DisplayName` as a valid filter attribute
|
405
|
+
# path currently, and filter is required. This API returns minimum
|
406
|
+
# attributes, including `GroupId` and group `DisplayName` in the
|
407
|
+
# response.
|
408
|
+
#
|
409
|
+
# @option params [required, String] :identity_store_id
|
410
|
+
# The globally unique identifier for the identity store, such as
|
411
|
+
# d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is
|
412
|
+
# a randomly generated string which contains number and lower case
|
413
|
+
# letters. This value is generated at the time that a new identity store
|
414
|
+
# is created.
|
415
|
+
#
|
416
|
+
# @option params [Integer] :max_results
|
417
|
+
# The maximum number of results to be returned per request, which is
|
418
|
+
# used in the `ListUsers` and `ListGroups` request to specify how many
|
419
|
+
# results to return in one page. The length limit is 50 characters.
|
420
|
+
#
|
421
|
+
# @option params [String] :next_token
|
422
|
+
# The pagination token used for the `ListUsers` and `ListGroups` APIs.
|
423
|
+
# This value is generated by the identity store service and is returned
|
424
|
+
# in the API response if the total results are more than the size of one
|
425
|
+
# page, and when this token is used in the API request to search for the
|
426
|
+
# next page.
|
427
|
+
#
|
428
|
+
# @option params [Array<Types::Filter>] :filters
|
429
|
+
# A list of `Filter` objects, which is used in the `ListUsers` and
|
430
|
+
# `ListGroups` request.
|
431
|
+
#
|
432
|
+
# @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
433
|
+
#
|
434
|
+
# * {Types::ListGroupsResponse#groups #groups} => Array<Types::Group>
|
435
|
+
# * {Types::ListGroupsResponse#next_token #next_token} => String
|
436
|
+
#
|
437
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
438
|
+
#
|
439
|
+
# @example Request syntax with placeholder values
|
440
|
+
#
|
441
|
+
# resp = client.list_groups({
|
442
|
+
# identity_store_id: "IdentityStoreId", # required
|
443
|
+
# max_results: 1,
|
444
|
+
# next_token: "NextToken",
|
445
|
+
# filters: [
|
446
|
+
# {
|
447
|
+
# attribute_path: "AttributePath", # required
|
448
|
+
# attribute_value: "SensitiveStringType", # required
|
449
|
+
# },
|
450
|
+
# ],
|
451
|
+
# })
|
452
|
+
#
|
453
|
+
# @example Response structure
|
454
|
+
#
|
455
|
+
# resp.groups #=> Array
|
456
|
+
# resp.groups[0].group_id #=> String
|
457
|
+
# resp.groups[0].display_name #=> String
|
458
|
+
# resp.next_token #=> String
|
459
|
+
#
|
460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroups AWS API Documentation
|
461
|
+
#
|
462
|
+
# @overload list_groups(params = {})
|
463
|
+
# @param [Hash] params ({})
|
464
|
+
def list_groups(params = {}, options = {})
|
465
|
+
req = build_request(:list_groups, params)
|
466
|
+
req.send_request(options)
|
467
|
+
end
|
468
|
+
|
469
|
+
# Lists the attribute name and value of the user that you specified in
|
470
|
+
# the search. We only support `UserName` as a valid filter attribute
|
471
|
+
# path currently, and filter is required. This API returns minimum
|
472
|
+
# attributes, including `UserId` and `UserName` in the response.
|
473
|
+
#
|
474
|
+
# @option params [required, String] :identity_store_id
|
475
|
+
# The globally unique identifier for the identity store, such as
|
476
|
+
# d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is
|
477
|
+
# a randomly generated string which contains number and lower case
|
478
|
+
# letters. This value is generated at the time that a new identity store
|
479
|
+
# is created.
|
480
|
+
#
|
481
|
+
# @option params [Integer] :max_results
|
482
|
+
# The maximum number of results to be returned per request, which is
|
483
|
+
# used in the `ListUsers` and `ListGroups` request to specify how many
|
484
|
+
# results to return in one page. The length limit is 50 characters.
|
485
|
+
#
|
486
|
+
# @option params [String] :next_token
|
487
|
+
# The pagination token used for the `ListUsers` and `ListGroups` APIs.
|
488
|
+
# This value is generated by the identity store service and is returned
|
489
|
+
# in the API response if the total results are more than the size of one
|
490
|
+
# page, and when this token is used in the API request to search for the
|
491
|
+
# next page.
|
492
|
+
#
|
493
|
+
# @option params [Array<Types::Filter>] :filters
|
494
|
+
# A list of `Filter` objects, which is used in the `ListUsers` and
|
495
|
+
# `ListGroups` request.
|
496
|
+
#
|
497
|
+
# @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
498
|
+
#
|
499
|
+
# * {Types::ListUsersResponse#users #users} => Array<Types::User>
|
500
|
+
# * {Types::ListUsersResponse#next_token #next_token} => String
|
501
|
+
#
|
502
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
503
|
+
#
|
504
|
+
# @example Request syntax with placeholder values
|
505
|
+
#
|
506
|
+
# resp = client.list_users({
|
507
|
+
# identity_store_id: "IdentityStoreId", # required
|
508
|
+
# max_results: 1,
|
509
|
+
# next_token: "NextToken",
|
510
|
+
# filters: [
|
511
|
+
# {
|
512
|
+
# attribute_path: "AttributePath", # required
|
513
|
+
# attribute_value: "SensitiveStringType", # required
|
514
|
+
# },
|
515
|
+
# ],
|
516
|
+
# })
|
517
|
+
#
|
518
|
+
# @example Response structure
|
519
|
+
#
|
520
|
+
# resp.users #=> Array
|
521
|
+
# resp.users[0].user_name #=> String
|
522
|
+
# resp.users[0].user_id #=> String
|
523
|
+
# resp.next_token #=> String
|
524
|
+
#
|
525
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsers AWS API Documentation
|
526
|
+
#
|
527
|
+
# @overload list_users(params = {})
|
528
|
+
# @param [Hash] params ({})
|
529
|
+
def list_users(params = {}, options = {})
|
530
|
+
req = build_request(:list_users, params)
|
531
|
+
req.send_request(options)
|
532
|
+
end
|
533
|
+
|
534
|
+
# @!endgroup
|
535
|
+
|
536
|
+
# @param params ({})
|
537
|
+
# @api private
|
538
|
+
def build_request(operation_name, params = {})
|
539
|
+
handlers = @handlers.for(operation_name)
|
540
|
+
context = Seahorse::Client::RequestContext.new(
|
541
|
+
operation_name: operation_name,
|
542
|
+
operation: config.api.operation(operation_name),
|
543
|
+
client: self,
|
544
|
+
params: params,
|
545
|
+
config: config)
|
546
|
+
context[:gem_name] = 'aws-sdk-identitystore'
|
547
|
+
context[:gem_version] = '1.0.0'
|
548
|
+
Seahorse::Client::Request.new(handlers, context)
|
549
|
+
end
|
550
|
+
|
551
|
+
# @api private
|
552
|
+
# @deprecated
|
553
|
+
def waiter_names
|
554
|
+
[]
|
555
|
+
end
|
556
|
+
|
557
|
+
class << self
|
558
|
+
|
559
|
+
# @api private
|
560
|
+
attr_reader :identifier
|
561
|
+
|
562
|
+
# @api private
|
563
|
+
def errors_module
|
564
|
+
Errors
|
565
|
+
end
|
566
|
+
|
567
|
+
end
|
568
|
+
end
|
569
|
+
end
|