lib/aws-sdk-securityhub/client.rb in aws-sdk-securityhub-1.21.0 vs lib/aws-sdk-securityhub/client.rb in aws-sdk-securityhub-1.22.0

- old
+ new

@@ -267,12 +267,11 @@ # seconds to wait when opening a HTTP session before raising 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 yielded by {#session_for}. + # safely be set per-request on the session. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idle before it is # considered stale. Stale connections are closed and removed # from the pool before making a request. @@ -280,11 +279,11 @@ # @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 yielded by {#session_for}. + # request on the session. # # @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`, @@ -1015,12 +1014,14 @@ # One or more attributes used to filter the findings included in the # insight. The insight only includes findings that match the criteria # defined in the filters. # # @option params [required, String] :group_by_attribute - # The attribute used as the aggregator to group related findings for the - # insight. + # The attribute used to group the findings for the insight. The grouping + # attribute identifies the type of item that the insight applies to. For + # example, if an insight is grouped by resource identifier, then the + # insight produces a list of resource identifiers. # # @return [Types::CreateInsightResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateInsightResponse#insight_arn #insight_arn} => String # @@ -1829,10 +1830,12 @@ # @return [Types::DescribeActionTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeActionTargetsResponse#action_targets #action_targets} => Array&lt;Types::ActionTarget&gt; # * {Types::DescribeActionTargetsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_action_targets({ # action_target_arns: ["NonEmptyString"], # next_token: "NextToken", @@ -1906,10 +1909,12 @@ # @return [Types::DescribeProductsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeProductsResponse#products #products} => Array&lt;Types::Product&gt; # * {Types::DescribeProductsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_products({ # next_token: "NextToken", # max_results: 1, @@ -1960,10 +1965,12 @@ # @return [Types::DescribeStandardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeStandardsResponse#standards #standards} => Array&lt;Types::Standard&gt; # * {Types::DescribeStandardsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_standards({ # next_token: "NextToken", # max_results: 1, @@ -1973,10 +1980,11 @@ # # resp.standards #=> Array # resp.standards[0].standards_arn #=> String # resp.standards[0].name #=> String # resp.standards[0].description #=> String + # resp.standards[0].enabled_by_default #=> Boolean # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeStandards AWS API Documentation # # @overload describe_standards(params = {}) @@ -2011,10 +2019,12 @@ # @return [Types::DescribeStandardsControlsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeStandardsControlsResponse#controls #controls} => Array&lt;Types::StandardsControl&gt; # * {Types::DescribeStandardsControlsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_standards_controls({ # standards_subscription_arn: "NonEmptyString", # required # next_token: "NextToken", @@ -2169,38 +2179,49 @@ # Enables Security Hub for your account in the current Region or the # Region you specify in the request. # # When you enable Security Hub, you grant to Security Hub the - # permissions necessary to gather findings from AWS Config, Amazon - # GuardDuty, Amazon Inspector, and Amazon Macie. + # permissions necessary to gather findings from other services that are + # integrated with Security Hub. # # When you use the `EnableSecurityHub` operation to enable Security Hub, # you also automatically enable the CIS AWS Foundations standard. You do # not enable the Payment Card Industry Data Security Standard (PCI DSS) - # standard. To enable a standard, use the ` BatchEnableStandards ` - # operation. To disable a standard, use the ` BatchDisableStandards ` - # operation. + # standard. To not enable the CIS AWS Foundations standard, set + # `EnableDefaultStandards` to `false`. # + # After you enable Security Hub, to enable a standard, use the ` + # BatchEnableStandards ` operation. To disable a standard, use the ` + # BatchDisableStandards ` operation. + # # To learn more, see [Setting Up AWS Security Hub][1] in the *AWS # Security Hub User Guide*. # # # # [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html # # @option params [Hash<String,String>] :tags # The tags to add to the Hub resource when you enable Security Hub. # + # @option params [Boolean] :enable_default_standards + # Whether to enable the security standards that Security Hub has + # designated as automatically enabled. If you do not provide a value for + # `EnableDefaultStandards`, it is set to `true`. To not enable the + # automatically enabled standards, set `EnableDefaultStandards` to + # `false`. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.enable_security_hub({ # tags: { # "TagKey" => "TagValue", # }, + # enable_default_standards: false, # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/EnableSecurityHub AWS API Documentation # # @overload enable_security_hub(params = {}) @@ -2231,10 +2252,12 @@ # @return [Types::GetEnabledStandardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetEnabledStandardsResponse#standards_subscriptions #standards_subscriptions} => Array&lt;Types::StandardsSubscription&gt; # * {Types::GetEnabledStandardsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.get_enabled_standards({ # standards_subscription_arns: ["NonEmptyString"], # next_token: "NextToken", @@ -2283,10 +2306,12 @@ # @return [Types::GetFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetFindingsResponse#findings #findings} => Array&lt;Types::AwsSecurityFinding&gt; # * {Types::GetFindingsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.get_findings({ # filters: { # product_arn: [ @@ -3236,10 +3261,12 @@ # @return [Types::GetInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetInsightsResponse#insights #insights} => Array&lt;Types::Insight&gt; # * {Types::GetInsightsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.get_insights({ # insight_arns: ["NonEmptyString"], # next_token: "NextToken", @@ -3684,10 +3711,12 @@ # @return [Types::ListEnabledProductsForImportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListEnabledProductsForImportResponse#product_subscriptions #product_subscriptions} => Array&lt;String&gt; # * {Types::ListEnabledProductsForImportResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_enabled_products_for_import({ # next_token: "NextToken", # max_results: 1, @@ -3726,10 +3755,12 @@ # @return [Types::ListInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListInvitationsResponse#invitations #invitations} => Array&lt;Types::Invitation&gt; # * {Types::ListInvitationsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_invitations({ # max_results: 1, # next_token: "NextToken", @@ -3782,10 +3813,12 @@ # @return [Types::ListMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListMembersResponse#members #members} => Array&lt;Types::Member&gt; # * {Types::ListMembersResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_members({ # only_associated: false, # max_results: 1, @@ -5148,10 +5181,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-securityhub' - context[:gem_version] = '1.21.0' + context[:gem_version] = '1.22.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated