aws-sdk-uxc 1.0.0

data/lib/aws-sdk-uxc/types.rb

@@ -0,0 +1,242 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::Uxc
+  module Types
+
+    # You don't have sufficient access to perform this operation. Verify
+    # that your IAM policy includes the required `uxc:` permissions for the
+    # operation that you are calling. For more information on IAM
+    # permissions, see [Amazon Web Services managed policies for Amazon Web
+    # Services Management Console][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/security-iam-awsmanpol.html
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/AccessDeniedException AWS API Documentation
+    #
+    class AccessDeniedException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @api private
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/GetAccountCustomizationsInput AWS API Documentation
+    #
+    class GetAccountCustomizationsInput < Aws::EmptyStructure; end
+
+    # @!attribute [rw] account_color
+    #   The account color preference. A value of `none` indicates that you
+    #   have not set a color.
+    #   @return [String]
+    #
+    # @!attribute [rw] visible_services
+    #   The list of Amazon Web Services service identifiers that are visible
+    #   to the account in the Amazon Web Services Management Console. A
+    #   value of `null` indicates that you have not configured this feature
+    #   and all services are visible. For valid service identifiers, call
+    #   [ListServices][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/awsconsolehelpdocs/latest/APIReference/API_ListServices.html
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] visible_regions
+    #   The list of Amazon Web Services Region codes that are visible to the
+    #   account in the Amazon Web Services Management Console. A value of
+    #   `null` indicates that you have not configured this feature and all
+    #   Regions are visible. For a list of valid Region codes, see [Amazon
+    #   Web Services Regions][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/GetAccountCustomizationsOutput AWS API Documentation
+    #
+    class GetAccountCustomizationsOutput < Struct.new(
+      :account_color,
+      :visible_services,
+      :visible_regions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The service encountered an internal error. Try your request again
+    # later.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/InternalServerException AWS API Documentation
+    #
+    class InternalServerException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   The token for retrieving the next page of results. Use the
+    #   `nextToken` value from a previous response.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return per page.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/ListServicesInput AWS API Documentation
+    #
+    class ListServicesInput < Struct.new(
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   The token for retrieving the next page of results. This value is
+    #   `null` when no more results are available.
+    #   @return [String]
+    #
+    # @!attribute [rw] services
+    #   The list of available Amazon Web Services service identifiers.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/ListServicesOutput AWS API Documentation
+    #
+    class ListServicesOutput < Struct.new(
+      :next_token,
+      :services)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The request was denied because of request throttling. Reduce the
+    # frequency of your requests.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/ThrottlingException AWS API Documentation
+    #
+    class ThrottlingException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] account_color
+    #   The account color preference to set. Set to `none` to reset to the
+    #   default (no color).
+    #   @return [String]
+    #
+    # @!attribute [rw] visible_services
+    #   The list of Amazon Web Services service identifiers to make visible
+    #   in the Amazon Web Services Management Console. Set to `null` to
+    #   reset to the default, which makes all services visible. For valid
+    #   service identifiers, call [ListServices][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/awsconsolehelpdocs/latest/APIReference/API_ListServices.html
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] visible_regions
+    #   The list of Amazon Web Services Region codes to make visible in the
+    #   Amazon Web Services Management Console. Set to `null` to reset to
+    #   the default, which makes all Regions visible. For a list of valid
+    #   Region codes, see [Amazon Web Services Regions][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/UpdateAccountCustomizationsInput AWS API Documentation
+    #
+    class UpdateAccountCustomizationsInput < Struct.new(
+      :account_color,
+      :visible_services,
+      :visible_regions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] account_color
+    #   The current account color preference after the update.
+    #   @return [String]
+    #
+    # @!attribute [rw] visible_services
+    #   The current list of visible service identifiers after the update.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] visible_regions
+    #   The current list of visible Region codes after the update.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/UpdateAccountCustomizationsOutput AWS API Documentation
+    #
+    class UpdateAccountCustomizationsOutput < Struct.new(
+      :account_color,
+      :visible_services,
+      :visible_regions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The input fails to satisfy the constraints specified by an Amazon Web
+    # Services service.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @!attribute [rw] field_list
+    #   The list of fields that are invalid.
+    #   @return [Array<Types::ValidationExceptionField>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/ValidationException AWS API Documentation
+    #
+    class ValidationException < Struct.new(
+      :message,
+      :field_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Describes a validation exception for a specific field.
+    #
+    # @!attribute [rw] path
+    #   The field name with the validation exception.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   A message describing the validation exception.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/uxc-2024-07-01/ValidationExceptionField AWS API Documentation
+    #
+    class ValidationExceptionField < Struct.new(
+      :path,
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+  end
+end
+

data/lib/aws-sdk-uxc/waiters.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core/waiters'
+
+module Aws::Uxc
+  module Waiters
+  end
+end

data/lib/aws-sdk-uxc.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:uxc)
+
+# This module provides support for AWS User Experience Customization. This module is available in the
+# `aws-sdk-uxc` 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.
+#
+#     uxc = Aws::Uxc::Client.new
+#     resp = uxc.get_account_customizations(params)
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS User Experience Customization are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::Uxc::Errors::ServiceError
+#       # rescues all AWS User Experience Customization API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module Aws::Uxc
+  autoload :Types, 'aws-sdk-uxc/types'
+  autoload :ClientApi, 'aws-sdk-uxc/client_api'
+  module Plugins
+    autoload :Endpoints, 'aws-sdk-uxc/plugins/endpoints.rb'
+  end
+  autoload :Client, 'aws-sdk-uxc/client'
+  autoload :Errors, 'aws-sdk-uxc/errors'
+  autoload :Waiters, 'aws-sdk-uxc/waiters'
+  autoload :Resource, 'aws-sdk-uxc/resource'
+  autoload :EndpointParameters, 'aws-sdk-uxc/endpoint_parameters'
+  autoload :EndpointProvider, 'aws-sdk-uxc/endpoint_provider'
+  autoload :Endpoints, 'aws-sdk-uxc/endpoints'
+
+  GEM_VERSION = '1.0.0'
+
+end
+
+require_relative 'aws-sdk-uxc/customizations'

data/sig/client.rbs

@@ -0,0 +1,120 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Uxc
+    class Client < ::Seahorse::Client::Base
+      include ::Aws::ClientStubs
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Uxc/Client.html#initialize-instance_method
+      def self.new: (
+                      ?credentials: untyped,
+                      ?region: String,
+                      ?access_key_id: String,
+                      ?account_id: String,
+                      ?active_endpoint_cache: bool,
+                      ?adaptive_retry_wait_to_fill: bool,
+                      ?auth_scheme_preference: Array[String],
+                      ?client_side_monitoring: bool,
+                      ?client_side_monitoring_client_id: String,
+                      ?client_side_monitoring_host: String,
+                      ?client_side_monitoring_port: Integer,
+                      ?client_side_monitoring_publisher: untyped,
+                      ?convert_params: bool,
+                      ?correct_clock_skew: bool,
+                      ?defaults_mode: String,
+                      ?disable_host_prefix_injection: bool,
+                      ?disable_request_compression: bool,
+                      ?endpoint: String,
+                      ?endpoint_cache_max_entries: Integer,
+                      ?endpoint_cache_max_threads: Integer,
+                      ?endpoint_cache_poll_interval: Integer,
+                      ?endpoint_discovery: bool,
+                      ?ignore_configured_endpoint_urls: bool,
+                      ?log_formatter: untyped,
+                      ?log_level: Symbol,
+                      ?logger: untyped,
+                      ?max_attempts: Integer,
+                      ?profile: String,
+                      ?request_checksum_calculation: String,
+                      ?request_min_compression_size_bytes: Integer,
+                      ?response_checksum_validation: String,
+                      ?retry_backoff: Proc,
+                      ?retry_base_delay: Float,
+                      ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
+                      ?retry_limit: Integer,
+                      ?retry_max_delay: Integer,
+                      ?retry_mode: ("legacy" | "standard" | "adaptive"),
+                      ?sdk_ua_app_id: String,
+                      ?secret_access_key: String,
+                      ?session_token: String,
+                      ?sigv4a_signing_region_set: Array[String],
+                      ?stub_responses: untyped,
+                      ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
+                      ?token_provider: untyped,
+                      ?use_dualstack_endpoint: bool,
+                      ?use_fips_endpoint: bool,
+                      ?validate_params: bool,
+                      ?endpoint_provider: untyped,
+                      ?http_proxy: String,
+                      ?http_open_timeout: (Float | Integer),
+                      ?http_read_timeout: (Float | Integer),
+                      ?http_idle_timeout: (Float | Integer),
+                      ?http_continue_timeout: (Float | Integer),
+                      ?ssl_timeout: (Float | Integer | nil),
+                      ?http_wire_trace: bool,
+                      ?ssl_verify_peer: bool,
+                      ?ssl_ca_bundle: String,
+                      ?ssl_ca_directory: String,
+                      ?ssl_ca_store: String,
+                      ?on_chunk_received: Proc,
+                      ?on_chunk_sent: Proc,
+                      ?raise_response_errors: bool
+                    ) -> instance
+                  | (?Hash[Symbol, untyped]) -> instance
+
+
+      interface _GetAccountCustomizationsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetAccountCustomizationsOutput]
+        def account_color: () -> ("none" | "pink" | "purple" | "darkBlue" | "lightBlue" | "teal" | "green" | "yellow" | "orange" | "red")
+        def visible_services: () -> ::Array[::String]
+        def visible_regions: () -> ::Array[::String]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Uxc/Client.html#get_account_customizations-instance_method
+      def get_account_customizations: (
+                                      ) -> _GetAccountCustomizationsResponseSuccess
+                                    | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAccountCustomizationsResponseSuccess
+
+      interface _ListServicesResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListServicesOutput]
+        def next_token: () -> ::String
+        def services: () -> ::Array[::String]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Uxc/Client.html#list_services-instance_method
+      def list_services: (
+                           ?next_token: ::String,
+                           ?max_results: ::Integer
+                         ) -> _ListServicesResponseSuccess
+                       | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListServicesResponseSuccess
+
+      interface _UpdateAccountCustomizationsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAccountCustomizationsOutput]
+        def account_color: () -> ("none" | "pink" | "purple" | "darkBlue" | "lightBlue" | "teal" | "green" | "yellow" | "orange" | "red")
+        def visible_services: () -> ::Array[::String]
+        def visible_regions: () -> ::Array[::String]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Uxc/Client.html#update_account_customizations-instance_method
+      def update_account_customizations: (
+                                           ?account_color: ("none" | "pink" | "purple" | "darkBlue" | "lightBlue" | "teal" | "green" | "yellow" | "orange" | "red"),
+                                           ?visible_services: Array[::String],
+                                           ?visible_regions: Array[::String]
+                                         ) -> _UpdateAccountCustomizationsResponseSuccess
+                                       | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAccountCustomizationsResponseSuccess
+    end
+  end
+end
+

data/sig/errors.rbs

@@ -0,0 +1,29 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Uxc
+    module Errors
+      class ServiceError < ::Aws::Errors::ServiceError
+      end
+
+      class AccessDeniedException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+      class InternalServerException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+      class ThrottlingException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+      class ValidationException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+        def field_list: () -> ::String
+      end
+    end
+  end
+end

data/sig/resource.rbs

@@ -0,0 +1,85 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Uxc
+    # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Uxc/Resource.html
+    class Resource
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Uxc/Resource.html#initialize-instance_method
+      def initialize: (
+                        ?client: Client,
+                        ?credentials: untyped,
+                        ?region: String,
+                        ?access_key_id: String,
+                        ?account_id: String,
+                        ?active_endpoint_cache: bool,
+                        ?adaptive_retry_wait_to_fill: bool,
+                        ?auth_scheme_preference: Array[String],
+                        ?client_side_monitoring: bool,
+                        ?client_side_monitoring_client_id: String,
+                        ?client_side_monitoring_host: String,
+                        ?client_side_monitoring_port: Integer,
+                        ?client_side_monitoring_publisher: untyped,
+                        ?convert_params: bool,
+                        ?correct_clock_skew: bool,
+                        ?defaults_mode: String,
+                        ?disable_host_prefix_injection: bool,
+                        ?disable_request_compression: bool,
+                        ?endpoint: String,
+                        ?endpoint_cache_max_entries: Integer,
+                        ?endpoint_cache_max_threads: Integer,
+                        ?endpoint_cache_poll_interval: Integer,
+                        ?endpoint_discovery: bool,
+                        ?ignore_configured_endpoint_urls: bool,
+                        ?log_formatter: untyped,
+                        ?log_level: Symbol,
+                        ?logger: untyped,
+                        ?max_attempts: Integer,
+                        ?profile: String,
+                        ?request_checksum_calculation: String,
+                        ?request_min_compression_size_bytes: Integer,
+                        ?response_checksum_validation: String,
+                        ?retry_backoff: Proc,
+                        ?retry_base_delay: Float,
+                        ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
+                        ?retry_limit: Integer,
+                        ?retry_max_delay: Integer,
+                        ?retry_mode: ("legacy" | "standard" | "adaptive"),
+                        ?sdk_ua_app_id: String,
+                        ?secret_access_key: String,
+                        ?session_token: String,
+                        ?sigv4a_signing_region_set: Array[String],
+                        ?stub_responses: untyped,
+                        ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
+                        ?token_provider: untyped,
+                        ?use_dualstack_endpoint: bool,
+                        ?use_fips_endpoint: bool,
+                        ?validate_params: bool,
+                        ?endpoint_provider: untyped,
+                        ?http_proxy: String,
+                        ?http_open_timeout: (Float | Integer),
+                        ?http_read_timeout: (Float | Integer),
+                        ?http_idle_timeout: (Float | Integer),
+                        ?http_continue_timeout: (Float | Integer),
+                        ?ssl_timeout: (Float | Integer | nil),
+                        ?http_wire_trace: bool,
+                        ?ssl_verify_peer: bool,
+                        ?ssl_ca_bundle: String,
+                        ?ssl_ca_directory: String,
+                        ?ssl_ca_store: String,
+                        ?on_chunk_received: Proc,
+                        ?on_chunk_sent: Proc,
+                        ?raise_response_errors: bool
+                      ) -> void
+                    | (?Hash[Symbol, untyped]) -> void
+
+      def client: () -> Client
+
+
+    end
+  end
+end

data/sig/types.rbs

@@ -0,0 +1,74 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::Uxc
+  module Types
+
+    class AccessDeniedException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
+    class GetAccountCustomizationsInput < Aws::EmptyStructure
+    end
+
+    class GetAccountCustomizationsOutput
+      attr_accessor account_color: ("none" | "pink" | "purple" | "darkBlue" | "lightBlue" | "teal" | "green" | "yellow" | "orange" | "red")
+      attr_accessor visible_services: ::Array[::String]
+      attr_accessor visible_regions: ::Array[::String]
+      SENSITIVE: []
+    end
+
+    class InternalServerException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
+    class ListServicesInput
+      attr_accessor next_token: ::String
+      attr_accessor max_results: ::Integer
+      SENSITIVE: []
+    end
+
+    class ListServicesOutput
+      attr_accessor next_token: ::String
+      attr_accessor services: ::Array[::String]
+      SENSITIVE: []
+    end
+
+    class ThrottlingException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
+    class UpdateAccountCustomizationsInput
+      attr_accessor account_color: ("none" | "pink" | "purple" | "darkBlue" | "lightBlue" | "teal" | "green" | "yellow" | "orange" | "red")
+      attr_accessor visible_services: ::Array[::String]
+      attr_accessor visible_regions: ::Array[::String]
+      SENSITIVE: []
+    end
+
+    class UpdateAccountCustomizationsOutput
+      attr_accessor account_color: ("none" | "pink" | "purple" | "darkBlue" | "lightBlue" | "teal" | "green" | "yellow" | "orange" | "red")
+      attr_accessor visible_services: ::Array[::String]
+      attr_accessor visible_regions: ::Array[::String]
+      SENSITIVE: []
+    end
+
+    class ValidationException
+      attr_accessor message: ::String
+      attr_accessor field_list: ::Array[Types::ValidationExceptionField]
+      SENSITIVE: []
+    end
+
+    class ValidationExceptionField
+      attr_accessor path: ::String
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+  end
+end

data/sig/waiters.rbs

@@ -0,0 +1,13 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Uxc
+    module Waiters
+    end
+  end
+end