aws-sdk-repostspace 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,848 @@
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/version-3/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/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/request_compression.rb'
32
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
33
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
34
+ require 'aws-sdk-core/plugins/sign.rb'
35
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
36
+
37
+ Aws::Plugins::GlobalConfiguration.add_identifier(:repostspace)
38
+
39
+ module Aws::Repostspace
40
+ # An API client for Repostspace. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::Repostspace::Client.new(
43
+ # region: region_name,
44
+ # credentials: credentials,
45
+ # # ...
46
+ # )
47
+ #
48
+ # For details on configuring region and credentials see
49
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
50
+ #
51
+ # See {#initialize} for a full list of supported configuration options.
52
+ class Client < Seahorse::Client::Base
53
+
54
+ include Aws::ClientStubs
55
+
56
+ @identifier = :repostspace
57
+
58
+ set_api(ClientApi::API)
59
+
60
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
61
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
62
+ add_plugin(Aws::Plugins::Logging)
63
+ add_plugin(Aws::Plugins::ParamConverter)
64
+ add_plugin(Aws::Plugins::ParamValidator)
65
+ add_plugin(Aws::Plugins::UserAgent)
66
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
67
+ add_plugin(Aws::Plugins::RetryErrors)
68
+ add_plugin(Aws::Plugins::GlobalConfiguration)
69
+ add_plugin(Aws::Plugins::RegionalEndpoint)
70
+ add_plugin(Aws::Plugins::EndpointDiscovery)
71
+ add_plugin(Aws::Plugins::EndpointPattern)
72
+ add_plugin(Aws::Plugins::ResponsePaging)
73
+ add_plugin(Aws::Plugins::StubResponses)
74
+ add_plugin(Aws::Plugins::IdempotencyToken)
75
+ add_plugin(Aws::Plugins::JsonvalueConverter)
76
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
77
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
78
+ add_plugin(Aws::Plugins::TransferEncoding)
79
+ add_plugin(Aws::Plugins::HttpChecksum)
80
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
81
+ add_plugin(Aws::Plugins::RequestCompression)
82
+ add_plugin(Aws::Plugins::DefaultsMode)
83
+ add_plugin(Aws::Plugins::RecursionDetection)
84
+ add_plugin(Aws::Plugins::Sign)
85
+ add_plugin(Aws::Plugins::Protocols::RestJson)
86
+ add_plugin(Aws::Repostspace::Plugins::Endpoints)
87
+
88
+ # @overload initialize(options)
89
+ # @param [Hash] options
90
+ # @option options [required, Aws::CredentialProvider] :credentials
91
+ # Your AWS credentials. This can be an instance of any one of the
92
+ # following classes:
93
+ #
94
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
95
+ # credentials.
96
+ #
97
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
98
+ # shared file, such as `~/.aws/config`.
99
+ #
100
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
101
+ #
102
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
103
+ # assume a role after providing credentials via the web.
104
+ #
105
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
106
+ # access token generated from `aws login`.
107
+ #
108
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
109
+ # process that outputs to stdout.
110
+ #
111
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
112
+ # from an EC2 IMDS on an EC2 instance.
113
+ #
114
+ # * `Aws::ECSCredentials` - Used for loading credentials from
115
+ # instances running in ECS.
116
+ #
117
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
118
+ # from the Cognito Identity service.
119
+ #
120
+ # When `:credentials` are not configured directly, the following
121
+ # locations will be searched for credentials:
122
+ #
123
+ # * `Aws.config[:credentials]`
124
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
125
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
126
+ # * `~/.aws/credentials`
127
+ # * `~/.aws/config`
128
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
129
+ # are very aggressive. Construct and pass an instance of
130
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
131
+ # enable retries and extended timeouts. Instance profile credential
132
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
133
+ # to true.
134
+ #
135
+ # @option options [required, String] :region
136
+ # The AWS region to connect to. The configured `:region` is
137
+ # used to determine the service `:endpoint`. When not passed,
138
+ # a default `:region` is searched for in the following locations:
139
+ #
140
+ # * `Aws.config[:region]`
141
+ # * `ENV['AWS_REGION']`
142
+ # * `ENV['AMAZON_REGION']`
143
+ # * `ENV['AWS_DEFAULT_REGION']`
144
+ # * `~/.aws/credentials`
145
+ # * `~/.aws/config`
146
+ #
147
+ # @option options [String] :access_key_id
148
+ #
149
+ # @option options [Boolean] :active_endpoint_cache (false)
150
+ # When set to `true`, a thread polling for endpoints will be running in
151
+ # the background every 60 secs (default). Defaults to `false`.
152
+ #
153
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
154
+ # Used only in `adaptive` retry mode. When true, the request will sleep
155
+ # until there is sufficent client side capacity to retry the request.
156
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
157
+ # not retry instead of sleeping.
158
+ #
159
+ # @option options [Boolean] :client_side_monitoring (false)
160
+ # When `true`, client-side metrics will be collected for all API requests from
161
+ # this client.
162
+ #
163
+ # @option options [String] :client_side_monitoring_client_id ("")
164
+ # Allows you to provide an identifier for this client which will be attached to
165
+ # all generated client side metrics. Defaults to an empty string.
166
+ #
167
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
168
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
169
+ # side monitoring agent is running on, where client metrics will be published via UDP.
170
+ #
171
+ # @option options [Integer] :client_side_monitoring_port (31000)
172
+ # Required for publishing client metrics. The port that the client side monitoring
173
+ # agent is running on, where client metrics will be published via UDP.
174
+ #
175
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
176
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
177
+ # will use the Client Side Monitoring Agent Publisher.
178
+ #
179
+ # @option options [Boolean] :convert_params (true)
180
+ # When `true`, an attempt is made to coerce request parameters into
181
+ # the required types.
182
+ #
183
+ # @option options [Boolean] :correct_clock_skew (true)
184
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
185
+ # a clock skew correction and retry requests with skewed client clocks.
186
+ #
187
+ # @option options [String] :defaults_mode ("legacy")
188
+ # See {Aws::DefaultsModeConfiguration} for a list of the
189
+ # accepted modes and the configuration defaults that are included.
190
+ #
191
+ # @option options [Boolean] :disable_host_prefix_injection (false)
192
+ # Set to true to disable SDK automatically adding host prefix
193
+ # to default service endpoint when available.
194
+ #
195
+ # @option options [Boolean] :disable_request_compression (false)
196
+ # When set to 'true' the request body will not be compressed
197
+ # for supported operations.
198
+ #
199
+ # @option options [String] :endpoint
200
+ # The client endpoint is normally constructed from the `:region`
201
+ # option. You should only configure an `:endpoint` when connecting
202
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
203
+ #
204
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
205
+ # Used for the maximum size limit of the LRU cache storing endpoints data
206
+ # for endpoint discovery enabled operations. Defaults to 1000.
207
+ #
208
+ # @option options [Integer] :endpoint_cache_max_threads (10)
209
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
210
+ #
211
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
212
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
213
+ # Use this option to config the time interval in seconds for making
214
+ # requests fetching endpoints information. Defaults to 60 sec.
215
+ #
216
+ # @option options [Boolean] :endpoint_discovery (false)
217
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
218
+ #
219
+ # @option options [Boolean] :ignore_configured_endpoint_urls
220
+ # Setting to true disables use of endpoint URLs provided via environment
221
+ # variables and the shared configuration file.
222
+ #
223
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
224
+ # The log formatter.
225
+ #
226
+ # @option options [Symbol] :log_level (:info)
227
+ # The log level to send messages to the `:logger` at.
228
+ #
229
+ # @option options [Logger] :logger
230
+ # The Logger instance to send log messages to. If this option
231
+ # is not set, logging will be disabled.
232
+ #
233
+ # @option options [Integer] :max_attempts (3)
234
+ # An integer representing the maximum number attempts that will be made for
235
+ # a single request, including the initial attempt. For example,
236
+ # setting this value to 5 will result in a request being retried up to
237
+ # 4 times. Used in `standard` and `adaptive` retry modes.
238
+ #
239
+ # @option options [String] :profile ("default")
240
+ # Used when loading credentials from the shared credentials file
241
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
242
+ #
243
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
244
+ # The minimum size in bytes that triggers compression for request
245
+ # bodies. The value must be non-negative integer value between 0
246
+ # and 10485780 bytes inclusive.
247
+ #
248
+ # @option options [Proc] :retry_backoff
249
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
250
+ # This option is only used in the `legacy` retry mode.
251
+ #
252
+ # @option options [Float] :retry_base_delay (0.3)
253
+ # The base delay in seconds used by the default backoff function. This option
254
+ # is only used in the `legacy` retry mode.
255
+ #
256
+ # @option options [Symbol] :retry_jitter (:none)
257
+ # A delay randomiser function used by the default backoff function.
258
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
259
+ # otherwise a Proc that takes and returns a number. This option is only used
260
+ # in the `legacy` retry mode.
261
+ #
262
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
263
+ #
264
+ # @option options [Integer] :retry_limit (3)
265
+ # The maximum number of times to retry failed requests. Only
266
+ # ~ 500 level server errors and certain ~ 400 level client errors
267
+ # are retried. Generally, these are throttling errors, data
268
+ # checksum errors, networking errors, timeout errors, auth errors,
269
+ # endpoint discovery, and errors from expired credentials.
270
+ # This option is only used in the `legacy` retry mode.
271
+ #
272
+ # @option options [Integer] :retry_max_delay (0)
273
+ # The maximum number of seconds to delay between retries (0 for no limit)
274
+ # used by the default backoff function. This option is only used in the
275
+ # `legacy` retry mode.
276
+ #
277
+ # @option options [String] :retry_mode ("legacy")
278
+ # Specifies which retry algorithm to use. Values are:
279
+ #
280
+ # * `legacy` - The pre-existing retry behavior. This is default value if
281
+ # no retry mode is provided.
282
+ #
283
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
284
+ # This includes support for retry quotas, which limit the number of
285
+ # unsuccessful retries a client can make.
286
+ #
287
+ # * `adaptive` - An experimental retry mode that includes all the
288
+ # functionality of `standard` mode along with automatic client side
289
+ # throttling. This is a provisional mode that may change behavior
290
+ # in the future.
291
+ #
292
+ #
293
+ # @option options [String] :sdk_ua_app_id
294
+ # A unique and opaque application ID that is appended to the
295
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
296
+ # maximum length of 50.
297
+ #
298
+ # @option options [String] :secret_access_key
299
+ #
300
+ # @option options [String] :session_token
301
+ #
302
+ # @option options [Boolean] :stub_responses (false)
303
+ # Causes the client to return stubbed responses. By default
304
+ # fake responses are generated and returned. You can specify
305
+ # the response data to return or errors to raise by calling
306
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
307
+ #
308
+ # ** Please note ** When response stubbing is enabled, no HTTP
309
+ # requests are made, and retries are disabled.
310
+ #
311
+ # @option options [Aws::TokenProvider] :token_provider
312
+ # A Bearer Token Provider. This can be an instance of any one of the
313
+ # following classes:
314
+ #
315
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
316
+ # tokens.
317
+ #
318
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
319
+ # access token generated from `aws login`.
320
+ #
321
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
322
+ # will be used to search for tokens configured for your profile in shared configuration files.
323
+ #
324
+ # @option options [Boolean] :use_dualstack_endpoint
325
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
326
+ # will be used if available.
327
+ #
328
+ # @option options [Boolean] :use_fips_endpoint
329
+ # When set to `true`, fips compatible endpoints will be used if available.
330
+ # When a `fips` region is used, the region is normalized and this config
331
+ # is set to `true`.
332
+ #
333
+ # @option options [Boolean] :validate_params (true)
334
+ # When `true`, request parameters are validated before
335
+ # sending the request.
336
+ #
337
+ # @option options [Aws::Repostspace::EndpointProvider] :endpoint_provider
338
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Repostspace::EndpointParameters`
339
+ #
340
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
341
+ # requests through. Formatted like 'http://proxy.com:123'.
342
+ #
343
+ # @option options [Float] :http_open_timeout (15) The number of
344
+ # seconds to wait when opening a HTTP session before raising a
345
+ # `Timeout::Error`.
346
+ #
347
+ # @option options [Float] :http_read_timeout (60) The default
348
+ # number of seconds to wait for response data. This value can
349
+ # safely be set per-request on the session.
350
+ #
351
+ # @option options [Float] :http_idle_timeout (5) The number of
352
+ # seconds a connection is allowed to sit idle before it is
353
+ # considered stale. Stale connections are closed and removed
354
+ # from the pool before making a request.
355
+ #
356
+ # @option options [Float] :http_continue_timeout (1) The number of
357
+ # seconds to wait for a 100-continue response before sending the
358
+ # request body. This option has no effect unless the request has
359
+ # "Expect" header set to "100-continue". Defaults to `nil` which
360
+ # disables this behaviour. This value can safely be set per
361
+ # request on the session.
362
+ #
363
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
364
+ # in seconds.
365
+ #
366
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
367
+ # HTTP debug output will be sent to the `:logger`.
368
+ #
369
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
370
+ # SSL peer certificates are verified when establishing a
371
+ # connection.
372
+ #
373
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
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.
378
+ #
379
+ # @option options [String] :ssl_ca_directory Full path of the
380
+ # directory that contains the unbundled SSL certificate
381
+ # authority files for verifying peer certificates. If you do
382
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
383
+ # system default will be used if available.
384
+ #
385
+ def initialize(*args)
386
+ super
387
+ end
388
+
389
+ # @!group API Operations
390
+
391
+ # Creates an AWS re:Post Private private re:Post.
392
+ #
393
+ # @option params [String] :description
394
+ # A description for the private re:Post. This is used only to help you
395
+ # identify this private re:Post.
396
+ #
397
+ # @option params [required, String] :name
398
+ # The name for the private re:Post. This must be unique in your account.
399
+ #
400
+ # @option params [String] :role_arn
401
+ # The IAM role that grants permissions to the private re:Post to convert
402
+ # unanswered questions into AWS support tickets.
403
+ #
404
+ # @option params [required, String] :subdomain
405
+ # The subdomain that you use to access your AWS re:Post Private private
406
+ # re:Post. All custom subdomains must be approved by AWS before use. In
407
+ # addition to your custom subdomain, all private re:Posts are issued an
408
+ # AWS generated subdomain for immediate use.
409
+ #
410
+ # @option params [Hash<String,String>] :tags
411
+ # The list of tags associated with the private re:Post.
412
+ #
413
+ # @option params [required, String] :tier
414
+ # The pricing tier for the private re:Post.
415
+ #
416
+ # @option params [String] :user_kms_key
417
+ # The AWS KMS key ARN that’s used for the AWS KMS encryption. If you
418
+ # don't provide a key, your data is encrypted by default with a key
419
+ # that AWS owns and manages for you.
420
+ #
421
+ # @return [Types::CreateSpaceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
422
+ #
423
+ # * {Types::CreateSpaceOutput#space_id #space_id} => String
424
+ #
425
+ # @example Request syntax with placeholder values
426
+ #
427
+ # resp = client.create_space({
428
+ # description: "SpaceDescription",
429
+ # name: "SpaceName", # required
430
+ # role_arn: "Arn",
431
+ # subdomain: "SpaceSubdomain", # required
432
+ # tags: {
433
+ # "TagKey" => "TagValue",
434
+ # },
435
+ # tier: "BASIC", # required, accepts BASIC, STANDARD
436
+ # user_kms_key: "KMSKey",
437
+ # })
438
+ #
439
+ # @example Response structure
440
+ #
441
+ # resp.space_id #=> String
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/CreateSpace AWS API Documentation
444
+ #
445
+ # @overload create_space(params = {})
446
+ # @param [Hash] params ({})
447
+ def create_space(params = {}, options = {})
448
+ req = build_request(:create_space, params)
449
+ req.send_request(options)
450
+ end
451
+
452
+ # Deletes an AWS re:Post Private private re:Post.
453
+ #
454
+ # @option params [required, String] :space_id
455
+ # The unique ID of the private re:Post.
456
+ #
457
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
458
+ #
459
+ # @example Request syntax with placeholder values
460
+ #
461
+ # resp = client.delete_space({
462
+ # space_id: "SpaceId", # required
463
+ # })
464
+ #
465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/DeleteSpace AWS API Documentation
466
+ #
467
+ # @overload delete_space(params = {})
468
+ # @param [Hash] params ({})
469
+ def delete_space(params = {}, options = {})
470
+ req = build_request(:delete_space, params)
471
+ req.send_request(options)
472
+ end
473
+
474
+ # Removes the user or group from the list of administrators of the
475
+ # private re:Post.
476
+ #
477
+ # @option params [required, String] :admin_id
478
+ # The ID of the admin to remove.
479
+ #
480
+ # @option params [required, String] :space_id
481
+ # The ID of the private re:Post to remove the admin from.
482
+ #
483
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
484
+ #
485
+ # @example Request syntax with placeholder values
486
+ #
487
+ # resp = client.deregister_admin({
488
+ # admin_id: "AdminId", # required
489
+ # space_id: "SpaceId", # required
490
+ # })
491
+ #
492
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/DeregisterAdmin AWS API Documentation
493
+ #
494
+ # @overload deregister_admin(params = {})
495
+ # @param [Hash] params ({})
496
+ def deregister_admin(params = {}, options = {})
497
+ req = build_request(:deregister_admin, params)
498
+ req.send_request(options)
499
+ end
500
+
501
+ # Displays information about the AWS re:Post Private private re:Post.
502
+ #
503
+ # @option params [required, String] :space_id
504
+ # The ID of the private re:Post.
505
+ #
506
+ # @return [Types::GetSpaceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
507
+ #
508
+ # * {Types::GetSpaceOutput#arn #arn} => String
509
+ # * {Types::GetSpaceOutput#client_id #client_id} => String
510
+ # * {Types::GetSpaceOutput#configuration_status #configuration_status} => String
511
+ # * {Types::GetSpaceOutput#content_size #content_size} => Integer
512
+ # * {Types::GetSpaceOutput#create_date_time #create_date_time} => Time
513
+ # * {Types::GetSpaceOutput#customer_role_arn #customer_role_arn} => String
514
+ # * {Types::GetSpaceOutput#delete_date_time #delete_date_time} => Time
515
+ # * {Types::GetSpaceOutput#description #description} => String
516
+ # * {Types::GetSpaceOutput#group_admins #group_admins} => Array&lt;String&gt;
517
+ # * {Types::GetSpaceOutput#name #name} => String
518
+ # * {Types::GetSpaceOutput#random_domain #random_domain} => String
519
+ # * {Types::GetSpaceOutput#space_id #space_id} => String
520
+ # * {Types::GetSpaceOutput#status #status} => String
521
+ # * {Types::GetSpaceOutput#storage_limit #storage_limit} => Integer
522
+ # * {Types::GetSpaceOutput#tier #tier} => String
523
+ # * {Types::GetSpaceOutput#user_admins #user_admins} => Array&lt;String&gt;
524
+ # * {Types::GetSpaceOutput#user_count #user_count} => Integer
525
+ # * {Types::GetSpaceOutput#user_kms_key #user_kms_key} => String
526
+ # * {Types::GetSpaceOutput#vanity_domain #vanity_domain} => String
527
+ # * {Types::GetSpaceOutput#vanity_domain_status #vanity_domain_status} => String
528
+ #
529
+ # @example Request syntax with placeholder values
530
+ #
531
+ # resp = client.get_space({
532
+ # space_id: "SpaceId", # required
533
+ # })
534
+ #
535
+ # @example Response structure
536
+ #
537
+ # resp.arn #=> String
538
+ # resp.client_id #=> String
539
+ # resp.configuration_status #=> String, one of "CONFIGURED", "UNCONFIGURED"
540
+ # resp.content_size #=> Integer
541
+ # resp.create_date_time #=> Time
542
+ # resp.customer_role_arn #=> String
543
+ # resp.delete_date_time #=> Time
544
+ # resp.description #=> String
545
+ # resp.group_admins #=> Array
546
+ # resp.group_admins[0] #=> String
547
+ # resp.name #=> String
548
+ # resp.random_domain #=> String
549
+ # resp.space_id #=> String
550
+ # resp.status #=> String
551
+ # resp.storage_limit #=> Integer
552
+ # resp.tier #=> String, one of "BASIC", "STANDARD"
553
+ # resp.user_admins #=> Array
554
+ # resp.user_admins[0] #=> String
555
+ # resp.user_count #=> Integer
556
+ # resp.user_kms_key #=> String
557
+ # resp.vanity_domain #=> String
558
+ # resp.vanity_domain_status #=> String, one of "PENDING", "APPROVED", "UNAPPROVED"
559
+ #
560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/GetSpace AWS API Documentation
561
+ #
562
+ # @overload get_space(params = {})
563
+ # @param [Hash] params ({})
564
+ def get_space(params = {}, options = {})
565
+ req = build_request(:get_space, params)
566
+ req.send_request(options)
567
+ end
568
+
569
+ # Returns a list of AWS re:Post Private private re:Posts in the account
570
+ # with some information about each private re:Post.
571
+ #
572
+ # @option params [Integer] :max_results
573
+ # The maximum number of private re:Posts to include in the results.
574
+ #
575
+ # @option params [String] :next_token
576
+ # The token for the next set of private re:Posts to return. You receive
577
+ # this token from a previous ListSpaces operation.
578
+ #
579
+ # @return [Types::ListSpacesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
580
+ #
581
+ # * {Types::ListSpacesOutput#next_token #next_token} => String
582
+ # * {Types::ListSpacesOutput#spaces #spaces} => Array&lt;Types::SpaceData&gt;
583
+ #
584
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
585
+ #
586
+ # @example Request syntax with placeholder values
587
+ #
588
+ # resp = client.list_spaces({
589
+ # max_results: 1,
590
+ # next_token: "String",
591
+ # })
592
+ #
593
+ # @example Response structure
594
+ #
595
+ # resp.next_token #=> String
596
+ # resp.spaces #=> Array
597
+ # resp.spaces[0].arn #=> String
598
+ # resp.spaces[0].configuration_status #=> String, one of "CONFIGURED", "UNCONFIGURED"
599
+ # resp.spaces[0].content_size #=> Integer
600
+ # resp.spaces[0].create_date_time #=> Time
601
+ # resp.spaces[0].delete_date_time #=> Time
602
+ # resp.spaces[0].description #=> String
603
+ # resp.spaces[0].name #=> String
604
+ # resp.spaces[0].random_domain #=> String
605
+ # resp.spaces[0].space_id #=> String
606
+ # resp.spaces[0].status #=> String
607
+ # resp.spaces[0].storage_limit #=> Integer
608
+ # resp.spaces[0].tier #=> String, one of "BASIC", "STANDARD"
609
+ # resp.spaces[0].user_count #=> Integer
610
+ # resp.spaces[0].user_kms_key #=> String
611
+ # resp.spaces[0].vanity_domain #=> String
612
+ # resp.spaces[0].vanity_domain_status #=> String, one of "PENDING", "APPROVED", "UNAPPROVED"
613
+ #
614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/ListSpaces AWS API Documentation
615
+ #
616
+ # @overload list_spaces(params = {})
617
+ # @param [Hash] params ({})
618
+ def list_spaces(params = {}, options = {})
619
+ req = build_request(:list_spaces, params)
620
+ req.send_request(options)
621
+ end
622
+
623
+ # Returns the tags that are associated with the AWS re:Post Private
624
+ # resource specified by the resourceArn. The only resource that can be
625
+ # tagged is a private re:Post.
626
+ #
627
+ # @option params [required, String] :resource_arn
628
+ # The ARN of the resource that the tags are associated with.
629
+ #
630
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
631
+ #
632
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
633
+ #
634
+ # @example Request syntax with placeholder values
635
+ #
636
+ # resp = client.list_tags_for_resource({
637
+ # resource_arn: "Arn", # required
638
+ # })
639
+ #
640
+ # @example Response structure
641
+ #
642
+ # resp.tags #=> Hash
643
+ # resp.tags["TagKey"] #=> String
644
+ #
645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/ListTagsForResource AWS API Documentation
646
+ #
647
+ # @overload list_tags_for_resource(params = {})
648
+ # @param [Hash] params ({})
649
+ def list_tags_for_resource(params = {}, options = {})
650
+ req = build_request(:list_tags_for_resource, params)
651
+ req.send_request(options)
652
+ end
653
+
654
+ # Adds a user or group to the list of administrators of the private
655
+ # re:Post.
656
+ #
657
+ # @option params [required, String] :admin_id
658
+ # The ID of the administrator.
659
+ #
660
+ # @option params [required, String] :space_id
661
+ # The ID of the private re:Post.
662
+ #
663
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
664
+ #
665
+ # @example Request syntax with placeholder values
666
+ #
667
+ # resp = client.register_admin({
668
+ # admin_id: "AdminId", # required
669
+ # space_id: "SpaceId", # required
670
+ # })
671
+ #
672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/RegisterAdmin AWS API Documentation
673
+ #
674
+ # @overload register_admin(params = {})
675
+ # @param [Hash] params ({})
676
+ def register_admin(params = {}, options = {})
677
+ req = build_request(:register_admin, params)
678
+ req.send_request(options)
679
+ end
680
+
681
+ # Sends an invitation email to selected users and groups.
682
+ #
683
+ # @option params [required, Array<String>] :accessor_ids
684
+ # The array of identifiers for the users and groups.
685
+ #
686
+ # @option params [required, String] :body
687
+ # The body of the invite.
688
+ #
689
+ # @option params [required, String] :space_id
690
+ # The ID of the private re:Post.
691
+ #
692
+ # @option params [required, String] :title
693
+ # The title of the invite.
694
+ #
695
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
696
+ #
697
+ # @example Request syntax with placeholder values
698
+ #
699
+ # resp = client.send_invites({
700
+ # accessor_ids: ["AccessorId"], # required
701
+ # body: "InviteBody", # required
702
+ # space_id: "SpaceId", # required
703
+ # title: "InviteTitle", # required
704
+ # })
705
+ #
706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/SendInvites AWS API Documentation
707
+ #
708
+ # @overload send_invites(params = {})
709
+ # @param [Hash] params ({})
710
+ def send_invites(params = {}, options = {})
711
+ req = build_request(:send_invites, params)
712
+ req.send_request(options)
713
+ end
714
+
715
+ # Associates tags with an AWS re:Post Private resource. Currently, the
716
+ # only resource that can be tagged is the private re:Post. If you
717
+ # specify a new tag key for the resource, the tag is appended to the
718
+ # list of tags that are associated with the resource. If you specify a
719
+ # tag key that’s already associated with the resource, the new tag value
720
+ # that you specify replaces the previous value for that tag.
721
+ #
722
+ # @option params [required, String] :resource_arn
723
+ # The ARN of the resource that the tag is associated with.
724
+ #
725
+ # @option params [required, Hash<String,String>] :tags
726
+ # The list of tag keys and values that must be associated with the
727
+ # resource. You can associate tag keys only, tags (key and values) only,
728
+ # or a combination of tag keys and tags.
729
+ #
730
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
731
+ #
732
+ # @example Request syntax with placeholder values
733
+ #
734
+ # resp = client.tag_resource({
735
+ # resource_arn: "Arn", # required
736
+ # tags: { # required
737
+ # "TagKey" => "TagValue",
738
+ # },
739
+ # })
740
+ #
741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/TagResource AWS API Documentation
742
+ #
743
+ # @overload tag_resource(params = {})
744
+ # @param [Hash] params ({})
745
+ def tag_resource(params = {}, options = {})
746
+ req = build_request(:tag_resource, params)
747
+ req.send_request(options)
748
+ end
749
+
750
+ # Removes the association of the tag with the AWS re:Post Private
751
+ # resource.
752
+ #
753
+ # @option params [required, String] :resource_arn
754
+ # The ARN of the resource.
755
+ #
756
+ # @option params [required, Array<String>] :tag_keys
757
+ # The key values of the tag.
758
+ #
759
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
760
+ #
761
+ # @example Request syntax with placeholder values
762
+ #
763
+ # resp = client.untag_resource({
764
+ # resource_arn: "Arn", # required
765
+ # tag_keys: ["TagKey"], # required
766
+ # })
767
+ #
768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/UntagResource AWS API Documentation
769
+ #
770
+ # @overload untag_resource(params = {})
771
+ # @param [Hash] params ({})
772
+ def untag_resource(params = {}, options = {})
773
+ req = build_request(:untag_resource, params)
774
+ req.send_request(options)
775
+ end
776
+
777
+ # Modifies an existing AWS re:Post Private private re:Post.
778
+ #
779
+ # @option params [String] :description
780
+ # A description for the private re:Post. This is used only to help you
781
+ # identify this private re:Post.
782
+ #
783
+ # @option params [String] :role_arn
784
+ # The IAM role that grants permissions to the private re:Post to convert
785
+ # unanswered questions into AWS support tickets.
786
+ #
787
+ # @option params [required, String] :space_id
788
+ # The unique ID of this private re:Post.
789
+ #
790
+ # @option params [String] :tier
791
+ # The pricing tier of this private re:Post.
792
+ #
793
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
794
+ #
795
+ # @example Request syntax with placeholder values
796
+ #
797
+ # resp = client.update_space({
798
+ # description: "SpaceDescription",
799
+ # role_arn: "Arn",
800
+ # space_id: "SpaceId", # required
801
+ # tier: "BASIC", # accepts BASIC, STANDARD
802
+ # })
803
+ #
804
+ # @see http://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/UpdateSpace AWS API Documentation
805
+ #
806
+ # @overload update_space(params = {})
807
+ # @param [Hash] params ({})
808
+ def update_space(params = {}, options = {})
809
+ req = build_request(:update_space, params)
810
+ req.send_request(options)
811
+ end
812
+
813
+ # @!endgroup
814
+
815
+ # @param params ({})
816
+ # @api private
817
+ def build_request(operation_name, params = {})
818
+ handlers = @handlers.for(operation_name)
819
+ context = Seahorse::Client::RequestContext.new(
820
+ operation_name: operation_name,
821
+ operation: config.api.operation(operation_name),
822
+ client: self,
823
+ params: params,
824
+ config: config)
825
+ context[:gem_name] = 'aws-sdk-repostspace'
826
+ context[:gem_version] = '1.0.0'
827
+ Seahorse::Client::Request.new(handlers, context)
828
+ end
829
+
830
+ # @api private
831
+ # @deprecated
832
+ def waiter_names
833
+ []
834
+ end
835
+
836
+ class << self
837
+
838
+ # @api private
839
+ attr_reader :identifier
840
+
841
+ # @api private
842
+ def errors_module
843
+ Errors
844
+ end
845
+
846
+ end
847
+ end
848
+ end