You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.
Class: AWS::STS::Client
- Inherits:
-
Core::QueryClient
- Object
- Core::Client
- Core::QueryClient
- AWS::STS::Client
- Defined in:
- lib/aws/sts/client.rb
Overview
Client class for AWS Security Token Service (STS).
Direct Known Subclasses
Defined Under Namespace
Classes: V20110615
Constant Summary
- API_VERSION =
'2011-06-15'
- REGION_US_E1 =
'sts.amazonaws.com'
Instance Attribute Summary
Attributes inherited from Core::Client
Instance Method Summary collapse
-
#assume_role(options = {}) ⇒ Core::Response
Calls the AssumeRole API operation.
-
#assume_role_with_saml(options = {}) ⇒ Core::Response
Calls the AssumeRoleWithSAML API operation.
-
#assume_role_with_web_identity(options = {}) ⇒ Core::Response
Calls the AssumeRoleWithWebIdentity API operation.
-
#decode_authorization_message(options = {}) ⇒ Core::Response
Calls the DecodeAuthorizationMessage API operation.
-
#do_sign_request ⇒ Object
Two STS operations are un-signed.
-
#get_federation_token(options = {}) ⇒ Core::Response
Calls the GetFederationToken API operation.
-
#get_session_token(options = {}) ⇒ Core::Response
Calls the GetSessionToken API operation.
-
#initialize(*args) ⇒ Client
constructor
A new instance of Client.
-
#sign_request(req) ⇒ Object
Methods inherited from Core::Client
#log_warning, #operations, #with_http_handler, #with_options
Constructor Details
#initialize(*args) ⇒ Client
Returns a new instance of Client
29 30 31 32 33 34 35 36 |
# File 'lib/aws/sts/client.rb', line 29 def initialize *args super unless config.use_ssl? msg = 'AWS Security Token Service (STS) requires ssl but the ' + ':use_ssl option is set to false. Try passing :use_ssl => true' raise ArgumentError, msg end end |
Instance Method Details
#assume_role(options = {}) ⇒ Core::Response
Calls the AssumeRole API operation.
#assume_role_with_saml(options = {}) ⇒ Core::Response
Calls the AssumeRoleWithSAML API operation.
#assume_role_with_web_identity(options = {}) ⇒ Core::Response
Calls the AssumeRoleWithWebIdentity API operation.
#decode_authorization_message(options = {}) ⇒ Core::Response
Calls the DecodeAuthorizationMessage API operation.
#do_sign_request ⇒ Object
Two STS operations are un-signed
39 |
# File 'lib/aws/sts/client.rb', line 39 alias do_sign_request sign_request |
#get_federation_token(options = {}) ⇒ Core::Response
Calls the GetFederationToken API operation.
#get_session_token(options = {}) ⇒ Core::Response
Calls the GetSessionToken API operation.
#sign_request(req) ⇒ Object
40 41 42 43 44 45 |
# File 'lib/aws/sts/client.rb', line 40 def sign_request(req) action = req.params.find { |param| param.name == 'Action' }.value unsigned = %w( AssumeRoleWithWebIdentity AssumeRoleWithSAML ) do_sign_request(req) unless unsigned.include?(action) req end |