aws-sdk-ssooidc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28d120a54bfc0a985ed81ec27c407908c9a86d83
+  data.tar.gz: f2710a68c43fa93b6a7f294bdb861a51aa9aa829
+SHA512:
+  metadata.gz: 35a44edc59de656b8db20ea1a7022a678acac8624c41d3dfaea3c8242844746f963e07d595347ff4d11e9d79117aefae781d1a0fb4f45e71090f2a7fd120a9f2
+  data.tar.gz: 8dd6d8ced3eb513d34c7bee21a48ba618117da6d8e46c3078bfa7068c0c789022dbf2905ace0033d3dfaffbc472725fa3ed2776a763134d952f5e6740917ec10

data/lib/aws-sdk-ssooidc.rb

@@ -0,0 +1,47 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+require_relative 'aws-sdk-ssooidc/types'
+require_relative 'aws-sdk-ssooidc/client_api'
+require_relative 'aws-sdk-ssooidc/client'
+require_relative 'aws-sdk-ssooidc/errors'
+require_relative 'aws-sdk-ssooidc/resource'
+require_relative 'aws-sdk-ssooidc/customizations'
+
+# This module provides support for AWS SSO OIDC. This module is available in the
+# `aws-sdk-ssooidc` 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.
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS SSO OIDC all
+# extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::SSOOIDC::Errors::ServiceError
+#       # rescues all service API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @service
+module Aws::SSOOIDC
+
+  GEM_VERSION = '1.0.0'
+
+end

data/lib/aws-sdk-ssooidc/client.rb

@@ -0,0 +1,477 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'seahorse/client/plugins/content_length.rb'
+require 'aws-sdk-core/plugins/credentials_configuration.rb'
+require 'aws-sdk-core/plugins/logging.rb'
+require 'aws-sdk-core/plugins/param_converter.rb'
+require 'aws-sdk-core/plugins/param_validator.rb'
+require 'aws-sdk-core/plugins/user_agent.rb'
+require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
+require 'aws-sdk-core/plugins/retry_errors.rb'
+require 'aws-sdk-core/plugins/global_configuration.rb'
+require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/endpoint_discovery.rb'
+require 'aws-sdk-core/plugins/endpoint_pattern.rb'
+require 'aws-sdk-core/plugins/response_paging.rb'
+require 'aws-sdk-core/plugins/stub_responses.rb'
+require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
+require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
+require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
+require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/protocols/rest_json.rb'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:ssooidc)
+
+module Aws::SSOOIDC
+  class Client < Seahorse::Client::Base
+
+    include Aws::ClientStubs
+
+    @identifier = :ssooidc
+
+    set_api(ClientApi::API)
+
+    add_plugin(Seahorse::Client::Plugins::ContentLength)
+    add_plugin(Aws::Plugins::CredentialsConfiguration)
+    add_plugin(Aws::Plugins::Logging)
+    add_plugin(Aws::Plugins::ParamConverter)
+    add_plugin(Aws::Plugins::ParamValidator)
+    add_plugin(Aws::Plugins::UserAgent)
+    add_plugin(Aws::Plugins::HelpfulSocketErrors)
+    add_plugin(Aws::Plugins::RetryErrors)
+    add_plugin(Aws::Plugins::GlobalConfiguration)
+    add_plugin(Aws::Plugins::RegionalEndpoint)
+    add_plugin(Aws::Plugins::EndpointDiscovery)
+    add_plugin(Aws::Plugins::EndpointPattern)
+    add_plugin(Aws::Plugins::ResponsePaging)
+    add_plugin(Aws::Plugins::StubResponses)
+    add_plugin(Aws::Plugins::IdempotencyToken)
+    add_plugin(Aws::Plugins::JsonvalueConverter)
+    add_plugin(Aws::Plugins::ClientMetricsPlugin)
+    add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
+    add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::SignatureV4)
+    add_plugin(Aws::Plugins::Protocols::RestJson)
+
+    # @overload initialize(options)
+    #   @param [Hash] options
+    #   @option options [required, Aws::CredentialProvider] :credentials
+    #     Your AWS credentials. This can be an instance of any one of the
+    #     following classes:
+    #
+    #     * `Aws::Credentials` - Used for configuring static, non-refreshing
+    #       credentials.
+    #
+    #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
+    #       from an EC2 IMDS on an EC2 instance.
+    #
+    #     * `Aws::SharedCredentials` - Used for loading credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     When `:credentials` are not configured directly, the following
+    #     locations will be searched for credentials:
+    #
+    #     * `Aws.config[:credentials]`
+    #     * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
+    #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
+    #     * `~/.aws/credentials`
+    #     * `~/.aws/config`
+    #     * EC2 IMDS instance profile - When used by default, the timeouts are
+    #       very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` to enable retries and extended
+    #       timeouts.
+    #
+    #   @option options [required, String] :region
+    #     The AWS region to connect to.  The configured `:region` is
+    #     used to determine the service `:endpoint`. When not passed,
+    #     a default `:region` is search for in the following locations:
+    #
+    #     * `Aws.config[:region]`
+    #     * `ENV['AWS_REGION']`
+    #     * `ENV['AMAZON_REGION']`
+    #     * `ENV['AWS_DEFAULT_REGION']`
+    #     * `~/.aws/credentials`
+    #     * `~/.aws/config`
+    #
+    #   @option options [String] :access_key_id
+    #
+    #   @option options [Boolean] :active_endpoint_cache (false)
+    #     When set to `true`, a thread polling for endpoints will be running in
+    #     the background every 60 secs (default). Defaults to `false`.
+    #
+    #   @option options [Boolean] :client_side_monitoring (false)
+    #     When `true`, client-side metrics will be collected for all API requests from
+    #     this client.
+    #
+    #   @option options [String] :client_side_monitoring_client_id ("")
+    #     Allows you to provide an identifier for this client which will be attached to
+    #     all generated client side metrics. Defaults to an empty string.
+    #
+    #   @option options [String] :client_side_monitoring_host ("127.0.0.1")
+    #     Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
+    #     side monitoring agent is running on, where client metrics will be published via UDP.
+    #
+    #   @option options [Integer] :client_side_monitoring_port (31000)
+    #     Required for publishing client metrics. The port that the client side monitoring
+    #     agent is running on, where client metrics will be published via UDP.
+    #
+    #   @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
+    #     Allows you to provide a custom client-side monitoring publisher class. By default,
+    #     will use the Client Side Monitoring Agent Publisher.
+    #
+    #   @option options [Boolean] :convert_params (true)
+    #     When `true`, an attempt is made to coerce request parameters into
+    #     the required types.
+    #
+    #   @option options [Boolean] :disable_host_prefix_injection (false)
+    #     Set to true to disable SDK automatically adding host prefix
+    #     to default service endpoint when available.
+    #
+    #   @option options [String] :endpoint
+    #     The client endpoint is normally constructed from the `:region`
+    #     option. You should only configure an `:endpoint` when connecting
+    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #
+    #   @option options [Integer] :endpoint_cache_max_entries (1000)
+    #     Used for the maximum size limit of the LRU cache storing endpoints data
+    #     for endpoint discovery enabled operations. Defaults to 1000.
+    #
+    #   @option options [Integer] :endpoint_cache_max_threads (10)
+    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
+    #
+    #   @option options [Integer] :endpoint_cache_poll_interval (60)
+    #     When :endpoint_discovery and :active_endpoint_cache is enabled,
+    #     Use this option to config the time interval in seconds for making
+    #     requests fetching endpoints information. Defaults to 60 sec.
+    #
+    #   @option options [Boolean] :endpoint_discovery (false)
+    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #
+    #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
+    #     The log formatter.
+    #
+    #   @option options [Symbol] :log_level (:info)
+    #     The log level to send messages to the `:logger` at.
+    #
+    #   @option options [Logger] :logger
+    #     The Logger instance to send log messages to.  If this option
+    #     is not set, logging will be disabled.
+    #
+    #   @option options [String] :profile ("default")
+    #     Used when loading credentials from the shared credentials file
+    #     at HOME/.aws/credentials.  When not specified, 'default' is used.
+    #
+    #   @option options [Float] :retry_base_delay (0.3)
+    #     The base delay in seconds used by the default backoff function.
+    #
+    #   @option options [Symbol] :retry_jitter (:none)
+    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #
+    #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
+    #
+    #   @option options [Integer] :retry_limit (3)
+    #     The maximum number of times to retry failed requests.  Only
+    #     ~ 500 level server errors and certain ~ 400 level client errors
+    #     are retried.  Generally, these are throttling errors, data
+    #     checksum errors, networking errors, timeout errors and auth
+    #     errors from expired credentials.
+    #
+    #   @option options [Integer] :retry_max_delay (0)
+    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #
+    #   @option options [String] :secret_access_key
+    #
+    #   @option options [String] :session_token
+    #
+    #   @option options [Boolean] :stub_responses (false)
+    #     Causes the client to return stubbed responses. By default
+    #     fake responses are generated and returned. You can specify
+    #     the response data to return or errors to raise by calling
+    #     {ClientStubs#stub_responses}. See {ClientStubs} for more information.
+    #
+    #     ** Please note ** When response stubbing is enabled, no HTTP
+    #     requests are made, and retries are disabled.
+    #
+    #   @option options [Boolean] :validate_params (true)
+    #     When `true`, request parameters are validated before
+    #     sending the request.
+    #
+    #   @option options [URI::HTTP,String] :http_proxy A proxy to send
+    #     requests through.  Formatted like 'http://proxy.com:123'.
+    #
+    #   @option options [Float] :http_open_timeout (15) The number of
+    #     seconds to wait when opening a HTTP session before rasing a
+    #     `Timeout::Error`.
+    #
+    #   @option options [Integer] :http_read_timeout (60) The default
+    #     number of seconds to wait for response data.  This value can
+    #     safely be set
+    #     per-request on the session yeidled by {#session_for}.
+    #
+    #   @option options [Float] :http_idle_timeout (5) The number of
+    #     seconds a connection is allowed to sit idble before it is
+    #     considered stale.  Stale connections are closed and removed
+    #     from the pool before making a request.
+    #
+    #   @option options [Float] :http_continue_timeout (1) The number of
+    #     seconds to wait for a 100-continue response before sending the
+    #     request body.  This option has no effect unless the request has
+    #     "Expect" header set to "100-continue".  Defaults to `nil` which
+    #     disables this behaviour.  This value can safely be set per
+    #     request on the session yeidled by {#session_for}.
+    #
+    #   @option options [Boolean] :http_wire_trace (false) When `true`,
+    #     HTTP debug output will be sent to the `:logger`.
+    #
+    #   @option options [Boolean] :ssl_verify_peer (true) When `true`,
+    #     SSL peer certificates are verified when establishing a
+    #     connection.
+    #
+    #   @option options [String] :ssl_ca_bundle Full path to the SSL
+    #     certificate authority bundle file that should be used when
+    #     verifying peer certificates.  If you do not pass
+    #     `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
+    #     will be used if available.
+    #
+    #   @option options [String] :ssl_ca_directory Full path of the
+    #     directory that contains the unbundled SSL certificate
+    #     authority files for verifying peer certificates.  If you do
+    #     not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
+    #     system default will be used if available.
+    #
+    def initialize(*args)
+      super
+    end
+
+    # @!group API Operations
+
+    # Creates and returns an access token for the authorized client. The
+    # access token issued will be used to fetch short-term credentials for
+    # the assigned roles in the AWS account.
+    #
+    # @option params [required, String] :client_id
+    #   The unique identifier string for each client. This value should come
+    #   from the persisted result of the RegisterClient API.
+    #
+    # @option params [required, String] :client_secret
+    #   A secret string generated for the client. This value should come from
+    #   the persisted result of the RegisterClient API.
+    #
+    # @option params [required, String] :grant_type
+    #   Supports grant types for authorization code, refresh token, and device
+    #   code request.
+    #
+    # @option params [required, String] :device_code
+    #   Used only when calling this API for the device code grant type. This
+    #   short-term code is used to identify this authentication attempt. This
+    #   should come from an in-memory reference to the result of the
+    #   StartDeviceAuthorization API.
+    #
+    # @option params [String] :code
+    #   The authorization code received from the authorization service. This
+    #   parameter is required to perform an authorization grant request to get
+    #   access to a token.
+    #
+    # @option params [String] :refresh_token
+    #   The token used to obtain an access token in the event that the access
+    #   token is invalid or expired. This token is not issued by the service.
+    #
+    # @option params [Array<String>] :scope
+    #   The list of scopes that is defined by the client. Upon authorization,
+    #   this list is used to restrict permissions when granting an access
+    #   token.
+    #
+    # @option params [String] :redirect_uri
+    #   The location of the application that will receive the authorization
+    #   code. Users authorize the service to send the request to this
+    #   location.
+    #
+    # @return [Types::CreateTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateTokenResponse#access_token #access_token} => String
+    #   * {Types::CreateTokenResponse#token_type #token_type} => String
+    #   * {Types::CreateTokenResponse#expires_in #expires_in} => Integer
+    #   * {Types::CreateTokenResponse#refresh_token #refresh_token} => String
+    #   * {Types::CreateTokenResponse#id_token #id_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_token({
+    #     client_id: "ClientId", # required
+    #     client_secret: "ClientSecret", # required
+    #     grant_type: "GrantType", # required
+    #     device_code: "DeviceCode", # required
+    #     code: "AuthCode",
+    #     refresh_token: "RefreshToken",
+    #     scope: ["Scope"],
+    #     redirect_uri: "URI",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.access_token #=> String
+    #   resp.token_type #=> String
+    #   resp.expires_in #=> Integer
+    #   resp.refresh_token #=> String
+    #   resp.id_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateToken AWS API Documentation
+    #
+    # @overload create_token(params = {})
+    # @param [Hash] params ({})
+    def create_token(params = {}, options = {})
+      req = build_request(:create_token, params)
+      req.send_request(options)
+    end
+
+    # Registers a client with AWS SSO. This allows clients to initiate
+    # device authorization. The output should be persisted for reuse through
+    # many authentication requests.
+    #
+    # @option params [required, String] :client_name
+    #   The friendly name of the client.
+    #
+    # @option params [required, String] :client_type
+    #   The type of client. The service supports only `public` as a client
+    #   type. Anything other than public will be rejected by the service.
+    #
+    # @option params [Array<String>] :scopes
+    #   The list of scopes that are defined by the client. Upon authorization,
+    #   this list is used to restrict permissions when granting an access
+    #   token.
+    #
+    # @return [Types::RegisterClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::RegisterClientResponse#client_id #client_id} => String
+    #   * {Types::RegisterClientResponse#client_secret #client_secret} => String
+    #   * {Types::RegisterClientResponse#client_id_issued_at #client_id_issued_at} => Integer
+    #   * {Types::RegisterClientResponse#client_secret_expires_at #client_secret_expires_at} => Integer
+    #   * {Types::RegisterClientResponse#authorization_endpoint #authorization_endpoint} => String
+    #   * {Types::RegisterClientResponse#token_endpoint #token_endpoint} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.register_client({
+    #     client_name: "ClientName", # required
+    #     client_type: "ClientType", # required
+    #     scopes: ["Scope"],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.client_id #=> String
+    #   resp.client_secret #=> String
+    #   resp.client_id_issued_at #=> Integer
+    #   resp.client_secret_expires_at #=> Integer
+    #   resp.authorization_endpoint #=> String
+    #   resp.token_endpoint #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClient AWS API Documentation
+    #
+    # @overload register_client(params = {})
+    # @param [Hash] params ({})
+    def register_client(params = {}, options = {})
+      req = build_request(:register_client, params)
+      req.send_request(options)
+    end
+
+    # Initiates device authorization by requesting a pair of verification
+    # codes from the authorization service.
+    #
+    # @option params [required, String] :client_id
+    #   The unique identifier string for the client that is registered with
+    #   AWS SSO. This value should come from the persisted result of the
+    #   RegisterClient API operation.
+    #
+    # @option params [required, String] :client_secret
+    #   A secret string that is generated for the client. This value should
+    #   come from the persisted result of the RegisterClient API operation.
+    #
+    # @option params [required, String] :start_url
+    #   The URL for the AWS SSO user portal. For more information, see [Using
+    #   the User Portal][1] in the *AWS Single Sign-On User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html
+    #
+    # @return [Types::StartDeviceAuthorizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartDeviceAuthorizationResponse#device_code #device_code} => String
+    #   * {Types::StartDeviceAuthorizationResponse#user_code #user_code} => String
+    #   * {Types::StartDeviceAuthorizationResponse#verification_uri #verification_uri} => String
+    #   * {Types::StartDeviceAuthorizationResponse#verification_uri_complete #verification_uri_complete} => String
+    #   * {Types::StartDeviceAuthorizationResponse#expires_in #expires_in} => Integer
+    #   * {Types::StartDeviceAuthorizationResponse#interval #interval} => Integer
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_device_authorization({
+    #     client_id: "ClientId", # required
+    #     client_secret: "ClientSecret", # required
+    #     start_url: "URI", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.device_code #=> String
+    #   resp.user_code #=> String
+    #   resp.verification_uri #=> String
+    #   resp.verification_uri_complete #=> String
+    #   resp.expires_in #=> Integer
+    #   resp.interval #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorization AWS API Documentation
+    #
+    # @overload start_device_authorization(params = {})
+    # @param [Hash] params ({})
+    def start_device_authorization(params = {}, options = {})
+      req = build_request(:start_device_authorization, params)
+      req.send_request(options)
+    end
+
+    # @!endgroup
+
+    # @param params ({})
+    # @api private
+    def build_request(operation_name, params = {})
+      handlers = @handlers.for(operation_name)
+      context = Seahorse::Client::RequestContext.new(
+        operation_name: operation_name,
+        operation: config.api.operation(operation_name),
+        client: self,
+        params: params,
+        config: config)
+      context[:gem_name] = 'aws-sdk-ssooidc'
+      context[:gem_version] = '1.0.0'
+      Seahorse::Client::Request.new(handlers, context)
+    end
+
+    # @api private
+    # @deprecated
+    def waiter_names
+      []
+    end
+
+    class << self
+
+      # @api private
+      attr_reader :identifier
+
+      # @api private
+      def errors_module
+        Errors
+      end
+
+    end
+  end
+end