module Aws::STS
This module provides support for AWS Security Token
Service. This module is available in the ‘aws-sdk-core` gem.
# Client
The {Client} class provides one method for each API operation. Operation methods each accept a hash of request parameters and return a response structure.
sts = Aws::STS::Client.new resp = sts.assume_role(params)
See {Client} for more information.
# Errors
Errors
returned from AWS Security Token
Service are defined in the {Errors} module and all extend {Errors::ServiceError}.
begin # do stuff rescue Aws::STS::Errors::ServiceError # rescues all AWS Security Token Service API errors end
See {Errors} for more information.
@!group service
WARNING ABOUT GENERATED CODE
This file is generated. See the contributing guide for more information: github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
WARNING ABOUT GENERATED CODE
WARNING ABOUT GENERATED CODE
This file is generated. See the contributing guide for more information: github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
WARNING ABOUT GENERATED CODE
WARNING ABOUT GENERATED CODE
This file is generated. See the contributing guide for more information: github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
WARNING ABOUT GENERATED CODE
WARNING ABOUT GENERATED CODE
This file is generated. See the contributing guide for more information: github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
WARNING ABOUT GENERATED CODE
WARNING ABOUT GENERATED CODE
This file is generated. See the contributing guide for more information: github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
WARNING ABOUT GENERATED CODE
WARNING ABOUT GENERATED CODE
This file is generated. See the contributing guide for more information: github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
WARNING ABOUT GENERATED CODE
WARNING ABOUT GENERATED CODE
This file is generated. See the contributing guide for more information: github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
WARNING ABOUT GENERATED CODE
WARNING ABOUT GENERATED CODE
This file is generated. See the contributing guide for more information: github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
WARNING ABOUT GENERATED CODE
Constants
- EndpointParameters
Endpoint parameters used to influence endpoints per request.
@!attribute region
The AWS region used to dispatch the request. @return [String]
@!attribute use_dual_stack
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error. @return [Boolean]
@!attribute use_fips
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error. @return [Boolean]
@!attribute endpoint
Override the endpoint used to send this request @return [String]
@!attribute use_global_endpoint
Whether the global endpoint should be used, rather then the regional endpoint for us-east-1. @return [Boolean]
- GEM_VERSION
Public Class Methods
# File lib/aws-sdk-sts/endpoint_parameters.rb, line 69 def self.create(config, options={}) new({ region: config.region, use_dual_stack: config.use_dualstack_endpoint, use_fips: config.use_fips_endpoint, endpoint: (config.endpoint.to_s unless config.regional_endpoint), use_global_endpoint: config.sts_regional_endpoints == 'legacy', }.merge(options)) end
# File lib/aws-sdk-sts/endpoint_parameters.rb, line 58 def initialize(options = {}) self[:region] = options[:region] self[:use_dual_stack] = options[:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? self[:use_fips] = options[:use_fips] self[:use_fips] = false if self[:use_fips].nil? self[:endpoint] = options[:endpoint] self[:use_global_endpoint] = options[:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? end