aws-sdk-controlcatalog 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b8a3ae32f5017d4e3b51ca72bae3f8102816918eaf72ab4ada88da086aa26bd
-  data.tar.gz: 913568876b26b5a8f79417dde6d6ecc76b1731ea9f114475d72c27245bbda8e0
+  metadata.gz: 23921242f81a2c4d0a344a710299d5935d3d7edbb1ee2ee01b18ed96354dbf15
+  data.tar.gz: 4cec7f9d4047762eaecc4c929a877d2a4011e1eca619cdc76370f535c237aca2
 SHA512:
-  metadata.gz: 117da5cf73031dd539df2abf1a6c9f5cbf02060fc15ad475697bfe2a80decbcd0c7f5ee6e727cca28c69c820a2a3ce8fc8c1600969c49cad163df85e5a41cfc4
-  data.tar.gz: 4803e459d4c9a0136a156fe41cb4ad97b9d334a14ea1efcc9dce6fd268d5016f52c8850823d95d602ef6499f6301bb85291590679d0dde6d0d34989fa48e62e7
+  metadata.gz: 3e6fc759284b448c8a8311690e4f753f85ff2b354572be290193abdafcb1dcadeac2cd2c0151f62fd33a14fd8e9952a12fdf1c1bb355eaaf8eacde4eb9002ab1
+  data.tar.gz: a91523d4623fc41a98598b40bb3f621389cb81e3b992bcca1488105f25d98137ba7a4525b74b4bf266a1430704e9ff59e9e178a931f6fe81549dce3caf3ed7a3

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.16.0 (2024-11-08)
+------------------
+
+* Feature - AWS Control Catalog GetControl public API returns additional data in output, including Implementation and Parameters
+
 1.15.0 (2024-11-06)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.15.0
+1.16.0

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

@@ -483,6 +483,8 @@ module Aws::ControlCatalog
     #   * {Types::GetControlResponse#description #description} => String
     #   * {Types::GetControlResponse#behavior #behavior} => String
     #   * {Types::GetControlResponse#region_configuration #region_configuration} => Types::RegionConfiguration
+    #   * {Types::GetControlResponse#implementation #implementation} => Types::ImplementationDetails
+    #   * {Types::GetControlResponse#parameters #parameters} => Array<Types::ControlParameter>
     #
     # @example Request syntax with placeholder values
     #
@@ -499,6 +501,9 @@ module Aws::ControlCatalog
     #   resp.region_configuration.scope #=> String, one of "GLOBAL", "REGIONAL"
     #   resp.region_configuration.deployable_regions #=> Array
     #   resp.region_configuration.deployable_regions[0] #=> String
+    #   resp.implementation.type #=> String
+    #   resp.parameters #=> Array
+    #   resp.parameters[0].name #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/GetControl AWS API Documentation
     #
@@ -736,7 +741,7 @@ module Aws::ControlCatalog
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-controlcatalog'
-      context[:gem_version] = '1.15.0'
+      context[:gem_version] = '1.16.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-controlcatalog/client_api.rb

@@ -23,6 +23,8 @@ module Aws::ControlCatalog
     CommonControlSummaryList = Shapes::ListShape.new(name: 'CommonControlSummaryList')
     ControlArn = Shapes::StringShape.new(name: 'ControlArn')
     ControlBehavior = Shapes::StringShape.new(name: 'ControlBehavior')
+    ControlParameter = Shapes::StructureShape.new(name: 'ControlParameter')
+    ControlParameters = Shapes::ListShape.new(name: 'ControlParameters')
     ControlScope = Shapes::StringShape.new(name: 'ControlScope')
     ControlSummary = Shapes::StructureShape.new(name: 'ControlSummary')
     Controls = Shapes::ListShape.new(name: 'Controls')
@@ -34,6 +36,8 @@ module Aws::ControlCatalog
     DomainSummaryList = Shapes::ListShape.new(name: 'DomainSummaryList')
     GetControlRequest = Shapes::StructureShape.new(name: 'GetControlRequest')
     GetControlResponse = Shapes::StructureShape.new(name: 'GetControlResponse')
+    ImplementationDetails = Shapes::StructureShape.new(name: 'ImplementationDetails')
+    ImplementationType = Shapes::StringShape.new(name: 'ImplementationType')
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
     ListCommonControlsRequest = Shapes::StructureShape.new(name: 'ListCommonControlsRequest')
     ListCommonControlsResponse = Shapes::StructureShape.new(name: 'ListCommonControlsResponse')
@@ -87,6 +91,11 @@ module Aws::ControlCatalog
 
     CommonControlSummaryList.member = Shapes::ShapeRef.new(shape: CommonControlSummary)
 
+    ControlParameter.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Name"))
+    ControlParameter.struct_class = Types::ControlParameter
+
+    ControlParameters.member = Shapes::ShapeRef.new(shape: ControlParameter)
+
     ControlSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ControlArn, required: true, location_name: "Arn"))
     ControlSummary.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Name"))
     ControlSummary.add_member(:description, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Description"))
@@ -118,8 +127,13 @@ module Aws::ControlCatalog
     GetControlResponse.add_member(:description, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Description"))
     GetControlResponse.add_member(:behavior, Shapes::ShapeRef.new(shape: ControlBehavior, required: true, location_name: "Behavior"))
     GetControlResponse.add_member(:region_configuration, Shapes::ShapeRef.new(shape: RegionConfiguration, required: true, location_name: "RegionConfiguration"))
+    GetControlResponse.add_member(:implementation, Shapes::ShapeRef.new(shape: ImplementationDetails, location_name: "Implementation"))
+    GetControlResponse.add_member(:parameters, Shapes::ShapeRef.new(shape: ControlParameters, location_name: "Parameters"))
     GetControlResponse.struct_class = Types::GetControlResponse
 
+    ImplementationDetails.add_member(:type, Shapes::ShapeRef.new(shape: ImplementationType, required: true, location_name: "Type"))
+    ImplementationDetails.struct_class = Types::ImplementationDetails
+
     InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     InternalServerException.struct_class = Types::InternalServerException
 

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

@@ -124,6 +124,53 @@ module Aws::ControlCatalog
       include Aws::Structure
     end
 
+    # Four types of control parameters are supported.
+    #
+    # * **AllowedRegions**: List of Amazon Web Services Regions exempted
+    #   from the control. Each string is expected to be an Amazon Web
+    #   Services Region code. This parameter is mandatory for the **OU
+    #   Region deny** control, **CT.MULTISERVICE.PV.1**.
+    #
+    #   Example: `["us-east-1","us-west-2"]`
+    #
+    # * **ExemptedActions**: List of Amazon Web Services IAM actions
+    #   exempted from the control. Each string is expected to be an IAM
+    #   action.
+    #
+    #   Example:
+    #   `["logs:DescribeLogGroups","logs:StartQuery","logs:GetQueryResults"]`
+    #
+    # * **ExemptedPrincipalArns**: List of Amazon Web Services IAM principal
+    #   ARNs exempted from the control. Each string is expected to be an IAM
+    #   principal that follows the pattern
+    #   `^arn:(aws|aws-us-gov):(iam|sts)::.+:.+$`
+    #
+    #   Example:
+    #   `["arn:aws:iam::*:role/ReadOnly","arn:aws:sts::*:assumed-role/ReadOnly/*"]`
+    #
+    # * **ExemptedResourceArns**: List of resource ARNs exempted from the
+    #   control. Each string is expected to be a resource ARN.
+    #
+    #   Example: `["arn:aws:s3:::my-bucket-name"]`
+    #
+    # @!attribute [rw] name
+    #   The parameter name. This name is the parameter `key` when you call [
+    #   `EnableControl` ][1] or [ `UpdateEnabledControl` ][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableControl.html
+    #   [2]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledControl.html
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/ControlParameter AWS API Documentation
+    #
+    class ControlParameter < Struct.new(
+      :name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Overview of information about a control.
     #
     # @!attribute [rw] arn
@@ -237,13 +284,14 @@ module Aws::ControlCatalog
     #
     # @!attribute [rw] behavior
     #   A term that identifies the control's functional behavior. One of
-    #   `Preventive`, `Deteictive`, `Proactive`
+    #   `Preventive`, `Detective`, `Proactive`
     #   @return [String]
     #
     # @!attribute [rw] region_configuration
     #   Returns information about the control, including the scope of the
     #   control, if enabled, and the Regions in which the control currently
-    #   is available for deployment.
+    #   is available for deployment. For more information about scope, see
+    #   [Global services][1].
     #
     #   If you are applying controls through an Amazon Web Services Control
     #   Tower landing zone environment, remember that the values returned in
@@ -255,8 +303,23 @@ module Aws::ControlCatalog
     #   `REGIONAL` scope, even though you may not intend to deploy the
     #   control in Region `D`, because you do not govern it through your
     #   landing zone.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/global-services.html
     #   @return [Types::RegionConfiguration]
     #
+    # @!attribute [rw] implementation
+    #   Returns information about the control, as an `ImplementationDetails`
+    #   object that shows the underlying implementation type for a control.
+    #   @return [Types::ImplementationDetails]
+    #
+    # @!attribute [rw] parameters
+    #   Returns an array of `ControlParameter` objects that specify the
+    #   parameters a control supports. An empty list is returned for
+    #   controls that don’t support parameters.
+    #   @return [Array<Types::ControlParameter>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/GetControlResponse AWS API Documentation
     #
     class GetControlResponse < Struct.new(
@@ -264,7 +327,49 @@ module Aws::ControlCatalog
       :name,
       :description,
       :behavior,
-      :region_configuration)
+      :region_configuration,
+      :implementation,
+      :parameters)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # An object that describes the implementation type for a control.
+    #
+    # Our `ImplementationDetails` `Type` format has three required segments:
+    #
+    # * `SERVICE-PROVIDER::SERVICE-NAME::RESOURCE-NAME`
+    #
+    # ^
+    #
+    # For example, `AWS::Config::ConfigRule` **or**
+    # `AWS::SecurityHub::SecurityControl` resources have the format with
+    # three required segments.
+    #
+    # Our `ImplementationDetails` `Type` format has an optional fourth
+    # segment, which is present for applicable implementation types. The
+    # format is as follows:
+    #
+    # * `SERVICE-PROVIDER::SERVICE-NAME::RESOURCE-NAME::RESOURCE-TYPE-DESCRIPTION`
+    #
+    # ^
+    #
+    # For example, `AWS::Organizations::Policy::SERVICE_CONTROL_POLICY`
+    # **or** `AWS::CloudFormation::Type::HOOK` have the format with four
+    # segments.
+    #
+    # Although the format is similar, the values for the `Type` field do not
+    # match any Amazon Web Services CloudFormation values, and we do not use
+    # CloudFormation to implement these controls.
+    #
+    # @!attribute [rw] type
+    #   A string that describes a control's implementation type.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/ImplementationDetails AWS API Documentation
+    #
+    class ImplementationDetails < Struct.new(
+      :type)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -512,7 +617,8 @@ module Aws::ControlCatalog
 
     # Returns information about the control, including the scope of the
     # control, if enabled, and the Regions in which the control currently is
-    # available for deployment.
+    # available for deployment. For more information about scope, see
+    # [Global services][1].
     #
     # If you are applying controls through an Amazon Web Services Control
     # Tower landing zone environment, remember that the values returned in
@@ -524,6 +630,10 @@ module Aws::ControlCatalog
     # `REGIONAL` scope, even though you may not intend to deploy the control
     # in Region `D`, because you do not govern it through your landing zone.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/global-services.html
+    #
     # @!attribute [rw] scope
     #   The coverage of the control, if deployed. Scope is an enumerated
     #   type, with value `Regional`, or `Global`. A control with Global

data/lib/aws-sdk-controlcatalog.rb

@@ -55,7 +55,7 @@ module Aws::ControlCatalog
   autoload :EndpointProvider, 'aws-sdk-controlcatalog/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-controlcatalog/endpoints'
 
-  GEM_VERSION = '1.15.0'
+  GEM_VERSION = '1.16.0'
 
 end
 

data/sig/client.rbs

@@ -82,6 +82,8 @@ module Aws
         def description: () -> ::String
         def behavior: () -> ("PREVENTIVE" | "PROACTIVE" | "DETECTIVE")
         def region_configuration: () -> Types::RegionConfiguration
+        def implementation: () -> Types::ImplementationDetails
+        def parameters: () -> ::Array[Types::ControlParameter]
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ControlCatalog/Client.html#get_control-instance_method
       def get_control: (

data/sig/types.rbs

@@ -41,6 +41,11 @@ module Aws::ControlCatalog
       SENSITIVE: []
     end
 
+    class ControlParameter
+      attr_accessor name: ::String
+      SENSITIVE: []
+    end
+
     class ControlSummary
       attr_accessor arn: ::String
       attr_accessor name: ::String
@@ -73,6 +78,13 @@ module Aws::ControlCatalog
       attr_accessor description: ::String
       attr_accessor behavior: ("PREVENTIVE" | "PROACTIVE" | "DETECTIVE")
       attr_accessor region_configuration: Types::RegionConfiguration
+      attr_accessor implementation: Types::ImplementationDetails
+      attr_accessor parameters: ::Array[Types::ControlParameter]
+      SENSITIVE: []
+    end
+
+    class ImplementationDetails
+      attr_accessor type: ::String
       SENSITIVE: []
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-controlcatalog
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core