aws-sdk-core 3.117.0 → 3.197.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +836 -0
  3. data/VERSION +1 -1
  4. data/lib/aws-defaults/default_configuration.rb +153 -0
  5. data/lib/aws-defaults/defaults_mode_config_resolver.rb +107 -0
  6. data/lib/aws-defaults.rb +3 -0
  7. data/lib/aws-sdk-core/arn.rb +13 -0
  8. data/lib/aws-sdk-core/assume_role_credentials.rb +21 -7
  9. data/lib/aws-sdk-core/assume_role_web_identity_credentials.rb +14 -10
  10. data/lib/aws-sdk-core/binary/decode_handler.rb +0 -5
  11. data/lib/aws-sdk-core/binary/encode_handler.rb +12 -1
  12. data/lib/aws-sdk-core/binary/event_builder.rb +34 -37
  13. data/lib/aws-sdk-core/client_stubs.rb +20 -13
  14. data/lib/aws-sdk-core/credential_provider.rb +4 -1
  15. data/lib/aws-sdk-core/credential_provider_chain.rb +8 -5
  16. data/lib/aws-sdk-core/ec2_metadata.rb +4 -3
  17. data/lib/aws-sdk-core/ecs_credentials.rb +187 -52
  18. data/lib/aws-sdk-core/endpoints/condition.rb +41 -0
  19. data/lib/aws-sdk-core/endpoints/endpoint.rb +17 -0
  20. data/lib/aws-sdk-core/endpoints/endpoint_rule.rb +75 -0
  21. data/lib/aws-sdk-core/endpoints/error_rule.rb +42 -0
  22. data/lib/aws-sdk-core/endpoints/function.rb +80 -0
  23. data/lib/aws-sdk-core/endpoints/matchers.rb +135 -0
  24. data/lib/aws-sdk-core/endpoints/reference.rb +31 -0
  25. data/lib/aws-sdk-core/endpoints/rule.rb +25 -0
  26. data/lib/aws-sdk-core/endpoints/rule_set.rb +52 -0
  27. data/lib/aws-sdk-core/endpoints/rules_provider.rb +37 -0
  28. data/lib/aws-sdk-core/endpoints/templater.rb +58 -0
  29. data/lib/aws-sdk-core/endpoints/tree_rule.rb +45 -0
  30. data/lib/aws-sdk-core/endpoints/url.rb +60 -0
  31. data/lib/aws-sdk-core/endpoints.rb +78 -0
  32. data/lib/aws-sdk-core/errors.rb +17 -4
  33. data/lib/aws-sdk-core/event_emitter.rb +0 -16
  34. data/lib/aws-sdk-core/ini_parser.rb +7 -0
  35. data/lib/aws-sdk-core/instance_profile_credentials.rb +127 -33
  36. data/lib/aws-sdk-core/json/builder.rb +8 -1
  37. data/lib/aws-sdk-core/json/error_handler.rb +30 -4
  38. data/lib/aws-sdk-core/json/handler.rb +8 -1
  39. data/lib/aws-sdk-core/json/json_engine.rb +10 -8
  40. data/lib/aws-sdk-core/json/oj_engine.rb +33 -6
  41. data/lib/aws-sdk-core/json/parser.rb +38 -2
  42. data/lib/aws-sdk-core/json.rb +8 -26
  43. data/lib/aws-sdk-core/log/formatter.rb +6 -0
  44. data/lib/aws-sdk-core/log/param_filter.rb +9 -1
  45. data/lib/aws-sdk-core/lru_cache.rb +75 -0
  46. data/lib/aws-sdk-core/pageable_response.rb +81 -32
  47. data/lib/aws-sdk-core/param_validator.rb +36 -2
  48. data/lib/aws-sdk-core/plugins/bearer_authorization.rb +67 -0
  49. data/lib/aws-sdk-core/plugins/checksum_algorithm.rb +342 -0
  50. data/lib/aws-sdk-core/plugins/client_metrics_plugin.rb +1 -0
  51. data/lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb +14 -2
  52. data/lib/aws-sdk-core/plugins/credentials_configuration.rb +29 -1
  53. data/lib/aws-sdk-core/plugins/defaults_mode.rb +40 -0
  54. data/lib/aws-sdk-core/plugins/endpoint_discovery.rb +6 -2
  55. data/lib/aws-sdk-core/plugins/http_checksum.rb +9 -1
  56. data/lib/aws-sdk-core/plugins/invocation_id.rb +1 -11
  57. data/lib/aws-sdk-core/plugins/jsonvalue_converter.rb +34 -6
  58. data/lib/aws-sdk-core/plugins/logging.rb +2 -0
  59. data/lib/aws-sdk-core/plugins/protocols/api_gateway.rb +17 -0
  60. data/lib/aws-sdk-core/plugins/protocols/rest_json.rb +4 -2
  61. data/lib/aws-sdk-core/plugins/protocols/rest_xml.rb +1 -2
  62. data/lib/aws-sdk-core/plugins/recursion_detection.rb +38 -0
  63. data/lib/aws-sdk-core/plugins/regional_endpoint.rb +144 -17
  64. data/lib/aws-sdk-core/plugins/request_compression.rb +226 -0
  65. data/lib/aws-sdk-core/plugins/response_paging.rb +1 -1
  66. data/lib/aws-sdk-core/plugins/retries/error_inspector.rb +7 -4
  67. data/lib/aws-sdk-core/plugins/retry_errors.rb +33 -7
  68. data/lib/aws-sdk-core/plugins/sign.rb +211 -0
  69. data/lib/aws-sdk-core/plugins/signature_v2.rb +1 -0
  70. data/lib/aws-sdk-core/plugins/signature_v4.rb +28 -31
  71. data/lib/aws-sdk-core/plugins/stub_responses.rb +6 -1
  72. data/lib/aws-sdk-core/plugins/user_agent.rb +152 -14
  73. data/lib/aws-sdk-core/process_credentials.rb +50 -34
  74. data/lib/aws-sdk-core/query/ec2_param_builder.rb +5 -7
  75. data/lib/aws-sdk-core/query/param_builder.rb +2 -2
  76. data/lib/aws-sdk-core/refreshing_credentials.rb +49 -18
  77. data/lib/aws-sdk-core/refreshing_token.rb +71 -0
  78. data/lib/aws-sdk-core/rest/handler.rb +1 -1
  79. data/lib/aws-sdk-core/rest/request/body.rb +49 -4
  80. data/lib/aws-sdk-core/rest/request/content_type.rb +60 -0
  81. data/lib/aws-sdk-core/rest/request/endpoint.rb +24 -4
  82. data/lib/aws-sdk-core/rest/request/headers.rb +23 -7
  83. data/lib/aws-sdk-core/rest/request/querystring_builder.rb +62 -36
  84. data/lib/aws-sdk-core/rest/response/body.rb +15 -1
  85. data/lib/aws-sdk-core/rest/response/header_list_parser.rb +79 -0
  86. data/lib/aws-sdk-core/rest/response/headers.rb +10 -3
  87. data/lib/aws-sdk-core/rest.rb +1 -0
  88. data/lib/aws-sdk-core/shared_config.rb +112 -12
  89. data/lib/aws-sdk-core/sso_credentials.rb +92 -51
  90. data/lib/aws-sdk-core/sso_token_provider.rb +135 -0
  91. data/lib/aws-sdk-core/static_token_provider.rb +14 -0
  92. data/lib/aws-sdk-core/structure.rb +16 -5
  93. data/lib/aws-sdk-core/stubbing/stub_data.rb +11 -0
  94. data/lib/aws-sdk-core/token.rb +31 -0
  95. data/lib/aws-sdk-core/token_provider.rb +15 -0
  96. data/lib/aws-sdk-core/token_provider_chain.rb +51 -0
  97. data/lib/aws-sdk-core/util.rb +39 -0
  98. data/lib/aws-sdk-core/waiters/poller.rb +4 -2
  99. data/lib/aws-sdk-core/xml/builder.rb +17 -9
  100. data/lib/aws-sdk-core/xml/error_handler.rb +31 -8
  101. data/lib/aws-sdk-core/xml/parser/engines/oga.rb +2 -0
  102. data/lib/aws-sdk-core/xml/parser/engines/ox.rb +1 -1
  103. data/lib/aws-sdk-core/xml/parser/engines/rexml.rb +0 -8
  104. data/lib/aws-sdk-core/xml/parser/frame.rb +27 -20
  105. data/lib/aws-sdk-core/xml/parser/stack.rb +2 -0
  106. data/lib/aws-sdk-core.rb +21 -0
  107. data/lib/aws-sdk-sso/client.rb +157 -50
  108. data/lib/aws-sdk-sso/endpoint_parameters.rb +66 -0
  109. data/lib/aws-sdk-sso/endpoint_provider.rb +57 -0
  110. data/lib/aws-sdk-sso/endpoints.rb +72 -0
  111. data/lib/aws-sdk-sso/plugins/endpoints.rb +78 -0
  112. data/lib/aws-sdk-sso/types.rb +8 -43
  113. data/lib/aws-sdk-sso.rb +5 -1
  114. data/lib/aws-sdk-ssooidc/client.rb +1008 -0
  115. data/lib/aws-sdk-ssooidc/client_api.rb +293 -0
  116. data/lib/aws-sdk-ssooidc/customizations.rb +1 -0
  117. data/lib/aws-sdk-ssooidc/endpoint_parameters.rb +66 -0
  118. data/lib/aws-sdk-ssooidc/endpoint_provider.rb +57 -0
  119. data/lib/aws-sdk-ssooidc/endpoints.rb +72 -0
  120. data/lib/aws-sdk-ssooidc/errors.rb +342 -0
  121. data/lib/aws-sdk-ssooidc/plugins/endpoints.rb +78 -0
  122. data/lib/aws-sdk-ssooidc/resource.rb +26 -0
  123. data/lib/aws-sdk-ssooidc/types.rb +823 -0
  124. data/lib/aws-sdk-ssooidc.rb +59 -0
  125. data/lib/aws-sdk-sts/client.rb +472 -398
  126. data/lib/aws-sdk-sts/client_api.rb +20 -9
  127. data/lib/aws-sdk-sts/endpoint_parameters.rb +78 -0
  128. data/lib/aws-sdk-sts/endpoint_provider.rb +112 -0
  129. data/lib/aws-sdk-sts/endpoints.rb +136 -0
  130. data/lib/aws-sdk-sts/plugins/endpoints.rb +86 -0
  131. data/lib/aws-sdk-sts/plugins/sts_regional_endpoints.rb +5 -1
  132. data/lib/aws-sdk-sts/presigner.rb +14 -10
  133. data/lib/aws-sdk-sts/types.rb +168 -227
  134. data/lib/aws-sdk-sts.rb +5 -1
  135. data/lib/seahorse/client/async_base.rb +1 -2
  136. data/lib/seahorse/client/async_response.rb +19 -0
  137. data/lib/seahorse/client/base.rb +1 -0
  138. data/lib/seahorse/client/configuration.rb +5 -5
  139. data/lib/seahorse/client/h2/connection.rb +15 -16
  140. data/lib/seahorse/client/h2/handler.rb +5 -5
  141. data/lib/seahorse/client/net_http/connection_pool.rb +10 -9
  142. data/lib/seahorse/client/net_http/handler.rb +15 -7
  143. data/lib/seahorse/client/net_http/patches.rb +12 -86
  144. data/lib/seahorse/client/plugin.rb +9 -0
  145. data/lib/seahorse/client/plugins/content_length.rb +11 -5
  146. data/lib/seahorse/client/plugins/h2.rb +3 -3
  147. data/lib/seahorse/client/plugins/net_http.rb +73 -10
  148. data/lib/seahorse/client/plugins/request_callback.rb +40 -9
  149. data/lib/seahorse/client/response.rb +6 -0
  150. data/lib/seahorse/model/operation.rb +6 -0
  151. data/lib/seahorse/model/shapes.rb +27 -2
  152. data/lib/seahorse/util.rb +4 -0
  153. data/sig/aws-sdk-core/client_stubs.rbs +10 -0
  154. data/sig/aws-sdk-core/errors.rbs +22 -0
  155. data/sig/aws-sdk-core/resources/collection.rbs +21 -0
  156. data/sig/aws-sdk-core/structure.rbs +4 -0
  157. data/sig/aws-sdk-core/waiters/errors.rbs +20 -0
  158. data/sig/aws-sdk-core.rbs +7 -0
  159. data/sig/seahorse/client/base.rbs +25 -0
  160. data/sig/seahorse/client/handler_builder.rbs +16 -0
  161. data/sig/seahorse/client/response.rbs +61 -0
  162. metadata +82 -17
  163. data/lib/aws-sdk-sso/plugins/content_type.rb +0 -25
@@ -0,0 +1,823 @@
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
+ module Aws::SSOOIDC
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] error
16
+ # Single error code. For this exception the value will be
17
+ # `access_denied`.
18
+ # @return [String]
19
+ #
20
+ # @!attribute [rw] error_description
21
+ # Human-readable text providing additional information, used to assist
22
+ # the client developer in understanding the error that occurred.
23
+ # @return [String]
24
+ #
25
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/AccessDeniedException AWS API Documentation
26
+ #
27
+ class AccessDeniedException < Struct.new(
28
+ :error,
29
+ :error_description)
30
+ SENSITIVE = []
31
+ include Aws::Structure
32
+ end
33
+
34
+ # Indicates that a request to authorize a client with an access user
35
+ # session token is pending.
36
+ #
37
+ # @!attribute [rw] error
38
+ # Single error code. For this exception the value will be
39
+ # `authorization_pending`.
40
+ # @return [String]
41
+ #
42
+ # @!attribute [rw] error_description
43
+ # Human-readable text providing additional information, used to assist
44
+ # the client developer in understanding the error that occurred.
45
+ # @return [String]
46
+ #
47
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/AuthorizationPendingException AWS API Documentation
48
+ #
49
+ class AuthorizationPendingException < Struct.new(
50
+ :error,
51
+ :error_description)
52
+ SENSITIVE = []
53
+ include Aws::Structure
54
+ end
55
+
56
+ # @!attribute [rw] client_id
57
+ # The unique identifier string for the client or application. This
58
+ # value comes from the result of the RegisterClient API.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] client_secret
62
+ # A secret string generated for the client. This value should come
63
+ # from the persisted result of the RegisterClient API.
64
+ # @return [String]
65
+ #
66
+ # @!attribute [rw] grant_type
67
+ # Supports the following OAuth grant types: Device Code and Refresh
68
+ # Token. Specify either of the following values, depending on the
69
+ # grant type that you want:
70
+ #
71
+ # * Device Code - `urn:ietf:params:oauth:grant-type:device_code`
72
+ #
73
+ # * Refresh Token - `refresh_token`
74
+ #
75
+ # For information about how to obtain the device code, see the
76
+ # StartDeviceAuthorization topic.
77
+ # @return [String]
78
+ #
79
+ # @!attribute [rw] device_code
80
+ # Used only when calling this API for the Device Code grant type. This
81
+ # short-term code is used to identify this authorization request. This
82
+ # comes from the result of the StartDeviceAuthorization API.
83
+ # @return [String]
84
+ #
85
+ # @!attribute [rw] code
86
+ # Used only when calling this API for the Authorization Code grant
87
+ # type. The short-term code is used to identify this authorization
88
+ # request. This grant type is currently unsupported for the
89
+ # CreateToken API.
90
+ # @return [String]
91
+ #
92
+ # @!attribute [rw] refresh_token
93
+ # Used only when calling this API for the Refresh Token grant type.
94
+ # This token is used to refresh short-term tokens, such as the access
95
+ # token, that might expire.
96
+ #
97
+ # For more information about the features and limitations of the
98
+ # current IAM Identity Center OIDC implementation, see *Considerations
99
+ # for Using this Guide* in the [IAM Identity Center OIDC API
100
+ # Reference][1].
101
+ #
102
+ #
103
+ #
104
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html
105
+ # @return [String]
106
+ #
107
+ # @!attribute [rw] scope
108
+ # The list of scopes for which authorization is requested. The access
109
+ # token that is issued is limited to the scopes that are granted. If
110
+ # this value is not specified, IAM Identity Center authorizes all
111
+ # scopes that are configured for the client during the call to
112
+ # RegisterClient.
113
+ # @return [Array<String>]
114
+ #
115
+ # @!attribute [rw] redirect_uri
116
+ # Used only when calling this API for the Authorization Code grant
117
+ # type. This value specifies the location of the client or application
118
+ # that has registered to receive the authorization code.
119
+ # @return [String]
120
+ #
121
+ # @!attribute [rw] code_verifier
122
+ # Used only when calling this API for the Authorization Code grant
123
+ # type. This value is generated by the client and presented to
124
+ # validate the original code challenge value the client passed at
125
+ # authorization time.
126
+ # @return [String]
127
+ #
128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenRequest AWS API Documentation
129
+ #
130
+ class CreateTokenRequest < Struct.new(
131
+ :client_id,
132
+ :client_secret,
133
+ :grant_type,
134
+ :device_code,
135
+ :code,
136
+ :refresh_token,
137
+ :scope,
138
+ :redirect_uri,
139
+ :code_verifier)
140
+ SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
141
+ include Aws::Structure
142
+ end
143
+
144
+ # @!attribute [rw] access_token
145
+ # A bearer token to access Amazon Web Services accounts and
146
+ # applications assigned to a user.
147
+ # @return [String]
148
+ #
149
+ # @!attribute [rw] token_type
150
+ # Used to notify the client that the returned token is an access
151
+ # token. The supported token type is `Bearer`.
152
+ # @return [String]
153
+ #
154
+ # @!attribute [rw] expires_in
155
+ # Indicates the time in seconds when an access token will expire.
156
+ # @return [Integer]
157
+ #
158
+ # @!attribute [rw] refresh_token
159
+ # A token that, if present, can be used to refresh a previously issued
160
+ # access token that might have expired.
161
+ #
162
+ # For more information about the features and limitations of the
163
+ # current IAM Identity Center OIDC implementation, see *Considerations
164
+ # for Using this Guide* in the [IAM Identity Center OIDC API
165
+ # Reference][1].
166
+ #
167
+ #
168
+ #
169
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html
170
+ # @return [String]
171
+ #
172
+ # @!attribute [rw] id_token
173
+ # The `idToken` is not implemented or supported. For more information
174
+ # about the features and limitations of the current IAM Identity
175
+ # Center OIDC implementation, see *Considerations for Using this
176
+ # Guide* in the [IAM Identity Center OIDC API Reference][1].
177
+ #
178
+ # A JSON Web Token (JWT) that identifies who is associated with the
179
+ # issued access token.
180
+ #
181
+ #
182
+ #
183
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html
184
+ # @return [String]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenResponse AWS API Documentation
187
+ #
188
+ class CreateTokenResponse < Struct.new(
189
+ :access_token,
190
+ :token_type,
191
+ :expires_in,
192
+ :refresh_token,
193
+ :id_token)
194
+ SENSITIVE = [:access_token, :refresh_token, :id_token]
195
+ include Aws::Structure
196
+ end
197
+
198
+ # @!attribute [rw] client_id
199
+ # The unique identifier string for the client or application. This
200
+ # value is an application ARN that has OAuth grants configured.
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] grant_type
204
+ # Supports the following OAuth grant types: Authorization Code,
205
+ # Refresh Token, JWT Bearer, and Token Exchange. Specify one of the
206
+ # following values, depending on the grant type that you want:
207
+ #
208
+ # * Authorization Code - `authorization_code`
209
+ #
210
+ # * Refresh Token - `refresh_token`
211
+ #
212
+ # * JWT Bearer - `urn:ietf:params:oauth:grant-type:jwt-bearer`
213
+ #
214
+ # * Token Exchange -
215
+ # `urn:ietf:params:oauth:grant-type:token-exchange`
216
+ # @return [String]
217
+ #
218
+ # @!attribute [rw] code
219
+ # Used only when calling this API for the Authorization Code grant
220
+ # type. This short-term code is used to identify this authorization
221
+ # request. The code is obtained through a redirect from IAM Identity
222
+ # Center to a redirect URI persisted in the Authorization Code
223
+ # GrantOptions for the application.
224
+ # @return [String]
225
+ #
226
+ # @!attribute [rw] refresh_token
227
+ # Used only when calling this API for the Refresh Token grant type.
228
+ # This token is used to refresh short-term tokens, such as the access
229
+ # token, that might expire.
230
+ #
231
+ # For more information about the features and limitations of the
232
+ # current IAM Identity Center OIDC implementation, see *Considerations
233
+ # for Using this Guide* in the [IAM Identity Center OIDC API
234
+ # Reference][1].
235
+ #
236
+ #
237
+ #
238
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html
239
+ # @return [String]
240
+ #
241
+ # @!attribute [rw] assertion
242
+ # Used only when calling this API for the JWT Bearer grant type. This
243
+ # value specifies the JSON Web Token (JWT) issued by a trusted token
244
+ # issuer. To authorize a trusted token issuer, configure the JWT
245
+ # Bearer GrantOptions for the application.
246
+ # @return [String]
247
+ #
248
+ # @!attribute [rw] scope
249
+ # The list of scopes for which authorization is requested. The access
250
+ # token that is issued is limited to the scopes that are granted. If
251
+ # the value is not specified, IAM Identity Center authorizes all
252
+ # scopes configured for the application, including the following
253
+ # default scopes: `openid`, `aws`, `sts:identity_context`.
254
+ # @return [Array<String>]
255
+ #
256
+ # @!attribute [rw] redirect_uri
257
+ # Used only when calling this API for the Authorization Code grant
258
+ # type. This value specifies the location of the client or application
259
+ # that has registered to receive the authorization code.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] subject_token
263
+ # Used only when calling this API for the Token Exchange grant type.
264
+ # This value specifies the subject of the exchange. The value of the
265
+ # subject token must be an access token issued by IAM Identity Center
266
+ # to a different client or application. The access token must have
267
+ # authorized scopes that indicate the requested application as a
268
+ # target audience.
269
+ # @return [String]
270
+ #
271
+ # @!attribute [rw] subject_token_type
272
+ # Used only when calling this API for the Token Exchange grant type.
273
+ # This value specifies the type of token that is passed as the subject
274
+ # of the exchange. The following value is supported:
275
+ #
276
+ # * Access Token - `urn:ietf:params:oauth:token-type:access_token`
277
+ # @return [String]
278
+ #
279
+ # @!attribute [rw] requested_token_type
280
+ # Used only when calling this API for the Token Exchange grant type.
281
+ # This value specifies the type of token that the requester can
282
+ # receive. The following values are supported:
283
+ #
284
+ # * Access Token - `urn:ietf:params:oauth:token-type:access_token`
285
+ #
286
+ # * Refresh Token - `urn:ietf:params:oauth:token-type:refresh_token`
287
+ # @return [String]
288
+ #
289
+ # @!attribute [rw] code_verifier
290
+ # Used only when calling this API for the Authorization Code grant
291
+ # type. This value is generated by the client and presented to
292
+ # validate the original code challenge value the client passed at
293
+ # authorization time.
294
+ # @return [String]
295
+ #
296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenWithIAMRequest AWS API Documentation
297
+ #
298
+ class CreateTokenWithIAMRequest < Struct.new(
299
+ :client_id,
300
+ :grant_type,
301
+ :code,
302
+ :refresh_token,
303
+ :assertion,
304
+ :scope,
305
+ :redirect_uri,
306
+ :subject_token,
307
+ :subject_token_type,
308
+ :requested_token_type,
309
+ :code_verifier)
310
+ SENSITIVE = [:refresh_token, :assertion, :subject_token, :code_verifier]
311
+ include Aws::Structure
312
+ end
313
+
314
+ # @!attribute [rw] access_token
315
+ # A bearer token to access Amazon Web Services accounts and
316
+ # applications assigned to a user.
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] token_type
320
+ # Used to notify the requester that the returned token is an access
321
+ # token. The supported token type is `Bearer`.
322
+ # @return [String]
323
+ #
324
+ # @!attribute [rw] expires_in
325
+ # Indicates the time in seconds when an access token will expire.
326
+ # @return [Integer]
327
+ #
328
+ # @!attribute [rw] refresh_token
329
+ # A token that, if present, can be used to refresh a previously issued
330
+ # access token that might have expired.
331
+ #
332
+ # For more information about the features and limitations of the
333
+ # current IAM Identity Center OIDC implementation, see *Considerations
334
+ # for Using this Guide* in the [IAM Identity Center OIDC API
335
+ # Reference][1].
336
+ #
337
+ #
338
+ #
339
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html
340
+ # @return [String]
341
+ #
342
+ # @!attribute [rw] id_token
343
+ # A JSON Web Token (JWT) that identifies the user associated with the
344
+ # issued access token.
345
+ # @return [String]
346
+ #
347
+ # @!attribute [rw] issued_token_type
348
+ # Indicates the type of tokens that are issued by IAM Identity Center.
349
+ # The following values are supported:
350
+ #
351
+ # * Access Token - `urn:ietf:params:oauth:token-type:access_token`
352
+ #
353
+ # * Refresh Token - `urn:ietf:params:oauth:token-type:refresh_token`
354
+ # @return [String]
355
+ #
356
+ # @!attribute [rw] scope
357
+ # The list of scopes for which authorization is granted. The access
358
+ # token that is issued is limited to the scopes that are granted.
359
+ # @return [Array<String>]
360
+ #
361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenWithIAMResponse AWS API Documentation
362
+ #
363
+ class CreateTokenWithIAMResponse < Struct.new(
364
+ :access_token,
365
+ :token_type,
366
+ :expires_in,
367
+ :refresh_token,
368
+ :id_token,
369
+ :issued_token_type,
370
+ :scope)
371
+ SENSITIVE = [:access_token, :refresh_token, :id_token]
372
+ include Aws::Structure
373
+ end
374
+
375
+ # Indicates that the token issued by the service is expired and is no
376
+ # longer valid.
377
+ #
378
+ # @!attribute [rw] error
379
+ # Single error code. For this exception the value will be
380
+ # `expired_token`.
381
+ # @return [String]
382
+ #
383
+ # @!attribute [rw] error_description
384
+ # Human-readable text providing additional information, used to assist
385
+ # the client developer in understanding the error that occurred.
386
+ # @return [String]
387
+ #
388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/ExpiredTokenException AWS API Documentation
389
+ #
390
+ class ExpiredTokenException < Struct.new(
391
+ :error,
392
+ :error_description)
393
+ SENSITIVE = []
394
+ include Aws::Structure
395
+ end
396
+
397
+ # Indicates that an error from the service occurred while trying to
398
+ # process a request.
399
+ #
400
+ # @!attribute [rw] error
401
+ # Single error code. For this exception the value will be
402
+ # `server_error`.
403
+ # @return [String]
404
+ #
405
+ # @!attribute [rw] error_description
406
+ # Human-readable text providing additional information, used to assist
407
+ # the client developer in understanding the error that occurred.
408
+ # @return [String]
409
+ #
410
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InternalServerException AWS API Documentation
411
+ #
412
+ class InternalServerException < Struct.new(
413
+ :error,
414
+ :error_description)
415
+ SENSITIVE = []
416
+ include Aws::Structure
417
+ end
418
+
419
+ # Indicates that the `clientId` or `clientSecret` in the request is
420
+ # invalid. For example, this can occur when a client sends an incorrect
421
+ # `clientId` or an expired `clientSecret`.
422
+ #
423
+ # @!attribute [rw] error
424
+ # Single error code. For this exception the value will be
425
+ # `invalid_client`.
426
+ # @return [String]
427
+ #
428
+ # @!attribute [rw] error_description
429
+ # Human-readable text providing additional information, used to assist
430
+ # the client developer in understanding the error that occurred.
431
+ # @return [String]
432
+ #
433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidClientException AWS API Documentation
434
+ #
435
+ class InvalidClientException < Struct.new(
436
+ :error,
437
+ :error_description)
438
+ SENSITIVE = []
439
+ include Aws::Structure
440
+ end
441
+
442
+ # Indicates that the client information sent in the request during
443
+ # registration is invalid.
444
+ #
445
+ # @!attribute [rw] error
446
+ # Single error code. For this exception the value will be
447
+ # `invalid_client_metadata`.
448
+ # @return [String]
449
+ #
450
+ # @!attribute [rw] error_description
451
+ # Human-readable text providing additional information, used to assist
452
+ # the client developer in understanding the error that occurred.
453
+ # @return [String]
454
+ #
455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidClientMetadataException AWS API Documentation
456
+ #
457
+ class InvalidClientMetadataException < Struct.new(
458
+ :error,
459
+ :error_description)
460
+ SENSITIVE = []
461
+ include Aws::Structure
462
+ end
463
+
464
+ # Indicates that a request contains an invalid grant. This can occur if
465
+ # a client makes a CreateToken request with an invalid grant type.
466
+ #
467
+ # @!attribute [rw] error
468
+ # Single error code. For this exception the value will be
469
+ # `invalid_grant`.
470
+ # @return [String]
471
+ #
472
+ # @!attribute [rw] error_description
473
+ # Human-readable text providing additional information, used to assist
474
+ # the client developer in understanding the error that occurred.
475
+ # @return [String]
476
+ #
477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidGrantException AWS API Documentation
478
+ #
479
+ class InvalidGrantException < Struct.new(
480
+ :error,
481
+ :error_description)
482
+ SENSITIVE = []
483
+ include Aws::Structure
484
+ end
485
+
486
+ # Indicates that one or more redirect URI in the request is not
487
+ # supported for this operation.
488
+ #
489
+ # @!attribute [rw] error
490
+ # Single error code. For this exception the value will be
491
+ # `invalid_redirect_uri`.
492
+ # @return [String]
493
+ #
494
+ # @!attribute [rw] error_description
495
+ # Human-readable text providing additional information, used to assist
496
+ # the client developer in understanding the error that occurred.
497
+ # @return [String]
498
+ #
499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidRedirectUriException AWS API Documentation
500
+ #
501
+ class InvalidRedirectUriException < Struct.new(
502
+ :error,
503
+ :error_description)
504
+ SENSITIVE = []
505
+ include Aws::Structure
506
+ end
507
+
508
+ # Indicates that something is wrong with the input to the request. For
509
+ # example, a required parameter might be missing or out of range.
510
+ #
511
+ # @!attribute [rw] error
512
+ # Single error code. For this exception the value will be
513
+ # `invalid_request`.
514
+ # @return [String]
515
+ #
516
+ # @!attribute [rw] error_description
517
+ # Human-readable text providing additional information, used to assist
518
+ # the client developer in understanding the error that occurred.
519
+ # @return [String]
520
+ #
521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidRequestException AWS API Documentation
522
+ #
523
+ class InvalidRequestException < Struct.new(
524
+ :error,
525
+ :error_description)
526
+ SENSITIVE = []
527
+ include Aws::Structure
528
+ end
529
+
530
+ # Indicates that a token provided as input to the request was issued by
531
+ # and is only usable by calling IAM Identity Center endpoints in another
532
+ # region.
533
+ #
534
+ # @!attribute [rw] error
535
+ # Single error code. For this exception the value will be
536
+ # `invalid_request`.
537
+ # @return [String]
538
+ #
539
+ # @!attribute [rw] error_description
540
+ # Human-readable text providing additional information, used to assist
541
+ # the client developer in understanding the error that occurred.
542
+ # @return [String]
543
+ #
544
+ # @!attribute [rw] endpoint
545
+ # Indicates the IAM Identity Center endpoint which the requester may
546
+ # call with this token.
547
+ # @return [String]
548
+ #
549
+ # @!attribute [rw] region
550
+ # Indicates the region which the requester may call with this token.
551
+ # @return [String]
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidRequestRegionException AWS API Documentation
554
+ #
555
+ class InvalidRequestRegionException < Struct.new(
556
+ :error,
557
+ :error_description,
558
+ :endpoint,
559
+ :region)
560
+ SENSITIVE = []
561
+ include Aws::Structure
562
+ end
563
+
564
+ # Indicates that the scope provided in the request is invalid.
565
+ #
566
+ # @!attribute [rw] error
567
+ # Single error code. For this exception the value will be
568
+ # `invalid_scope`.
569
+ # @return [String]
570
+ #
571
+ # @!attribute [rw] error_description
572
+ # Human-readable text providing additional information, used to assist
573
+ # the client developer in understanding the error that occurred.
574
+ # @return [String]
575
+ #
576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidScopeException AWS API Documentation
577
+ #
578
+ class InvalidScopeException < Struct.new(
579
+ :error,
580
+ :error_description)
581
+ SENSITIVE = []
582
+ include Aws::Structure
583
+ end
584
+
585
+ # @!attribute [rw] client_name
586
+ # The friendly name of the client.
587
+ # @return [String]
588
+ #
589
+ # @!attribute [rw] client_type
590
+ # The type of client. The service supports only `public` as a client
591
+ # type. Anything other than public will be rejected by the service.
592
+ # @return [String]
593
+ #
594
+ # @!attribute [rw] scopes
595
+ # The list of scopes that are defined by the client. Upon
596
+ # authorization, this list is used to restrict permissions when
597
+ # granting an access token.
598
+ # @return [Array<String>]
599
+ #
600
+ # @!attribute [rw] redirect_uris
601
+ # The list of redirect URI that are defined by the client. At
602
+ # completion of authorization, this list is used to restrict what
603
+ # locations the user agent can be redirected back to.
604
+ # @return [Array<String>]
605
+ #
606
+ # @!attribute [rw] grant_types
607
+ # The list of OAuth 2.0 grant types that are defined by the client.
608
+ # This list is used to restrict the token granting flows available to
609
+ # the client.
610
+ # @return [Array<String>]
611
+ #
612
+ # @!attribute [rw] issuer_url
613
+ # The IAM Identity Center Issuer URL associated with an instance of
614
+ # IAM Identity Center. This value is needed for user access to
615
+ # resources through the client.
616
+ # @return [String]
617
+ #
618
+ # @!attribute [rw] entitled_application_arn
619
+ # This IAM Identity Center application ARN is used to define
620
+ # administrator-managed configuration for public client access to
621
+ # resources. At authorization, the scopes, grants, and redirect URI
622
+ # available to this client will be restricted by this application
623
+ # resource.
624
+ # @return [String]
625
+ #
626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClientRequest AWS API Documentation
627
+ #
628
+ class RegisterClientRequest < Struct.new(
629
+ :client_name,
630
+ :client_type,
631
+ :scopes,
632
+ :redirect_uris,
633
+ :grant_types,
634
+ :issuer_url,
635
+ :entitled_application_arn)
636
+ SENSITIVE = []
637
+ include Aws::Structure
638
+ end
639
+
640
+ # @!attribute [rw] client_id
641
+ # The unique identifier string for each client. This client uses this
642
+ # identifier to get authenticated by the service in subsequent calls.
643
+ # @return [String]
644
+ #
645
+ # @!attribute [rw] client_secret
646
+ # A secret string generated for the client. The client will use this
647
+ # string to get authenticated by the service in subsequent calls.
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] client_id_issued_at
651
+ # Indicates the time at which the `clientId` and `clientSecret` were
652
+ # issued.
653
+ # @return [Integer]
654
+ #
655
+ # @!attribute [rw] client_secret_expires_at
656
+ # Indicates the time at which the `clientId` and `clientSecret` will
657
+ # become invalid.
658
+ # @return [Integer]
659
+ #
660
+ # @!attribute [rw] authorization_endpoint
661
+ # An endpoint that the client can use to request authorization.
662
+ # @return [String]
663
+ #
664
+ # @!attribute [rw] token_endpoint
665
+ # An endpoint that the client can use to create tokens.
666
+ # @return [String]
667
+ #
668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClientResponse AWS API Documentation
669
+ #
670
+ class RegisterClientResponse < Struct.new(
671
+ :client_id,
672
+ :client_secret,
673
+ :client_id_issued_at,
674
+ :client_secret_expires_at,
675
+ :authorization_endpoint,
676
+ :token_endpoint)
677
+ SENSITIVE = [:client_secret]
678
+ include Aws::Structure
679
+ end
680
+
681
+ # Indicates that the client is making the request too frequently and is
682
+ # more than the service can handle.
683
+ #
684
+ # @!attribute [rw] error
685
+ # Single error code. For this exception the value will be `slow_down`.
686
+ # @return [String]
687
+ #
688
+ # @!attribute [rw] error_description
689
+ # Human-readable text providing additional information, used to assist
690
+ # the client developer in understanding the error that occurred.
691
+ # @return [String]
692
+ #
693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/SlowDownException AWS API Documentation
694
+ #
695
+ class SlowDownException < Struct.new(
696
+ :error,
697
+ :error_description)
698
+ SENSITIVE = []
699
+ include Aws::Structure
700
+ end
701
+
702
+ # @!attribute [rw] client_id
703
+ # The unique identifier string for the client that is registered with
704
+ # IAM Identity Center. This value should come from the persisted
705
+ # result of the RegisterClient API operation.
706
+ # @return [String]
707
+ #
708
+ # @!attribute [rw] client_secret
709
+ # A secret string that is generated for the client. This value should
710
+ # come from the persisted result of the RegisterClient API operation.
711
+ # @return [String]
712
+ #
713
+ # @!attribute [rw] start_url
714
+ # The URL for the Amazon Web Services access portal. For more
715
+ # information, see [Using the Amazon Web Services access portal][1] in
716
+ # the *IAM Identity Center User Guide*.
717
+ #
718
+ #
719
+ #
720
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html
721
+ # @return [String]
722
+ #
723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorizationRequest AWS API Documentation
724
+ #
725
+ class StartDeviceAuthorizationRequest < Struct.new(
726
+ :client_id,
727
+ :client_secret,
728
+ :start_url)
729
+ SENSITIVE = [:client_secret]
730
+ include Aws::Structure
731
+ end
732
+
733
+ # @!attribute [rw] device_code
734
+ # The short-lived code that is used by the device when polling for a
735
+ # session token.
736
+ # @return [String]
737
+ #
738
+ # @!attribute [rw] user_code
739
+ # A one-time user verification code. This is needed to authorize an
740
+ # in-use device.
741
+ # @return [String]
742
+ #
743
+ # @!attribute [rw] verification_uri
744
+ # The URI of the verification page that takes the `userCode` to
745
+ # authorize the device.
746
+ # @return [String]
747
+ #
748
+ # @!attribute [rw] verification_uri_complete
749
+ # An alternate URL that the client can use to automatically launch a
750
+ # browser. This process skips the manual step in which the user visits
751
+ # the verification page and enters their code.
752
+ # @return [String]
753
+ #
754
+ # @!attribute [rw] expires_in
755
+ # Indicates the number of seconds in which the verification code will
756
+ # become invalid.
757
+ # @return [Integer]
758
+ #
759
+ # @!attribute [rw] interval
760
+ # Indicates the number of seconds the client must wait between
761
+ # attempts when polling for a session.
762
+ # @return [Integer]
763
+ #
764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorizationResponse AWS API Documentation
765
+ #
766
+ class StartDeviceAuthorizationResponse < Struct.new(
767
+ :device_code,
768
+ :user_code,
769
+ :verification_uri,
770
+ :verification_uri_complete,
771
+ :expires_in,
772
+ :interval)
773
+ SENSITIVE = []
774
+ include Aws::Structure
775
+ end
776
+
777
+ # Indicates that the client is not currently authorized to make the
778
+ # request. This can happen when a `clientId` is not issued for a public
779
+ # client.
780
+ #
781
+ # @!attribute [rw] error
782
+ # Single error code. For this exception the value will be
783
+ # `unauthorized_client`.
784
+ # @return [String]
785
+ #
786
+ # @!attribute [rw] error_description
787
+ # Human-readable text providing additional information, used to assist
788
+ # the client developer in understanding the error that occurred.
789
+ # @return [String]
790
+ #
791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/UnauthorizedClientException AWS API Documentation
792
+ #
793
+ class UnauthorizedClientException < Struct.new(
794
+ :error,
795
+ :error_description)
796
+ SENSITIVE = []
797
+ include Aws::Structure
798
+ end
799
+
800
+ # Indicates that the grant type in the request is not supported by the
801
+ # service.
802
+ #
803
+ # @!attribute [rw] error
804
+ # Single error code. For this exception the value will be
805
+ # `unsupported_grant_type`.
806
+ # @return [String]
807
+ #
808
+ # @!attribute [rw] error_description
809
+ # Human-readable text providing additional information, used to assist
810
+ # the client developer in understanding the error that occurred.
811
+ # @return [String]
812
+ #
813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/UnsupportedGrantTypeException AWS API Documentation
814
+ #
815
+ class UnsupportedGrantTypeException < Struct.new(
816
+ :error,
817
+ :error_description)
818
+ SENSITIVE = []
819
+ include Aws::Structure
820
+ end
821
+
822
+ end
823
+ end