aws-sdk-controltower 1.0.0

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

@@ -0,0 +1,335 @@
+# 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::ControlTower
+  module Types
+
+    # User does not have sufficient access to perform this action.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/AccessDeniedException AWS API Documentation
+    #
+    class AccessDeniedException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Updating or deleting a resource can cause an inconsistent state.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ConflictException AWS API Documentation
+    #
+    class ConflictException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # An operation performed by the control.
+    #
+    # @!attribute [rw] end_time
+    #   The time that the operation finished.
+    #   @return [Time]
+    #
+    # @!attribute [rw] operation_type
+    #   One of `ENABLE_CONTROL` or `DISABLE_CONTROL`.
+    #   @return [String]
+    #
+    # @!attribute [rw] start_time
+    #   The time that the operation began.
+    #   @return [Time]
+    #
+    # @!attribute [rw] status
+    #   One of `IN_PROGRESS`, `SUCEEDED`, or `FAILED`.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_message
+    #   If the operation result is `FAILED`, this string contains a message
+    #   explaining why the operation failed.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ControlOperation AWS API Documentation
+    #
+    class ControlOperation < Struct.new(
+      :end_time,
+      :operation_type,
+      :start_time,
+      :status,
+      :status_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass DisableControlInput
+    #   data as a hash:
+    #
+    #       {
+    #         control_identifier: "ControlIdentifier", # required
+    #         target_identifier: "TargetIdentifier", # required
+    #       }
+    #
+    # @!attribute [rw] control_identifier
+    #   The ARN of the control. Only **Strongly recommended** and
+    #   **Elective** controls are permitted, with the exception of the
+    #   **Region deny** guardrail.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_identifier
+    #   The ARN of the organizational unit.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DisableControlInput AWS API Documentation
+    #
+    class DisableControlInput < Struct.new(
+      :control_identifier,
+      :target_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] operation_identifier
+    #   The ID of the asynchronous operation, which is used to track status.
+    #   The operation is available for 90 days.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DisableControlOutput AWS API Documentation
+    #
+    class DisableControlOutput < Struct.new(
+      :operation_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass EnableControlInput
+    #   data as a hash:
+    #
+    #       {
+    #         control_identifier: "ControlIdentifier", # required
+    #         target_identifier: "TargetIdentifier", # required
+    #       }
+    #
+    # @!attribute [rw] control_identifier
+    #   The ARN of the control. Only **Strongly recommended** and
+    #   **Elective** controls are permitted, with the exception of the
+    #   **Region deny** guardrail.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_identifier
+    #   The ARN of the organizational unit.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableControlInput AWS API Documentation
+    #
+    class EnableControlInput < Struct.new(
+      :control_identifier,
+      :target_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] operation_identifier
+    #   The ID of the asynchronous operation, which is used to track status.
+    #   The operation is available for 90 days.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableControlOutput AWS API Documentation
+    #
+    class EnableControlOutput < Struct.new(
+      :operation_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A summary of enabled controls.
+    #
+    # @!attribute [rw] control_identifier
+    #   The ARN of the control. Only **Strongly recommended** and
+    #   **Elective** controls are permitted, with the exception of the
+    #   **Region deny** guardrail.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlSummary AWS API Documentation
+    #
+    class EnabledControlSummary < Struct.new(
+      :control_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass GetControlOperationInput
+    #   data as a hash:
+    #
+    #       {
+    #         operation_identifier: "OperationIdentifier", # required
+    #       }
+    #
+    # @!attribute [rw] operation_identifier
+    #   The ID of the asynchronous operation, which is used to track status.
+    #   The operation is available for 90 days.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetControlOperationInput AWS API Documentation
+    #
+    class GetControlOperationInput < Struct.new(
+      :operation_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] control_operation
+    #   @return [Types::ControlOperation]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetControlOperationOutput AWS API Documentation
+    #
+    class GetControlOperationOutput < Struct.new(
+      :control_operation)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Unexpected error during processing of request.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/InternalServerException AWS API Documentation
+    #
+    class InternalServerException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass ListEnabledControlsInput
+    #   data as a hash:
+    #
+    #       {
+    #         max_results: 1,
+    #         next_token: "String",
+    #         target_identifier: "TargetIdentifier", # required
+    #       }
+    #
+    # @!attribute [rw] max_results
+    #   How many results to return per API call.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token to continue the list from a previous API call with the
+    #   same parameters.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_identifier
+    #   The ARN of the organizational unit.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledControlsInput AWS API Documentation
+    #
+    class ListEnabledControlsInput < Struct.new(
+      :max_results,
+      :next_token,
+      :target_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] enabled_controls
+    #   Lists the controls enabled by AWS Control Tower on the specified
+    #   organizational unit and the accounts it contains.
+    #   @return [Array<Types::EnabledControlSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   Retrieves the next page of results. If the string is empty, the
+    #   current response is the end of the results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledControlsOutput AWS API Documentation
+    #
+    class ListEnabledControlsOutput < Struct.new(
+      :enabled_controls,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Request references a resource which does not exist.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResourceNotFoundException AWS API Documentation
+    #
+    class ResourceNotFoundException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Request would cause a service quota to be exceeded. The limit is 10
+    # concurrent operations.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ServiceQuotaExceededException AWS API Documentation
+    #
+    class ServiceQuotaExceededException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Request was denied due to request throttling.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @!attribute [rw] quota_code
+    #   The ID of the service quota that was exceeded.
+    #   @return [String]
+    #
+    # @!attribute [rw] retry_after_seconds
+    #   The number of seconds the caller should wait before retrying.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] service_code
+    #   The ID of the service that is associated with the error.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ThrottlingException AWS API Documentation
+    #
+    class ThrottlingException < Struct.new(
+      :message,
+      :quota_code,
+      :retry_after_seconds,
+      :service_code)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The input fails to satisfy the constraints specified by an AWS
+    # service.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ValidationException AWS API Documentation
+    #
+    class ValidationException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+  end
+end

data/lib/aws-sdk-controltower.rb

@@ -0,0 +1,53 @@
+# 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'
+
+require_relative 'aws-sdk-controltower/types'
+require_relative 'aws-sdk-controltower/client_api'
+require_relative 'aws-sdk-controltower/client'
+require_relative 'aws-sdk-controltower/errors'
+require_relative 'aws-sdk-controltower/resource'
+require_relative 'aws-sdk-controltower/customizations'
+
+# This module provides support for AWS Control Tower. This module is available in the
+# `aws-sdk-controltower` 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.
+#
+#     control_tower = Aws::ControlTower::Client.new
+#     resp = control_tower.disable_control(params)
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS Control Tower are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::ControlTower::Errors::ServiceError
+#       # rescues all AWS Control Tower API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module Aws::ControlTower
+
+  GEM_VERSION = '1.0.0'
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: aws-sdk-controltower
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Amazon Web Services
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.127.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.127.0
+- !ruby/object:Gem::Dependency
+  name: aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Official AWS Ruby gem for AWS Control Tower. This gem is part of the
+  AWS SDK for Ruby.
+email:
+- aws-dr-rubygems@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- VERSION
+- lib/aws-sdk-controltower.rb
+- lib/aws-sdk-controltower/client.rb
+- lib/aws-sdk-controltower/client_api.rb
+- lib/aws-sdk-controltower/customizations.rb
+- lib/aws-sdk-controltower/errors.rb
+- lib/aws-sdk-controltower/resource.rb
+- lib/aws-sdk-controltower/types.rb
+homepage: https://github.com/aws/aws-sdk-ruby
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-controltower
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-controltower/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: AWS SDK for Ruby - AWS Control Tower
+test_files: []