aws-sdk-core 3.173.0 → 3.254.1

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.
Files changed (213) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +947 -0
  3. data/VERSION +1 -1
  4. data/lib/aws-defaults/default_configuration.rb +5 -6
  5. data/lib/aws-defaults.rb +4 -1
  6. data/lib/aws-sdk-core/arn.rb +1 -3
  7. data/lib/aws-sdk-core/assume_role_credentials.rb +21 -13
  8. data/lib/aws-sdk-core/assume_role_web_identity_credentials.rb +16 -9
  9. data/lib/aws-sdk-core/binary/decode_handler.rb +3 -9
  10. data/lib/aws-sdk-core/binary/encode_handler.rb +1 -1
  11. data/lib/aws-sdk-core/binary/event_builder.rb +34 -37
  12. data/lib/aws-sdk-core/binary/event_stream_decoder.rb +1 -0
  13. data/lib/aws-sdk-core/binary/event_stream_encoder.rb +4 -3
  14. data/lib/aws-sdk-core/cbor/decoder.rb +309 -0
  15. data/lib/aws-sdk-core/cbor/encoder.rb +243 -0
  16. data/lib/aws-sdk-core/cbor.rb +53 -0
  17. data/lib/aws-sdk-core/client_side_monitoring.rb +9 -0
  18. data/lib/aws-sdk-core/client_stubs.rb +39 -55
  19. data/lib/aws-sdk-core/credential_provider.rb +8 -1
  20. data/lib/aws-sdk-core/credential_provider_chain.rb +101 -25
  21. data/lib/aws-sdk-core/credentials.rb +19 -6
  22. data/lib/aws-sdk-core/ec2_metadata.rb +1 -1
  23. data/lib/aws-sdk-core/ecs_credentials.rb +104 -26
  24. data/lib/aws-sdk-core/endpoints/endpoint.rb +3 -1
  25. data/lib/aws-sdk-core/endpoints/matchers.rb +21 -19
  26. data/lib/aws-sdk-core/endpoints.rb +106 -22
  27. data/lib/aws-sdk-core/error_handler.rb +46 -0
  28. data/lib/aws-sdk-core/errors.rb +17 -5
  29. data/lib/aws-sdk-core/event_emitter.rb +1 -17
  30. data/lib/aws-sdk-core/ini_parser.rb +7 -0
  31. data/lib/aws-sdk-core/instance_profile_credentials.rb +181 -158
  32. data/lib/aws-sdk-core/json/builder.rb +23 -1
  33. data/lib/aws-sdk-core/json/error_handler.rb +31 -14
  34. data/lib/aws-sdk-core/json/handler.rb +13 -6
  35. data/lib/aws-sdk-core/json/json_engine.rb +3 -1
  36. data/lib/aws-sdk-core/json/oj_engine.rb +7 -1
  37. data/lib/aws-sdk-core/json/parser.rb +33 -3
  38. data/lib/aws-sdk-core/json.rb +43 -14
  39. data/lib/aws-sdk-core/log/param_filter.rb +2 -2
  40. data/lib/aws-sdk-core/log/param_formatter.rb +7 -3
  41. data/lib/aws-sdk-core/log.rb +10 -0
  42. data/lib/aws-sdk-core/login_credentials.rb +230 -0
  43. data/lib/aws-sdk-core/lru_cache.rb +75 -0
  44. data/lib/aws-sdk-core/pageable_response.rb +3 -1
  45. data/lib/aws-sdk-core/param_validator.rb +9 -4
  46. data/lib/aws-sdk-core/plugins/bearer_authorization.rb +2 -0
  47. data/lib/aws-sdk-core/plugins/checksum_algorithm.rb +437 -201
  48. data/lib/aws-sdk-core/plugins/client_metrics_plugin.rb +1 -1
  49. data/lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb +14 -2
  50. data/lib/aws-sdk-core/plugins/credentials_configuration.rb +78 -56
  51. data/lib/aws-sdk-core/plugins/endpoint_pattern.rb +40 -32
  52. data/lib/aws-sdk-core/plugins/global_configuration.rb +8 -9
  53. data/lib/aws-sdk-core/plugins/http_checksum.rb +3 -8
  54. data/lib/aws-sdk-core/plugins/invocation_id.rb +1 -11
  55. data/lib/aws-sdk-core/plugins/logging.rb +2 -0
  56. data/lib/aws-sdk-core/plugins/protocols/api_gateway.rb +3 -1
  57. data/lib/aws-sdk-core/plugins/protocols/ec2.rb +2 -24
  58. data/lib/aws-sdk-core/plugins/protocols/json_rpc.rb +6 -8
  59. data/lib/aws-sdk-core/plugins/protocols/query.rb +4 -2
  60. data/lib/aws-sdk-core/plugins/protocols/rest_json.rb +3 -15
  61. data/lib/aws-sdk-core/plugins/protocols/rest_xml.rb +3 -0
  62. data/lib/aws-sdk-core/plugins/protocols/rpc_v2.rb +17 -0
  63. data/lib/aws-sdk-core/plugins/regional_endpoint.rb +162 -37
  64. data/lib/aws-sdk-core/plugins/request_compression.rb +226 -0
  65. data/lib/aws-sdk-core/plugins/retries/clock_skew.rb +28 -16
  66. data/lib/aws-sdk-core/plugins/retries/retry_quota.rb +11 -8
  67. data/lib/aws-sdk-core/plugins/retry_errors.rb +211 -110
  68. data/lib/aws-sdk-core/plugins/sign.rb +55 -33
  69. data/lib/aws-sdk-core/plugins/signature_v2.rb +2 -1
  70. data/lib/aws-sdk-core/plugins/signature_v4.rb +2 -1
  71. data/lib/aws-sdk-core/plugins/stub_responses.rb +59 -9
  72. data/lib/aws-sdk-core/plugins/telemetry.rb +75 -0
  73. data/lib/aws-sdk-core/plugins/transfer_encoding.rb +16 -9
  74. data/lib/aws-sdk-core/plugins/user_agent.rb +205 -14
  75. data/lib/aws-sdk-core/plugins.rb +39 -0
  76. data/lib/aws-sdk-core/process_credentials.rb +48 -29
  77. data/lib/aws-sdk-core/query/ec2_handler.rb +27 -0
  78. data/lib/aws-sdk-core/query/ec2_param_builder.rb +5 -7
  79. data/lib/aws-sdk-core/query/handler.rb +4 -4
  80. data/lib/aws-sdk-core/query/param_builder.rb +2 -2
  81. data/lib/aws-sdk-core/query.rb +2 -1
  82. data/lib/aws-sdk-core/refreshing_credentials.rb +20 -23
  83. data/lib/aws-sdk-core/resources.rb +8 -0
  84. data/lib/aws-sdk-core/rest/content_type_handler.rb +60 -0
  85. data/lib/aws-sdk-core/rest/handler.rb +3 -4
  86. data/lib/aws-sdk-core/rest/request/body.rb +32 -5
  87. data/lib/aws-sdk-core/rest/request/endpoint.rb +24 -4
  88. data/lib/aws-sdk-core/rest/request/headers.rb +15 -7
  89. data/lib/aws-sdk-core/rest/request/querystring_builder.rb +62 -36
  90. data/lib/aws-sdk-core/rest/response/body.rb +15 -1
  91. data/lib/aws-sdk-core/rest/response/header_list_parser.rb +79 -0
  92. data/lib/aws-sdk-core/rest/response/headers.rb +8 -3
  93. data/lib/aws-sdk-core/rest.rb +1 -0
  94. data/lib/aws-sdk-core/rpc_v2/builder.rb +62 -0
  95. data/lib/aws-sdk-core/rpc_v2/cbor_engine.rb +18 -0
  96. data/lib/aws-sdk-core/rpc_v2/content_type_handler.rb +47 -0
  97. data/lib/aws-sdk-core/rpc_v2/error_handler.rb +95 -0
  98. data/lib/aws-sdk-core/rpc_v2/handler.rb +79 -0
  99. data/lib/aws-sdk-core/rpc_v2/parser.rb +98 -0
  100. data/lib/aws-sdk-core/rpc_v2.rb +69 -0
  101. data/lib/aws-sdk-core/shared_config.rb +155 -39
  102. data/lib/aws-sdk-core/shared_credentials.rb +1 -7
  103. data/lib/aws-sdk-core/sso_credentials.rb +6 -3
  104. data/lib/aws-sdk-core/sso_token_provider.rb +1 -0
  105. data/lib/aws-sdk-core/static_token_provider.rb +1 -2
  106. data/lib/aws-sdk-core/stubbing/protocols/ec2.rb +12 -11
  107. data/lib/aws-sdk-core/stubbing/protocols/json.rb +11 -10
  108. data/lib/aws-sdk-core/stubbing/protocols/query.rb +7 -6
  109. data/lib/aws-sdk-core/stubbing/protocols/rest.rb +2 -1
  110. data/lib/aws-sdk-core/stubbing/protocols/rest_json.rb +9 -8
  111. data/lib/aws-sdk-core/stubbing/protocols/rest_xml.rb +6 -5
  112. data/lib/aws-sdk-core/stubbing/protocols/rpc_v2.rb +39 -0
  113. data/lib/aws-sdk-core/stubbing/stub_data.rb +11 -0
  114. data/lib/aws-sdk-core/stubbing.rb +22 -0
  115. data/lib/aws-sdk-core/telemetry/base.rb +177 -0
  116. data/lib/aws-sdk-core/telemetry/no_op.rb +70 -0
  117. data/lib/aws-sdk-core/telemetry/otel.rb +235 -0
  118. data/lib/aws-sdk-core/telemetry/span_kind.rb +22 -0
  119. data/lib/aws-sdk-core/telemetry/span_status.rb +59 -0
  120. data/lib/aws-sdk-core/telemetry.rb +78 -0
  121. data/lib/aws-sdk-core/token.rb +3 -3
  122. data/lib/aws-sdk-core/token_provider.rb +4 -0
  123. data/lib/aws-sdk-core/token_provider_chain.rb +2 -6
  124. data/lib/aws-sdk-core/util.rb +41 -1
  125. data/lib/aws-sdk-core/waiters/poller.rb +12 -5
  126. data/lib/aws-sdk-core/xml/builder.rb +17 -9
  127. data/lib/aws-sdk-core/xml/error_handler.rb +35 -43
  128. data/lib/aws-sdk-core/xml/parser/frame.rb +4 -20
  129. data/lib/aws-sdk-core/xml/parser/stack.rb +2 -0
  130. data/lib/aws-sdk-core/xml/parser.rb +2 -6
  131. data/lib/aws-sdk-core.rb +86 -107
  132. data/lib/aws-sdk-signin/client.rb +1008 -0
  133. data/lib/aws-sdk-signin/client_api.rb +444 -0
  134. data/lib/aws-sdk-signin/customizations.rb +1 -0
  135. data/lib/aws-sdk-signin/endpoint_parameters.rb +85 -0
  136. data/lib/aws-sdk-signin/endpoint_provider.rb +107 -0
  137. data/lib/aws-sdk-signin/endpoints.rb +133 -0
  138. data/lib/aws-sdk-signin/errors.rb +185 -0
  139. data/lib/aws-sdk-signin/plugins/endpoints.rb +77 -0
  140. data/lib/aws-sdk-signin/resource.rb +26 -0
  141. data/lib/aws-sdk-signin/types.rb +909 -0
  142. data/lib/aws-sdk-signin.rb +63 -0
  143. data/lib/aws-sdk-sso/client.rb +210 -99
  144. data/lib/aws-sdk-sso/client_api.rb +7 -0
  145. data/lib/aws-sdk-sso/endpoint_parameters.rb +13 -10
  146. data/lib/aws-sdk-sso/endpoint_provider.rb +30 -28
  147. data/lib/aws-sdk-sso/endpoints.rb +3 -54
  148. data/lib/aws-sdk-sso/plugins/endpoints.rb +23 -22
  149. data/lib/aws-sdk-sso/types.rb +1 -0
  150. data/lib/aws-sdk-sso.rb +15 -11
  151. data/lib/aws-sdk-ssooidc/client.rb +630 -132
  152. data/lib/aws-sdk-ssooidc/client_api.rb +94 -1
  153. data/lib/aws-sdk-ssooidc/endpoint_parameters.rb +13 -10
  154. data/lib/aws-sdk-ssooidc/endpoint_provider.rb +30 -28
  155. data/lib/aws-sdk-ssooidc/endpoints.rb +3 -40
  156. data/lib/aws-sdk-ssooidc/errors.rb +62 -0
  157. data/lib/aws-sdk-ssooidc/plugins/endpoints.rb +23 -20
  158. data/lib/aws-sdk-ssooidc/types.rb +419 -53
  159. data/lib/aws-sdk-ssooidc.rb +15 -11
  160. data/lib/aws-sdk-sts/client.rb +567 -158
  161. data/lib/aws-sdk-sts/client_api.rb +120 -9
  162. data/lib/aws-sdk-sts/customizations.rb +5 -2
  163. data/lib/aws-sdk-sts/endpoint_parameters.rb +15 -14
  164. data/lib/aws-sdk-sts/endpoint_provider.rb +52 -57
  165. data/lib/aws-sdk-sts/endpoints.rb +3 -118
  166. data/lib/aws-sdk-sts/errors.rb +79 -0
  167. data/lib/aws-sdk-sts/plugins/endpoints.rb +23 -30
  168. data/lib/aws-sdk-sts/presigner.rb +3 -7
  169. data/lib/aws-sdk-sts/types.rb +382 -31
  170. data/lib/aws-sdk-sts.rb +15 -11
  171. data/lib/seahorse/client/async_base.rb +4 -5
  172. data/lib/seahorse/client/async_response.rb +19 -0
  173. data/lib/seahorse/client/base.rb +18 -21
  174. data/lib/seahorse/client/configuration.rb +0 -4
  175. data/lib/seahorse/client/h2/connection.rb +18 -28
  176. data/lib/seahorse/client/h2/handler.rb +19 -3
  177. data/lib/seahorse/client/handler.rb +1 -1
  178. data/lib/seahorse/client/http/response.rb +1 -1
  179. data/lib/seahorse/client/net_http/connection_pool.rb +15 -12
  180. data/lib/seahorse/client/net_http/handler.rb +21 -9
  181. data/lib/seahorse/client/net_http/patches.rb +44 -14
  182. data/lib/seahorse/client/networking_error.rb +1 -1
  183. data/lib/seahorse/client/plugin.rb +9 -0
  184. data/lib/seahorse/client/plugins/endpoint.rb +0 -1
  185. data/lib/seahorse/client/plugins/h2.rb +4 -4
  186. data/lib/seahorse/client/plugins/net_http.rb +57 -16
  187. data/lib/seahorse/client/plugins/request_callback.rb +31 -0
  188. data/lib/seahorse/client/request_context.rb +9 -2
  189. data/lib/seahorse/client/response.rb +8 -0
  190. data/lib/seahorse/model/operation.rb +3 -0
  191. data/lib/seahorse/model/shapes.rb +2 -2
  192. data/lib/seahorse/util.rb +2 -1
  193. data/sig/aws-sdk-core/async_client_stubs.rbs +21 -0
  194. data/sig/aws-sdk-core/client_stubs.rbs +10 -0
  195. data/sig/aws-sdk-core/errors.rbs +22 -0
  196. data/sig/aws-sdk-core/resources/collection.rbs +21 -0
  197. data/sig/aws-sdk-core/structure.rbs +4 -0
  198. data/sig/aws-sdk-core/telemetry/base.rbs +46 -0
  199. data/sig/aws-sdk-core/telemetry/otel.rbs +22 -0
  200. data/sig/aws-sdk-core/telemetry/span_kind.rbs +15 -0
  201. data/sig/aws-sdk-core/telemetry/span_status.rbs +24 -0
  202. data/sig/aws-sdk-core/waiters/errors.rbs +20 -0
  203. data/sig/aws-sdk-core.rbs +7 -0
  204. data/sig/seahorse/client/async_base.rbs +18 -0
  205. data/sig/seahorse/client/base.rbs +25 -0
  206. data/sig/seahorse/client/handler_builder.rbs +16 -0
  207. data/sig/seahorse/client/response.rbs +61 -0
  208. metadata +118 -23
  209. /data/lib/aws-sdk-core/xml/parser/{engines/libxml.rb → libxml_engine.rb} +0 -0
  210. /data/lib/aws-sdk-core/xml/parser/{engines/nokogiri.rb → nokogiri_engine.rb} +0 -0
  211. /data/lib/aws-sdk-core/xml/parser/{engines/oga.rb → oga_engine.rb} +0 -0
  212. /data/lib/aws-sdk-core/xml/parser/{engines/ox.rb → ox_engine.rb} +0 -0
  213. /data/lib/aws-sdk-core/xml/parser/{engines/rexml.rb → rexml_engine.rb} +0 -0
@@ -0,0 +1,1008 @@
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'
11
+ require 'aws-sdk-core/plugins/credentials_configuration'
12
+ require 'aws-sdk-core/plugins/logging'
13
+ require 'aws-sdk-core/plugins/param_converter'
14
+ require 'aws-sdk-core/plugins/param_validator'
15
+ require 'aws-sdk-core/plugins/user_agent'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors'
17
+ require 'aws-sdk-core/plugins/retry_errors'
18
+ require 'aws-sdk-core/plugins/global_configuration'
19
+ require 'aws-sdk-core/plugins/regional_endpoint'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern'
22
+ require 'aws-sdk-core/plugins/response_paging'
23
+ require 'aws-sdk-core/plugins/stub_responses'
24
+ require 'aws-sdk-core/plugins/idempotency_token'
25
+ require 'aws-sdk-core/plugins/invocation_id'
26
+ require 'aws-sdk-core/plugins/jsonvalue_converter'
27
+ require 'aws-sdk-core/plugins/client_metrics_plugin'
28
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin'
29
+ require 'aws-sdk-core/plugins/transfer_encoding'
30
+ require 'aws-sdk-core/plugins/http_checksum'
31
+ require 'aws-sdk-core/plugins/checksum_algorithm'
32
+ require 'aws-sdk-core/plugins/request_compression'
33
+ require 'aws-sdk-core/plugins/defaults_mode'
34
+ require 'aws-sdk-core/plugins/recursion_detection'
35
+ require 'aws-sdk-core/plugins/telemetry'
36
+ require 'aws-sdk-core/plugins/sign'
37
+ require 'aws-sdk-core/plugins/protocols/rest_json'
38
+
39
+ module Aws::Signin
40
+ # An API client for Signin. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::Signin::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 = :signin
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::InvocationId)
76
+ add_plugin(Aws::Plugins::JsonvalueConverter)
77
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
78
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
79
+ add_plugin(Aws::Plugins::TransferEncoding)
80
+ add_plugin(Aws::Plugins::HttpChecksum)
81
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
82
+ add_plugin(Aws::Plugins::RequestCompression)
83
+ add_plugin(Aws::Plugins::DefaultsMode)
84
+ add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Telemetry)
86
+ add_plugin(Aws::Plugins::Sign)
87
+ add_plugin(Aws::Plugins::Protocols::RestJson)
88
+ add_plugin(Aws::Signin::Plugins::Endpoints)
89
+
90
+ # @overload initialize(options)
91
+ # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
97
+ # @option options [required, Aws::CredentialProvider] :credentials
98
+ # Your AWS credentials used for authentication. This can be any class that includes and implements
99
+ # `Aws::CredentialProvider`, or instance of any one of the following classes:
100
+ #
101
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
102
+ # credentials.
103
+ #
104
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
105
+ # shared file, such as `~/.aws/config`.
106
+ #
107
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ #
109
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
110
+ # assume a role after providing credentials via the web.
111
+ #
112
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
113
+ # access token generated from `aws login`.
114
+ #
115
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
116
+ # process that outputs to stdout.
117
+ #
118
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
119
+ # from an EC2 IMDS on an EC2 instance.
120
+ #
121
+ # * `Aws::ECSCredentials` - Used for loading credentials from
122
+ # instances running in ECS.
123
+ #
124
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
125
+ # from the Cognito Identity service.
126
+ #
127
+ # When `:credentials` are not configured directly, the following locations will be searched for credentials:
128
+ #
129
+ # * `Aws.config[:credentials]`
130
+ #
131
+ # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
+ # `:account_id` options.
133
+ #
134
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
135
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
136
+ #
137
+ # * `~/.aws/credentials`
138
+ #
139
+ # * `~/.aws/config`
140
+ #
141
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
142
+ # Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
143
+ # enable retries and extended timeouts. Instance profile credential fetching can be disabled by
144
+ # setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
145
+ #
146
+ # @option options [required, String] :region
147
+ # The AWS region to connect to. The configured `:region` is
148
+ # used to determine the service `:endpoint`. When not passed,
149
+ # a default `:region` is searched for in the following locations:
150
+ #
151
+ # * `Aws.config[:region]`
152
+ # * `ENV['AWS_REGION']`
153
+ # * `ENV['AMAZON_REGION']`
154
+ # * `ENV['AWS_DEFAULT_REGION']`
155
+ # * `~/.aws/credentials`
156
+ # * `~/.aws/config`
157
+ #
158
+ # @option options [String] :access_key_id
159
+ #
160
+ # @option options [String] :account_id
161
+ #
162
+ # @option options [Boolean] :active_endpoint_cache (false)
163
+ # When set to `true`, a thread polling for endpoints will be running in
164
+ # the background every 60 secs (default). Defaults to `false`.
165
+ #
166
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
167
+ # Used only in `adaptive` retry mode. When true, the request will sleep
168
+ # until there is sufficent client side capacity to retry the request.
169
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
170
+ # not retry instead of sleeping.
171
+ #
172
+ # @option options [Array<String>] :auth_scheme_preference
173
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
174
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
175
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
176
+ #
177
+ # @option options [Boolean] :client_side_monitoring (false)
178
+ # When `true`, client-side metrics will be collected for all API requests from
179
+ # this client.
180
+ #
181
+ # @option options [String] :client_side_monitoring_client_id ("")
182
+ # Allows you to provide an identifier for this client which will be attached to
183
+ # all generated client side metrics. Defaults to an empty string.
184
+ #
185
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
186
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
187
+ # side monitoring agent is running on, where client metrics will be published via UDP.
188
+ #
189
+ # @option options [Integer] :client_side_monitoring_port (31000)
190
+ # Required for publishing client metrics. The port that the client side monitoring
191
+ # agent is running on, where client metrics will be published via UDP.
192
+ #
193
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
194
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
195
+ # will use the Client Side Monitoring Agent Publisher.
196
+ #
197
+ # @option options [Boolean] :convert_params (true)
198
+ # When `true`, an attempt is made to coerce request parameters into
199
+ # the required types.
200
+ #
201
+ # @option options [Boolean] :correct_clock_skew (true)
202
+ # Used only in `standard` and `adaptive` retry modes. Specifies whether to apply
203
+ # a clock skew correction and retry requests with skewed client clocks.
204
+ #
205
+ # @option options [String] :defaults_mode ("legacy")
206
+ # See {Aws::DefaultsModeConfiguration} for a list of the
207
+ # accepted modes and the configuration defaults that are included.
208
+ #
209
+ # @option options [Boolean] :disable_host_prefix_injection (false)
210
+ # When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
211
+ #
212
+ # @option options [Boolean] :disable_request_compression (false)
213
+ # When set to 'true' the request body will not be compressed
214
+ # for supported operations.
215
+ #
216
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
217
+ # Normally you should not configure the `:endpoint` option
218
+ # directly. This is normally constructed from the `:region`
219
+ # option. Configuring `:endpoint` is normally reserved for
220
+ # connecting to test or custom endpoints. The endpoint should
221
+ # be a URI formatted like:
222
+ #
223
+ # 'http://example.com'
224
+ # 'https://example.com'
225
+ # 'http://example.com:123'
226
+ #
227
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
228
+ # Used for the maximum size limit of the LRU cache storing endpoints data
229
+ # for endpoint discovery enabled operations. Defaults to 1000.
230
+ #
231
+ # @option options [Integer] :endpoint_cache_max_threads (10)
232
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
233
+ #
234
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
235
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
236
+ # Use this option to config the time interval in seconds for making
237
+ # requests fetching endpoints information. Defaults to 60 sec.
238
+ #
239
+ # @option options [Boolean] :endpoint_discovery (false)
240
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
241
+ #
242
+ # @option options [Boolean] :ignore_configured_endpoint_urls
243
+ # Setting to true disables use of endpoint URLs provided via environment
244
+ # variables and the shared configuration file.
245
+ #
246
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
247
+ # The log formatter.
248
+ #
249
+ # @option options [Symbol] :log_level (:info)
250
+ # The log level to send messages to the `:logger` at.
251
+ #
252
+ # @option options [Logger] :logger
253
+ # The Logger instance to send log messages to. If this option
254
+ # is not set, logging will be disabled.
255
+ #
256
+ # @option options [Integer] :max_attempts (3)
257
+ # An integer representing the maximum number attempts that will be made for
258
+ # a single request, including the initial attempt. For example,
259
+ # setting this value to 5 will result in a request being retried up to
260
+ # 4 times. Used in `standard` and `adaptive` retry modes.
261
+ #
262
+ # @option options [String] :profile ("default")
263
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
264
+ # When not specified, 'default' is used.
265
+ #
266
+ # @option options [String] :request_checksum_calculation ("when_supported")
267
+ # Determines when a checksum will be calculated for request payloads. Values are:
268
+ #
269
+ # * `when_supported` - (default) When set, a checksum will be
270
+ # calculated for all request payloads of operations modeled with the
271
+ # `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
272
+ # `requestAlgorithmMember` is modeled.
273
+ # * `when_required` - When set, a checksum will only be calculated for
274
+ # request payloads of operations modeled with the `httpChecksum` trait where
275
+ # `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
276
+ # is modeled and supplied.
277
+ #
278
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
279
+ # The minimum size in bytes that triggers compression for request
280
+ # bodies. The value must be non-negative integer value between 0
281
+ # and 10485780 bytes inclusive.
282
+ #
283
+ # @option options [String] :response_checksum_validation ("when_supported")
284
+ # Determines when checksum validation will be performed on response payloads. Values are:
285
+ #
286
+ # * `when_supported` - (default) When set, checksum validation is performed on all
287
+ # response payloads of operations modeled with the `httpChecksum` trait where
288
+ # `responseAlgorithms` is modeled, except when no modeled checksum algorithms
289
+ # are supported.
290
+ # * `when_required` - When set, checksum validation is not performed on
291
+ # response payloads of operations unless the checksum algorithm is supported and
292
+ # the `requestValidationModeMember` member is set to `ENABLED`.
293
+ #
294
+ # @option options [Proc] :retry_backoff
295
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
296
+ # This option is only used in the `legacy` retry mode.
297
+ #
298
+ # @option options [Float] :retry_base_delay (0.3)
299
+ # The base delay in seconds used by the default backoff function. This option
300
+ # is only used in the `legacy` retry mode.
301
+ #
302
+ # @option options [Symbol] :retry_jitter (:none)
303
+ # A delay randomiser function used by the default backoff function.
304
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
305
+ # otherwise a Proc that takes and returns a number. This option is only used
306
+ # in the `legacy` retry mode.
307
+ #
308
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
309
+ #
310
+ # @option options [Integer] :retry_limit (3)
311
+ # The maximum number of times to retry failed requests. Only
312
+ # ~ 500 level server errors and certain ~ 400 level client errors
313
+ # are retried. Generally, these are throttling errors, data
314
+ # checksum errors, networking errors, timeout errors, auth errors,
315
+ # endpoint discovery, and errors from expired credentials.
316
+ # This option is only used in the `legacy` retry mode.
317
+ #
318
+ # @option options [Integer] :retry_max_delay (0)
319
+ # The maximum number of seconds to delay between retries (0 for no limit)
320
+ # used by the default backoff function. This option is only used in the
321
+ # `legacy` retry mode.
322
+ #
323
+ # @option options [String] :retry_mode ("legacy")
324
+ # Specifies which retry algorithm to use. Values are:
325
+ #
326
+ # * `legacy` - The pre-existing retry behavior. This is the default
327
+ # value if no retry mode is provided.
328
+ #
329
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
330
+ # This includes support for retry quotas, which limit the number of
331
+ # unsuccessful retries a client can make.
332
+ #
333
+ # * `adaptive` - A retry mode that includes all the functionality of
334
+ # `standard` mode along with automatic client side throttling.
335
+ #
336
+ # @option options [String] :sdk_ua_app_id
337
+ # A unique and opaque application ID that is appended to the
338
+ # User-Agent header as app/sdk_ua_app_id. It should have a
339
+ # maximum length of 50. This variable is sourced from environment
340
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
341
+ #
342
+ # @option options [String] :secret_access_key
343
+ #
344
+ # @option options [String] :session_token
345
+ #
346
+ # @option options [Array] :sigv4a_signing_region_set
347
+ # A list of regions that should be signed with SigV4a signing. When
348
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
349
+ # in the following locations:
350
+ #
351
+ # * `Aws.config[:sigv4a_signing_region_set]`
352
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
353
+ # * `~/.aws/config`
354
+ #
355
+ # @option options [Boolean] :stub_responses (false)
356
+ # Causes the client to return stubbed responses. By default
357
+ # fake responses are generated and returned. You can specify
358
+ # the response data to return or errors to raise by calling
359
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
360
+ #
361
+ # ** Please note ** When response stubbing is enabled, no HTTP
362
+ # requests are made, and retries are disabled.
363
+ #
364
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
365
+ # Allows you to provide a telemetry provider, which is used to
366
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
367
+ # will not record or emit any telemetry data. The SDK supports the
368
+ # following telemetry providers:
369
+ #
370
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
371
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
372
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
373
+ #
374
+ # @option options [Aws::TokenProvider] :token_provider
375
+ # Your Bearer token used for authentication. This can be any class that includes and implements
376
+ # `Aws::TokenProvider`, or instance of any one of the following classes:
377
+ #
378
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
379
+ # tokens.
380
+ #
381
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
382
+ # access token generated from `aws login`.
383
+ #
384
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
385
+ # will be used to search for tokens configured for your profile in shared configuration files.
386
+ #
387
+ # @option options [Boolean] :use_dualstack_endpoint
388
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
389
+ # will be used if available.
390
+ #
391
+ # @option options [Boolean] :use_fips_endpoint
392
+ # When set to `true`, fips compatible endpoints will be used if available.
393
+ # When a `fips` region is used, the region is normalized and this config
394
+ # is set to `true`.
395
+ #
396
+ # @option options [Boolean] :validate_params (true)
397
+ # When `true`, request parameters are validated before
398
+ # sending the request.
399
+ #
400
+ # @option options [Aws::Signin::EndpointProvider] :endpoint_provider
401
+ # The endpoint provider used to resolve endpoints. Any object that responds to
402
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
403
+ # `Aws::Signin::EndpointParameters`.
404
+ #
405
+ # @option options [Float] :http_continue_timeout (1)
406
+ # The number of seconds to wait for a 100-continue response before sending the
407
+ # request body. This option has no effect unless the request has "Expect"
408
+ # header set to "100-continue". Defaults to `nil` which disables this
409
+ # behaviour. This value can safely be set per request on the session.
410
+ #
411
+ # @option options [Float] :http_idle_timeout (5)
412
+ # The number of seconds a connection is allowed to sit idle before it
413
+ # is considered stale. Stale connections are closed and removed from the
414
+ # pool before making a request.
415
+ #
416
+ # @option options [Float] :http_open_timeout (15)
417
+ # The default number of seconds to wait for response data.
418
+ # This value can safely be set per-request on the session.
419
+ #
420
+ # @option options [URI::HTTP,String] :http_proxy
421
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
422
+ #
423
+ # @option options [Float] :http_read_timeout (60)
424
+ # The default number of seconds to wait for response data.
425
+ # This value can safely be set per-request on the session.
426
+ #
427
+ # @option options [Boolean] :http_wire_trace (false)
428
+ # When `true`, HTTP debug output will be sent to the `:logger`.
429
+ #
430
+ # @option options [Proc] :on_chunk_received
431
+ # When a Proc object is provided, it will be used as callback when each chunk
432
+ # of the response body is received. It provides three arguments: the chunk,
433
+ # the number of bytes received, and the total number of
434
+ # bytes in the response (or nil if the server did not send a `content-length`).
435
+ #
436
+ # @option options [Proc] :on_chunk_sent
437
+ # When a Proc object is provided, it will be used as callback when each chunk
438
+ # of the request body is sent. It provides three arguments: the chunk,
439
+ # the number of bytes read from the body, and the total number of
440
+ # bytes in the body.
441
+ #
442
+ # @option options [Boolean] :raise_response_errors (true)
443
+ # When `true`, response errors are raised.
444
+ #
445
+ # @option options [String] :ssl_ca_bundle
446
+ # Full path to the SSL certificate authority bundle file that should be used when
447
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
448
+ # `:ssl_ca_directory` the the system default will be used if available.
449
+ #
450
+ # @option options [String] :ssl_ca_directory
451
+ # Full path of the directory that contains the unbundled SSL certificate
452
+ # authority files for verifying peer certificates. If you do
453
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
454
+ # default will be used if available.
455
+ #
456
+ # @option options [String] :ssl_ca_store
457
+ # Sets the X509::Store to verify peer certificate.
458
+ #
459
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
460
+ # Sets a client certificate when creating http connections.
461
+ #
462
+ # @option options [OpenSSL::PKey] :ssl_key
463
+ # Sets a client key when creating http connections.
464
+ #
465
+ # @option options [Float] :ssl_timeout
466
+ # Sets the SSL timeout in seconds
467
+ #
468
+ # @option options [Boolean] :ssl_verify_peer (true)
469
+ # When `true`, SSL peer certificates are verified when establishing a connection.
470
+ #
471
+ def initialize(*args)
472
+ super
473
+ end
474
+
475
+ # @!group API Operations
476
+
477
+ # CreateOAuth2Token API
478
+ #
479
+ # Path: /v1/token Request Method: POST Content-Type: application/json or
480
+ # application/x-www-form-urlencoded
481
+ #
482
+ # This API implements OAuth 2.0 flows for AWS Sign-In CLI clients,
483
+ # supporting both:
484
+ #
485
+ # 1. Authorization code redemption (grant\_type=authorization\_code) -
486
+ # NOT idempotent
487
+ # 2. Token refresh (grant\_type=refresh\_token) - Idempotent within
488
+ # token validity window
489
+ #
490
+ # The operation behavior is determined by the grant\_type parameter in
491
+ # the request body:
492
+ #
493
+ # **Authorization Code Flow (NOT Idempotent):**
494
+ #
495
+ # * JSON or form-encoded body with client\_id,
496
+ # grant\_type=authorization\_code, code, redirect\_uri, code\_verifier
497
+ # * Returns access\_token, token\_type, expires\_in, refresh\_token, and
498
+ # id\_token
499
+ # * Each authorization code can only be used ONCE for security (prevents
500
+ # replay attacks)
501
+ #
502
+ # **Token Refresh Flow (Idempotent):**
503
+ #
504
+ # * JSON or form-encoded body with client\_id,
505
+ # grant\_type=refresh\_token, refresh\_token
506
+ # * Returns access\_token, token\_type, expires\_in, and refresh\_token
507
+ # (no id\_token)
508
+ # * Multiple calls with same refresh\_token return consistent results
509
+ # within validity window
510
+ #
511
+ # Authentication and authorization:
512
+ #
513
+ # * Confidential clients: sigv4 signing required with
514
+ # signin:ExchangeToken permissions
515
+ # * CLI clients (public): authn/authz skipped based on client\_id &amp;
516
+ # grant\_type
517
+ #
518
+ # Note: This operation cannot be marked as @idempotent because it
519
+ # handles both idempotent (token refresh) and non-idempotent (auth code
520
+ # redemption) flows in a single endpoint.
521
+ #
522
+ # @option params [required, Types::CreateOAuth2TokenRequestBody] :token_input
523
+ # Flattened token operation inputs The specific operation is determined
524
+ # by grant\_type in the request body
525
+ #
526
+ # @return [Types::CreateOAuth2TokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
527
+ #
528
+ # * {Types::CreateOAuth2TokenResponse#token_output #token_output} => Types::CreateOAuth2TokenResponseBody
529
+ #
530
+ # @example Request syntax with placeholder values
531
+ #
532
+ # resp = client.create_o_auth_2_token({
533
+ # token_input: { # required
534
+ # client_id: "ClientId", # required
535
+ # grant_type: "GrantType", # required
536
+ # code: "AuthorizationCode",
537
+ # redirect_uri: "RedirectUri",
538
+ # code_verifier: "CodeVerifier",
539
+ # refresh_token: "RefreshToken",
540
+ # },
541
+ # })
542
+ #
543
+ # @example Response structure
544
+ #
545
+ # resp.token_output.access_token.access_key_id #=> String
546
+ # resp.token_output.access_token.secret_access_key #=> String
547
+ # resp.token_output.access_token.session_token #=> String
548
+ # resp.token_output.token_type #=> String
549
+ # resp.token_output.expires_in #=> Integer
550
+ # resp.token_output.refresh_token #=> String
551
+ # resp.token_output.id_token #=> String
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/CreateOAuth2Token AWS API Documentation
554
+ #
555
+ # @overload create_o_auth_2_token(params = {})
556
+ # @param [Hash] params ({})
557
+ def create_o_auth_2_token(params = {}, options = {})
558
+ req = build_request(:create_o_auth_2_token, params)
559
+ req.send_request(options)
560
+ end
561
+
562
+ # Grants permission to exchange client credentials for an OAuth 2.0
563
+ # access token scoped to a resource that can be used to access AWS
564
+ # services from applications
565
+ #
566
+ # @option params [required, String] :grant_type
567
+ # OAuth 2.0 grant type. Must be "client\_credentials".
568
+ #
569
+ # @option params [required, String] :resource
570
+ # The OAuth resource for which the access token is requested. Example:
571
+ # "aws-mcp.amazonaws.com".
572
+ #
573
+ # @return [Types::CreateOAuth2TokenWithIAMResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
574
+ #
575
+ # * {Types::CreateOAuth2TokenWithIAMResponse#access_token #access_token} => String
576
+ # * {Types::CreateOAuth2TokenWithIAMResponse#token_type #token_type} => String
577
+ # * {Types::CreateOAuth2TokenWithIAMResponse#expires_in #expires_in} => Integer
578
+ #
579
+ # @example Request syntax with placeholder values
580
+ #
581
+ # resp = client.create_o_auth_2_token_with_iam({
582
+ # grant_type: "ClientCredentialsGrantType", # required
583
+ # resource: "CreateOAuth2TokenWithIAMRequestResourceString", # required
584
+ # })
585
+ #
586
+ # @example Response structure
587
+ #
588
+ # resp.access_token #=> String
589
+ # resp.token_type #=> String
590
+ # resp.expires_in #=> Integer
591
+ #
592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/CreateOAuth2TokenWithIAM AWS API Documentation
593
+ #
594
+ # @overload create_o_auth_2_token_with_iam(params = {})
595
+ # @param [Hash] params ({})
596
+ def create_o_auth_2_token_with_iam(params = {}, options = {})
597
+ req = build_request(:create_o_auth_2_token_with_iam, params)
598
+ req.send_request(options)
599
+ end
600
+
601
+ # Delete console authorization configuration with automatic scope
602
+ # detection
603
+ #
604
+ # @option params [String] :target_id
605
+ # Target account identifier
606
+ #
607
+ # @return [Types::DeleteConsoleAuthorizationConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
608
+ #
609
+ # * {Types::DeleteConsoleAuthorizationConfigurationOutput#target_id #target_id} => String
610
+ # * {Types::DeleteConsoleAuthorizationConfigurationOutput#scope #scope} => String
611
+ # * {Types::DeleteConsoleAuthorizationConfigurationOutput#console_authorization_enabled #console_authorization_enabled} => Boolean
612
+ #
613
+ # @example Request syntax with placeholder values
614
+ #
615
+ # resp = client.delete_console_authorization_configuration({
616
+ # target_id: "TargetId",
617
+ # })
618
+ #
619
+ # @example Response structure
620
+ #
621
+ # resp.target_id #=> String
622
+ # resp.scope #=> String
623
+ # resp.console_authorization_enabled #=> Boolean
624
+ #
625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/DeleteConsoleAuthorizationConfiguration AWS API Documentation
626
+ #
627
+ # @overload delete_console_authorization_configuration(params = {})
628
+ # @param [Hash] params ({})
629
+ def delete_console_authorization_configuration(params = {}, options = {})
630
+ req = build_request(:delete_console_authorization_configuration, params)
631
+ req.send_request(options)
632
+ end
633
+
634
+ # Remove a permission statement from the account's SignIn
635
+ # resource-based policy
636
+ #
637
+ # @option params [required, String] :statement_id
638
+ # Unique identifier of the permission statement to delete
639
+ #
640
+ # @option params [String] :client_token
641
+ # Idempotency token for the request
642
+ #
643
+ # **A suitable default value is auto-generated.** You should normally
644
+ # not need to pass this option.**
645
+ #
646
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
647
+ #
648
+ # @example Request syntax with placeholder values
649
+ #
650
+ # resp = client.delete_resource_permission_statement({
651
+ # statement_id: "StatementId", # required
652
+ # client_token: "ClientToken",
653
+ # })
654
+ #
655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/DeleteResourcePermissionStatement AWS API Documentation
656
+ #
657
+ # @overload delete_resource_permission_statement(params = {})
658
+ # @param [Hash] params ({})
659
+ def delete_resource_permission_statement(params = {}, options = {})
660
+ req = build_request(:delete_resource_permission_statement, params)
661
+ req.send_request(options)
662
+ end
663
+
664
+ # Get console authorization configuration with automatic scope detection
665
+ #
666
+ # @option params [String] :target_id
667
+ # Target account identifier
668
+ #
669
+ # @return [Types::GetConsoleAuthorizationConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
670
+ #
671
+ # * {Types::GetConsoleAuthorizationConfigurationOutput#target_id #target_id} => String
672
+ # * {Types::GetConsoleAuthorizationConfigurationOutput#scope #scope} => String
673
+ # * {Types::GetConsoleAuthorizationConfigurationOutput#console_authorization_enabled #console_authorization_enabled} => Boolean
674
+ #
675
+ # @example Request syntax with placeholder values
676
+ #
677
+ # resp = client.get_console_authorization_configuration({
678
+ # target_id: "TargetId",
679
+ # })
680
+ #
681
+ # @example Response structure
682
+ #
683
+ # resp.target_id #=> String
684
+ # resp.scope #=> String
685
+ # resp.console_authorization_enabled #=> Boolean
686
+ #
687
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/GetConsoleAuthorizationConfiguration AWS API Documentation
688
+ #
689
+ # @overload get_console_authorization_configuration(params = {})
690
+ # @param [Hash] params ({})
691
+ def get_console_authorization_configuration(params = {}, options = {})
692
+ req = build_request(:get_console_authorization_configuration, params)
693
+ req.send_request(options)
694
+ end
695
+
696
+ # Retrieve the account's consolidated SignIn resource-based policy
697
+ #
698
+ # @return [Types::GetResourcePolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
699
+ #
700
+ # * {Types::GetResourcePolicyOutput#signin_resource_based_policy #signin_resource_based_policy} => Types::SigninResourceBasedPolicy
701
+ #
702
+ # @example Response structure
703
+ #
704
+ # resp.signin_resource_based_policy.version #=> String
705
+ # resp.signin_resource_based_policy.statement #=> Array
706
+ # resp.signin_resource_based_policy.statement[0].effect #=> String
707
+ # resp.signin_resource_based_policy.statement[0].principal #=> Hash
708
+ # resp.signin_resource_based_policy.statement[0].principal["String"] #=> String
709
+ # resp.signin_resource_based_policy.statement[0].action #=> Array
710
+ # resp.signin_resource_based_policy.statement[0].action[0] #=> String
711
+ # resp.signin_resource_based_policy.statement[0].resource #=> String
712
+ # resp.signin_resource_based_policy.statement[0].condition #=> Hash
713
+ # resp.signin_resource_based_policy.statement[0].condition["ConditionType"] #=> Hash
714
+ # resp.signin_resource_based_policy.statement[0].condition["ConditionType"]["String"] #=> Array
715
+ # resp.signin_resource_based_policy.statement[0].condition["ConditionType"]["String"][0] #=> String
716
+ #
717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/GetResourcePolicy AWS API Documentation
718
+ #
719
+ # @overload get_resource_policy(params = {})
720
+ # @param [Hash] params ({})
721
+ def get_resource_policy(params = {}, options = {})
722
+ req = build_request(:get_resource_policy, params)
723
+ req.send_request(options)
724
+ end
725
+
726
+ # Grants permission to inspect the metadata and state of an OAuth 2.0
727
+ # access token or refresh token
728
+ #
729
+ # Implements RFC 7662 OAuth 2.0 Token Introspection over a
730
+ # SigV4-authenticated endpoint. Inspects the metadata of an
731
+ # access\_token or refresh\_token issued by AWS Sign-In and returns the
732
+ # claims associated with it.
733
+ #
734
+ # Inactive token semantics (RFC 7662 §2.2): when the supplied token is
735
+ # unknown, expired, revoked, malformed, or owned by a different account,
736
+ # the response body is exactly \{ "active": false } with all other
737
+ # claims omitted.
738
+ #
739
+ # @option params [required, String] :token
740
+ # The string value of the token to introspect. May be either an
741
+ # access\_token or a refresh\_token issued by AWS Sign-In.
742
+ #
743
+ # @option params [String] :token_type_hint
744
+ # Optional hint about the type of the token submitted for introspection.
745
+ # The server uses this hint to optimize lookup, but still falls back to
746
+ # the other token type on miss. Allowed values: access\_token,
747
+ # refresh\_token.
748
+ #
749
+ # @return [Types::IntrospectOAuth2TokenWithIAMResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
750
+ #
751
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#active #active} => Boolean
752
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#client_id #client_id} => String
753
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#user_id #user_id} => String
754
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#token_type #token_type} => String
755
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#exp #exp} => Integer
756
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#iat #iat} => Integer
757
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#nbf #nbf} => Integer
758
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#sub #sub} => String
759
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#aud #aud} => String
760
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#iss #iss} => String
761
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#jti #jti} => String
762
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#account_id #account_id} => String
763
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#signin_session #signin_session} => String
764
+ # * {Types::IntrospectOAuth2TokenWithIAMResponse#resource #resource} => String
765
+ #
766
+ # @example Request syntax with placeholder values
767
+ #
768
+ # resp = client.introspect_o_auth_2_token_with_iam({
769
+ # token: "IntrospectionToken", # required
770
+ # token_type_hint: "TokenTypeHint",
771
+ # })
772
+ #
773
+ # @example Response structure
774
+ #
775
+ # resp.active #=> Boolean
776
+ # resp.client_id #=> String
777
+ # resp.user_id #=> String
778
+ # resp.token_type #=> String
779
+ # resp.exp #=> Integer
780
+ # resp.iat #=> Integer
781
+ # resp.nbf #=> Integer
782
+ # resp.sub #=> String
783
+ # resp.aud #=> String
784
+ # resp.iss #=> String
785
+ # resp.jti #=> String
786
+ # resp.account_id #=> String
787
+ # resp.signin_session #=> String
788
+ # resp.resource #=> String
789
+ #
790
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/IntrospectOAuth2TokenWithIAM AWS API Documentation
791
+ #
792
+ # @overload introspect_o_auth_2_token_with_iam(params = {})
793
+ # @param [Hash] params ({})
794
+ def introspect_o_auth_2_token_with_iam(params = {}, options = {})
795
+ req = build_request(:introspect_o_auth_2_token_with_iam, params)
796
+ req.send_request(options)
797
+ end
798
+
799
+ # Retrieve all permission statements in the account's SignIn
800
+ # resource-based policy
801
+ #
802
+ # @option params [Integer] :max_results
803
+ # Maximum number of results to return
804
+ #
805
+ # @option params [String] :next_token
806
+ # Token for pagination
807
+ #
808
+ # @return [Types::ListResourcePermissionStatementsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
809
+ #
810
+ # * {Types::ListResourcePermissionStatementsOutput#permission_statements #permission_statements} => Array&lt;Types::PermissionStatementSummary&gt;
811
+ # * {Types::ListResourcePermissionStatementsOutput#next_token #next_token} => String
812
+ #
813
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
814
+ #
815
+ # @example Request syntax with placeholder values
816
+ #
817
+ # resp = client.list_resource_permission_statements({
818
+ # max_results: 1,
819
+ # next_token: "NextToken",
820
+ # })
821
+ #
822
+ # @example Response structure
823
+ #
824
+ # resp.permission_statements #=> Array
825
+ # resp.permission_statements[0].sid #=> String
826
+ # resp.permission_statements[0].condition #=> Hash
827
+ # resp.permission_statements[0].condition["ConditionType"] #=> Hash
828
+ # resp.permission_statements[0].condition["ConditionType"]["String"] #=> Array
829
+ # resp.permission_statements[0].condition["ConditionType"]["String"][0] #=> String
830
+ # resp.next_token #=> String
831
+ #
832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/ListResourcePermissionStatements AWS API Documentation
833
+ #
834
+ # @overload list_resource_permission_statements(params = {})
835
+ # @param [Hash] params ({})
836
+ def list_resource_permission_statements(params = {}, options = {})
837
+ req = build_request(:list_resource_permission_statements, params)
838
+ req.send_request(options)
839
+ end
840
+
841
+ # Enable console authorization configuration with automatic scope
842
+ # detection
843
+ #
844
+ # @option params [String] :target_id
845
+ # Target account identifier
846
+ #
847
+ # @return [Types::PutConsoleAuthorizationConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
848
+ #
849
+ # * {Types::PutConsoleAuthorizationConfigurationOutput#target_id #target_id} => String
850
+ # * {Types::PutConsoleAuthorizationConfigurationOutput#scope #scope} => String
851
+ # * {Types::PutConsoleAuthorizationConfigurationOutput#console_authorization_enabled #console_authorization_enabled} => Boolean
852
+ #
853
+ # @example Request syntax with placeholder values
854
+ #
855
+ # resp = client.put_console_authorization_configuration({
856
+ # target_id: "TargetId",
857
+ # })
858
+ #
859
+ # @example Response structure
860
+ #
861
+ # resp.target_id #=> String
862
+ # resp.scope #=> String
863
+ # resp.console_authorization_enabled #=> Boolean
864
+ #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/PutConsoleAuthorizationConfiguration AWS API Documentation
866
+ #
867
+ # @overload put_console_authorization_configuration(params = {})
868
+ # @param [Hash] params ({})
869
+ def put_console_authorization_configuration(params = {}, options = {})
870
+ req = build_request(:put_console_authorization_configuration, params)
871
+ req.send_request(options)
872
+ end
873
+
874
+ # Create a permission statement in the account's SignIn resource-based
875
+ # policy
876
+ #
877
+ # @option params [String] :source_vpc
878
+ # VPC identifier to restrict console access
879
+ #
880
+ # @option params [String] :signin_source_vpce
881
+ # SignIn VPC endpoint identifier
882
+ #
883
+ # @option params [String] :console_source_vpce
884
+ # Console VPC endpoint identifier
885
+ #
886
+ # @option params [String] :vpc_source_ip
887
+ # Source IP address within VPC
888
+ #
889
+ # @option params [String] :source_ip
890
+ # Source IP address
891
+ #
892
+ # @option params [String] :requested_region
893
+ # AWS region where the VPC and VPC endpoint reside Required when
894
+ # sourceVpc or signinSourceVpce/consoleSourceVpce is provided
895
+ #
896
+ # @option params [String] :excluded_principal
897
+ # Principal to exclude from the permission statement
898
+ #
899
+ # @option params [String] :client_token
900
+ # Idempotency token for the request
901
+ #
902
+ # **A suitable default value is auto-generated.** You should normally
903
+ # not need to pass this option.**
904
+ #
905
+ # @return [Types::PutResourcePermissionStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
906
+ #
907
+ # * {Types::PutResourcePermissionStatementOutput#statement_id #statement_id} => String
908
+ #
909
+ # @example Request syntax with placeholder values
910
+ #
911
+ # resp = client.put_resource_permission_statement({
912
+ # source_vpc: "SourceVpc",
913
+ # signin_source_vpce: "SourceVpce",
914
+ # console_source_vpce: "SourceVpce",
915
+ # vpc_source_ip: "VpcSourceIp",
916
+ # source_ip: "SourceIp",
917
+ # requested_region: "RequestedRegion",
918
+ # excluded_principal: "ExcludedPrincipal",
919
+ # client_token: "ClientToken",
920
+ # })
921
+ #
922
+ # @example Response structure
923
+ #
924
+ # resp.statement_id #=> String
925
+ #
926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/PutResourcePermissionStatement AWS API Documentation
927
+ #
928
+ # @overload put_resource_permission_statement(params = {})
929
+ # @param [Hash] params ({})
930
+ def put_resource_permission_statement(params = {}, options = {})
931
+ req = build_request(:put_resource_permission_statement, params)
932
+ req.send_request(options)
933
+ end
934
+
935
+ # Grants permission to revoke an OAuth 2.0 refresh token and its
936
+ # associated refresh tokens
937
+ #
938
+ # Revokes a refresh\_token issued by AWS Sign-In, invalidating the
939
+ # entire token chain so that the refresh\_token can no longer be used to
940
+ # mint new access\_tokens.
941
+ #
942
+ # Idempotency: revoking an already-revoked, expired, or otherwise
943
+ # invalid token still returns 200 OK with an empty body. Only the
944
+ # refresh\_token type is accepted.
945
+ #
946
+ # @option params [required, String] :token
947
+ # The refresh\_token to revoke. Must be a refresh\_token issued by AWS
948
+ # Sign-In (prefix "ASOR"); access\_tokens are not accepted for
949
+ # revocation.
950
+ #
951
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
952
+ #
953
+ # @example Request syntax with placeholder values
954
+ #
955
+ # resp = client.revoke_o_auth_2_token_with_iam({
956
+ # token: "RevocationToken", # required
957
+ # })
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/signin-2023-01-01/RevokeOAuth2TokenWithIAM AWS API Documentation
960
+ #
961
+ # @overload revoke_o_auth_2_token_with_iam(params = {})
962
+ # @param [Hash] params ({})
963
+ def revoke_o_auth_2_token_with_iam(params = {}, options = {})
964
+ req = build_request(:revoke_o_auth_2_token_with_iam, params)
965
+ req.send_request(options)
966
+ end
967
+
968
+ # @!endgroup
969
+
970
+ # @param params ({})
971
+ # @api private
972
+ def build_request(operation_name, params = {})
973
+ handlers = @handlers.for(operation_name)
974
+ tracer = config.telemetry_provider.tracer_provider.tracer(
975
+ Aws::Telemetry.module_to_tracer_name('Aws::Signin')
976
+ )
977
+ context = Seahorse::Client::RequestContext.new(
978
+ operation_name: operation_name,
979
+ operation: config.api.operation(operation_name),
980
+ client: self,
981
+ params: params,
982
+ config: config,
983
+ tracer: tracer
984
+ )
985
+ context[:gem_name] = 'aws-sdk-core'
986
+ context[:gem_version] = '3.254.1'
987
+ Seahorse::Client::Request.new(handlers, context)
988
+ end
989
+
990
+ # @api private
991
+ # @deprecated
992
+ def waiter_names
993
+ []
994
+ end
995
+
996
+ class << self
997
+
998
+ # @api private
999
+ attr_reader :identifier
1000
+
1001
+ # @api private
1002
+ def errors_module
1003
+ Errors
1004
+ end
1005
+
1006
+ end
1007
+ end
1008
+ end