Class: Aws::SecurityHub::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SecurityHub::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb
Overview
An API client for SecurityHub. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SecurityHub::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_administrator_invitation(params = {}) ⇒ Struct
Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
-
#accept_invitation(params = {}) ⇒ Struct
This method is deprecated.
-
#batch_delete_automation_rules(params = {}) ⇒ Types::BatchDeleteAutomationRulesResponse
Deletes one or more automation rules.
-
#batch_disable_standards(params = {}) ⇒ Types::BatchDisableStandardsResponse
Disables the standards specified by the provided
StandardsSubscriptionArns
. -
#batch_enable_standards(params = {}) ⇒ Types::BatchEnableStandardsResponse
Enables the standards specified by the provided
StandardsArn
. -
#batch_get_automation_rules(params = {}) ⇒ Types::BatchGetAutomationRulesResponse
Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
-
#batch_get_configuration_policy_associations(params = {}) ⇒ Types::BatchGetConfigurationPolicyAssociationsResponse
Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root.
-
#batch_get_security_controls(params = {}) ⇒ Types::BatchGetSecurityControlsResponse
Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
-
#batch_get_standards_control_associations(params = {}) ⇒ Types::BatchGetStandardsControlAssociationsResponse
For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
-
#batch_import_findings(params = {}) ⇒ Types::BatchImportFindingsResponse
Imports security findings generated by a finding provider into Security Hub.
-
#batch_update_automation_rules(params = {}) ⇒ Types::BatchUpdateAutomationRulesResponse
Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
-
#batch_update_findings(params = {}) ⇒ Types::BatchUpdateFindingsResponse
Used by Security Hub customers to update information about their investigation into a finding.
-
#batch_update_standards_control_associations(params = {}) ⇒ Types::BatchUpdateStandardsControlAssociationsResponse
For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
-
#create_action_target(params = {}) ⇒ Types::CreateActionTargetResponse
Creates a custom action target in Security Hub.
-
#create_automation_rule(params = {}) ⇒ Types::CreateAutomationRuleResponse
Creates an automation rule based on input parameters.
-
#create_configuration_policy(params = {}) ⇒ Types::CreateConfigurationPolicyResponse
Creates a configuration policy with the defined configuration.
-
#create_finding_aggregator(params = {}) ⇒ Types::CreateFindingAggregatorResponse
Used to enable finding aggregation.
-
#create_insight(params = {}) ⇒ Types::CreateInsightResponse
Creates a custom insight in Security Hub.
-
#create_members(params = {}) ⇒ Types::CreateMembersResponse
Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account.
-
#decline_invitations(params = {}) ⇒ Types::DeclineInvitationsResponse
Declines invitations to become a member account.
-
#delete_action_target(params = {}) ⇒ Types::DeleteActionTargetResponse
Deletes a custom action target from Security Hub.
-
#delete_configuration_policy(params = {}) ⇒ Struct
Deletes a configuration policy.
-
#delete_finding_aggregator(params = {}) ⇒ Struct
Deletes a finding aggregator.
-
#delete_insight(params = {}) ⇒ Types::DeleteInsightResponse
Deletes the insight specified by the
InsightArn
. -
#delete_invitations(params = {}) ⇒ Types::DeleteInvitationsResponse
Deletes invitations received by the Amazon Web Services account to become a member account.
-
#delete_members(params = {}) ⇒ Types::DeleteMembersResponse
Deletes the specified member accounts from Security Hub.
-
#describe_action_targets(params = {}) ⇒ Types::DescribeActionTargetsResponse
Returns a list of the custom action targets in Security Hub in your account.
-
#describe_hub(params = {}) ⇒ Types::DescribeHubResponse
Returns details about the Hub resource in your account, including the
HubArn
and the time when you enabled Security Hub. -
#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse
Returns information about the way your organization is configured in Security Hub.
-
#describe_products(params = {}) ⇒ Types::DescribeProductsResponse
Returns information about product integrations in Security Hub.
-
#describe_standards(params = {}) ⇒ Types::DescribeStandardsResponse
Returns a list of the available standards in Security Hub.
-
#describe_standards_controls(params = {}) ⇒ Types::DescribeStandardsControlsResponse
Returns a list of security standards controls.
-
#disable_import_findings_for_product(params = {}) ⇒ Struct
Disables the integration of the specified product with Security Hub.
-
#disable_organization_admin_account(params = {}) ⇒ Struct
Disables a Security Hub administrator account.
-
#disable_security_hub(params = {}) ⇒ Struct
Disables Security Hub in your account only in the current Amazon Web Services Region.
-
#disassociate_from_administrator_account(params = {}) ⇒ Struct
Disassociates the current Security Hub member account from the associated administrator account.
-
#disassociate_from_master_account(params = {}) ⇒ Struct
This method is deprecated.
-
#disassociate_members(params = {}) ⇒ Struct
Disassociates the specified member accounts from the associated administrator account.
-
#enable_import_findings_for_product(params = {}) ⇒ Types::EnableImportFindingsForProductResponse
Enables the integration of a partner product with Security Hub.
-
#enable_organization_admin_account(params = {}) ⇒ Struct
Designates the Security Hub administrator account for an organization.
-
#enable_security_hub(params = {}) ⇒ Struct
Enables Security Hub for your account in the current Region or the Region you specify in the request.
-
#get_administrator_account(params = {}) ⇒ Types::GetAdministratorAccountResponse
Provides the details for the Security Hub administrator account for the current member account.
-
#get_configuration_policy(params = {}) ⇒ Types::GetConfigurationPolicyResponse
Provides information about a configuration policy.
-
#get_configuration_policy_association(params = {}) ⇒ Types::GetConfigurationPolicyAssociationResponse
Returns the association between a configuration and a target account, organizational unit, or the root.
-
#get_enabled_standards(params = {}) ⇒ Types::GetEnabledStandardsResponse
Returns a list of the standards that are currently enabled.
-
#get_finding_aggregator(params = {}) ⇒ Types::GetFindingAggregatorResponse
Returns the current finding aggregation configuration.
-
#get_finding_history(params = {}) ⇒ Types::GetFindingHistoryResponse
Returns history for a Security Hub finding in the last 90 days.
-
#get_findings(params = {}) ⇒ Types::GetFindingsResponse
Returns a list of findings that match the specified criteria.
-
#get_insight_results(params = {}) ⇒ Types::GetInsightResultsResponse
Lists the results of the Security Hub insight specified by the insight ARN.
-
#get_insights(params = {}) ⇒ Types::GetInsightsResponse
Lists and describes insights for the specified insight ARNs.
-
#get_invitations_count(params = {}) ⇒ Types::GetInvitationsCountResponse
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
-
#get_master_account(params = {}) ⇒ Types::GetMasterAccountResponse
This method is deprecated.
-
#get_members(params = {}) ⇒ Types::GetMembersResponse
Returns the details for the Security Hub member accounts for the specified account IDs.
-
#get_security_control_definition(params = {}) ⇒ Types::GetSecurityControlDefinitionResponse
Retrieves the definition of a security control.
-
#invite_members(params = {}) ⇒ Types::InviteMembersResponse
Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
-
#list_automation_rules(params = {}) ⇒ Types::ListAutomationRulesResponse
A list of automation rules and their metadata for the calling account.
-
#list_configuration_policies(params = {}) ⇒ Types::ListConfigurationPoliciesResponse
Lists the configuration policies that the Security Hub delegated administrator has created for your organization.
-
#list_configuration_policy_associations(params = {}) ⇒ Types::ListConfigurationPolicyAssociationsResponse
Provides information about the associations for your configuration policies and self-managed behavior.
-
#list_enabled_products_for_import(params = {}) ⇒ Types::ListEnabledProductsForImportResponse
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
-
#list_finding_aggregators(params = {}) ⇒ Types::ListFindingAggregatorsResponse
If finding aggregation is enabled, then
ListFindingAggregators
returns the ARN of the finding aggregator. -
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
-
#list_members(params = {}) ⇒ Types::ListMembersResponse
Lists details about all member accounts for the current Security Hub administrator account.
-
#list_organization_admin_accounts(params = {}) ⇒ Types::ListOrganizationAdminAccountsResponse
Lists the Security Hub administrator accounts.
-
#list_security_control_definitions(params = {}) ⇒ Types::ListSecurityControlDefinitionsResponse
Lists all of the security controls that apply to a specified standard.
-
#list_standards_control_associations(params = {}) ⇒ Types::ListStandardsControlAssociationsResponse
Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags associated with a resource.
-
#start_configuration_policy_association(params = {}) ⇒ Types::StartConfigurationPolicyAssociationResponse
Associates a target account, organizational unit, or the root with a specified configuration.
-
#start_configuration_policy_disassociation(params = {}) ⇒ Struct
Disassociates a target account, organizational unit, or the root from a specified configuration.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a resource.
-
#update_action_target(params = {}) ⇒ Struct
Updates the name and description of a custom action target in Security Hub.
-
#update_configuration_policy(params = {}) ⇒ Types::UpdateConfigurationPolicyResponse
Updates a configuration policy.
-
#update_finding_aggregator(params = {}) ⇒ Types::UpdateFindingAggregatorResponse
Updates the finding aggregation configuration.
-
#update_findings(params = {}) ⇒ Struct
UpdateFindings
is deprecated. -
#update_insight(params = {}) ⇒ Struct
Updates the Security Hub insight identified by the specified insight ARN.
-
#update_organization_configuration(params = {}) ⇒ Struct
Updates the configuration of your organization in Security Hub.
-
#update_security_control(params = {}) ⇒ Struct
Updates the properties of a security control.
-
#update_security_hub_configuration(params = {}) ⇒ Struct
Updates configuration options for Security Hub.
-
#update_standards_control(params = {}) ⇒ Struct
Used to control whether an individual security standard control is enabled or disabled.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#accept_administrator_invitation(params = {}) ⇒ Struct
Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
434 435 436 437 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 434 def accept_administrator_invitation(params = {}, = {}) req = build_request(:accept_administrator_invitation, params) req.send_request() end |
#accept_invitation(params = {}) ⇒ Struct
This method is deprecated. Instead, use
AcceptAdministratorInvitation
.
The Security Hub console continues to use AcceptInvitation
. It will
eventually change to use AcceptAdministratorInvitation
. Any IAM
policies that specifically control access to this function must
continue to use AcceptInvitation
. You should also add
AcceptAdministratorInvitation
to your policies to ensure that the
correct permissions are in place after the console begins to use
AcceptAdministratorInvitation
.
Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
481 482 483 484 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 481 def accept_invitation(params = {}, = {}) req = build_request(:accept_invitation, params) req.send_request() end |
#batch_delete_automation_rules(params = {}) ⇒ Types::BatchDeleteAutomationRulesResponse
Deletes one or more automation rules.
542 543 544 545 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 542 def batch_delete_automation_rules(params = {}, = {}) req = build_request(:batch_delete_automation_rules, params) req.send_request() end |
#batch_disable_standards(params = {}) ⇒ Types::BatchDisableStandardsResponse
Disables the standards specified by the provided
StandardsSubscriptionArns
.
For more information, see Security Standards section of the Security Hub User Guide.
608 609 610 611 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 608 def batch_disable_standards(params = {}, = {}) req = build_request(:batch_disable_standards, params) req.send_request() end |
#batch_enable_standards(params = {}) ⇒ Types::BatchEnableStandardsResponse
Enables the standards specified by the provided StandardsArn
. To
obtain the ARN for a standard, use the DescribeStandards
operation.
For more information, see the Security Standards section of the Security Hub User Guide.
684 685 686 687 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 684 def batch_enable_standards(params = {}, = {}) req = build_request(:batch_enable_standards, params) req.send_request() end |
#batch_get_automation_rules(params = {}) ⇒ Types::BatchGetAutomationRulesResponse
Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
972 973 974 975 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 972 def batch_get_automation_rules(params = {}, = {}) req = build_request(:batch_get_automation_rules, params) req.send_request() end |
#batch_get_configuration_policy_associations(params = {}) ⇒ Types::BatchGetConfigurationPolicyAssociationsResponse
Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed configuration.
1074 1075 1076 1077 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1074 def batch_get_configuration_policy_associations(params = {}, = {}) req = build_request(:batch_get_configuration_policy_associations, params) req.send_request() end |
#batch_get_security_controls(params = {}) ⇒ Types::BatchGetSecurityControlsResponse
Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
1188 1189 1190 1191 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1188 def batch_get_security_controls(params = {}, = {}) req = build_request(:batch_get_security_controls, params) req.send_request() end |
#batch_get_standards_control_associations(params = {}) ⇒ Types::BatchGetStandardsControlAssociationsResponse
For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1293 def batch_get_standards_control_associations(params = {}, = {}) req = build_request(:batch_get_standards_control_associations, params) req.send_request() end |
#batch_import_findings(params = {}) ⇒ Types::BatchImportFindingsResponse
Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.
BatchImportFindings
must be called by one of the following:
The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling
BatchImportFindings
from needs to be the same as theAwsAccountId
attribute for the finding.An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call
BatchImportFindings
from the allow-listed account and send findings from different customer accounts in the same batch.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created, BatchImportFindings
cannot be used to
update the following finding fields and objects, which Security Hub
customers use to manage their investigation workflow.
Note
UserDefinedFields
VerificationState
Workflow
Finding providers also should not use BatchImportFindings
to update
the following attributes.
Confidence
Criticality
RelatedFindings
Severity
Types
Instead, finding providers use FindingProviderFields
to provide
values for these attributes.
1425 1426 1427 1428 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1425 def batch_import_findings(params = {}, = {}) req = build_request(:batch_import_findings, params) req.send_request() end |
#batch_update_automation_rules(params = {}) ⇒ Types::BatchUpdateAutomationRulesResponse
Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
1788 1789 1790 1791 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1788 def batch_update_automation_rules(params = {}, = {}) req = build_request(:batch_update_automation_rules, params) req.send_request() end |
#batch_update_findings(params = {}) ⇒ Types::BatchUpdateFindingsResponse
Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from BatchUpdateFindings
do not affect the value of
UpdatedAt
for a finding.
Administrator and member accounts can use BatchUpdateFindings
to
update the following finding fields and objects.
Confidence
Criticality
Note
RelatedFindings
Severity
Types
UserDefinedFields
VerificationState
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
2020 2021 2022 2023 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2020 def batch_update_findings(params = {}, = {}) req = build_request(:batch_update_findings, params) req.send_request() end |
#batch_update_standards_control_associations(params = {}) ⇒ Types::BatchUpdateStandardsControlAssociationsResponse
For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
2102 2103 2104 2105 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2102 def batch_update_standards_control_associations(params = {}, = {}) req = build_request(:batch_update_standards_control_associations, params) req.send_request() end |
#create_action_target(params = {}) ⇒ Types::CreateActionTargetResponse
Creates a custom action target in Security Hub.
You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
2159 2160 2161 2162 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2159 def create_action_target(params = {}, = {}) req = build_request(:create_action_target, params) req.send_request() end |
#create_automation_rule(params = {}) ⇒ Types::CreateAutomationRuleResponse
Creates an automation rule based on input parameters.
2592 2593 2594 2595 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2592 def create_automation_rule(params = {}, = {}) req = build_request(:create_automation_rule, params) req.send_request() end |
#create_configuration_policy(params = {}) ⇒ Types::CreateConfigurationPolicyResponse
Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region.
2787 2788 2789 2790 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2787 def create_configuration_policy(params = {}, = {}) req = build_request(:create_configuration_policy, params) req.send_request() end |
#create_finding_aggregator(params = {}) ⇒ Types::CreateFindingAggregatorResponse
Used to enable finding aggregation. Must be called from the aggregation Region.
For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.
2887 2888 2889 2890 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2887 def create_finding_aggregator(params = {}, = {}) req = build_request(:create_finding_aggregator, params) req.send_request() end |
#create_insight(params = {}) ⇒ Types::CreateInsightResponse
Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.
To group the related findings in the insight, use the
GroupByAttribute
.
3658 3659 3660 3661 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3658 def create_insight(params = {}, = {}) req = build_request(:create_insight, params) req.send_request() end |
#create_members(params = {}) ⇒ Types::CreateMembersResponse
Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.
CreateMembers
is always used to add accounts that are not
organization members.
For accounts that are managed using Organizations, CreateMembers
is
only used in the following cases:
Security Hub is not configured to automatically add new organization accounts.
The account was disassociated or deleted in Security Hub.
This action can only be used by an account that has Security Hub
enabled. To enable Security Hub, you can use the EnableSecurityHub
operation.
For accounts that are not organization members, you create the account
association and then send an invitation to the member account. To send
the invitation, you use the InviteMembers
operation. If the account
owner accepts the invitation, the account becomes a member account in
Security Hub.
Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.
If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
A permissions policy is added that permits the administrator account to view the findings generated in the member account.
To remove the association between the administrator and member
accounts, use the DisassociateFromMasterAccount
or
DisassociateMembers
operation.
3765 3766 3767 3768 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3765 def create_members(params = {}, = {}) req = build_request(:create_members, params) req.send_request() end |
#decline_invitations(params = {}) ⇒ Types::DeclineInvitationsResponse
Declines invitations to become a member account.
A prospective member account uses this operation to decline an invitation to become a member.
This operation is only called by member accounts that aren't part of an organization. Organization accounts don't receive invitations.
3821 3822 3823 3824 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3821 def decline_invitations(params = {}, = {}) req = build_request(:decline_invitations, params) req.send_request() end |
#delete_action_target(params = {}) ⇒ Types::DeleteActionTargetResponse
Deletes a custom action target from Security Hub.
Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.
3869 3870 3871 3872 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3869 def delete_action_target(params = {}, = {}) req = build_request(:delete_action_target, params) req.send_request() end |
#delete_configuration_policy(params = {}) ⇒ Struct
Deletes a configuration policy. Only the Security Hub delegated
administrator can invoke this operation from the home Region. For the
deletion to succeed, you must first disassociate a configuration
policy from target accounts, organizational units, or the root by
invoking the StartConfigurationPolicyDisassociation
operation.
3905 3906 3907 3908 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3905 def delete_configuration_policy(params = {}, = {}) req = build_request(:delete_configuration_policy, params) req.send_request() end |
#delete_finding_aggregator(params = {}) ⇒ Struct
Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.
When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.
3944 3945 3946 3947 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3944 def delete_finding_aggregator(params = {}, = {}) req = build_request(:delete_finding_aggregator, params) req.send_request() end |
#delete_insight(params = {}) ⇒ Types::DeleteInsightResponse
Deletes the insight specified by the InsightArn
.
3986 3987 3988 3989 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3986 def delete_insight(params = {}, = {}) req = build_request(:delete_insight, params) req.send_request() end |
#delete_invitations(params = {}) ⇒ Types::DeleteInvitationsResponse
Deletes invitations received by the Amazon Web Services account to become a member account.
A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.
This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. Organization accounts don't receive invitations.
4044 4045 4046 4047 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4044 def delete_invitations(params = {}, = {}) req = build_request(:delete_invitations, params) req.send_request() end |
#delete_members(params = {}) ⇒ Types::DeleteMembersResponse
Deletes the specified member accounts from Security Hub.
You can invoke this API only to delete accounts that became members through invitation. You can't invoke this API to delete accounts that belong to an Organizations organization.
4097 4098 4099 4100 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4097 def delete_members(params = {}, = {}) req = build_request(:delete_members, params) req.send_request() end |
#describe_action_targets(params = {}) ⇒ Types::DescribeActionTargetsResponse
Returns a list of the custom action targets in Security Hub in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4171 4172 4173 4174 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4171 def describe_action_targets(params = {}, = {}) req = build_request(:describe_action_targets, params) req.send_request() end |
#describe_hub(params = {}) ⇒ Types::DescribeHubResponse
Returns details about the Hub resource in your account, including the
HubArn
and the time when you enabled Security Hub.
4224 4225 4226 4227 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4224 def describe_hub(params = {}, = {}) req = build_request(:describe_hub, params) req.send_request() end |
#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse
Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation.
4273 4274 4275 4276 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4273 def describe_organization_configuration(params = {}, = {}) req = build_request(:describe_organization_configuration, params) req.send_request() end |
#describe_products(params = {}) ⇒ Types::DescribeProductsResponse
Returns information about product integrations in Security Hub.
You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.
If you do not provide an integration ARN, then the results include all of the available product integrations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4373 4374 4375 4376 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4373 def describe_products(params = {}, = {}) req = build_request(:describe_products, params) req.send_request() end |
#describe_standards(params = {}) ⇒ Types::DescribeStandardsResponse
Returns a list of the available standards in Security Hub.
For each standard, the results include the standard ARN, the name, and a description.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4462 4463 4464 4465 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4462 def describe_standards(params = {}, = {}) req = build_request(:describe_standards, params) req.send_request() end |
#describe_standards_controls(params = {}) ⇒ Types::DescribeStandardsControlsResponse
Returns a list of security standards controls.
For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4570 4571 4572 4573 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4570 def describe_standards_controls(params = {}, = {}) req = build_request(:describe_standards_controls, params) req.send_request() end |
#disable_import_findings_for_product(params = {}) ⇒ Struct
Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.
4604 4605 4606 4607 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4604 def disable_import_findings_for_product(params = {}, = {}) req = build_request(:disable_import_findings_for_product, params) req.send_request() end |
#disable_organization_admin_account(params = {}) ⇒ Struct
Disables a Security Hub administrator account. Can only be called by the organization management account.
4638 4639 4640 4641 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4638 def disable_organization_admin_account(params = {}, = {}) req = build_request(:disable_organization_admin_account, params) req.send_request() end |
#disable_security_hub(params = {}) ⇒ Struct
Disables Security Hub in your account only in the current Amazon Web Services Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.
You can't disable Security Hub in an account that is currently the Security Hub administrator.
When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed.
If you want to save your existing findings, you must export them before you disable Security Hub.
4672 4673 4674 4675 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4672 def disable_security_hub(params = {}, = {}) req = build_request(:disable_security_hub, params) req.send_request() end |
#disassociate_from_administrator_account(params = {}) ⇒ Struct
Disassociates the current Security Hub member account from the associated administrator account.
This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
4698 4699 4700 4701 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4698 def disassociate_from_administrator_account(params = {}, = {}) req = build_request(:disassociate_from_administrator_account, params) req.send_request() end |
#disassociate_from_master_account(params = {}) ⇒ Struct
This method is deprecated. Instead, use
DisassociateFromAdministratorAccount
.
The Security Hub console continues to use
DisassociateFromMasterAccount
. It will eventually change to use
DisassociateFromAdministratorAccount
. Any IAM policies that
specifically control access to this function must continue to use
DisassociateFromMasterAccount
. You should also add
DisassociateFromAdministratorAccount
to your policies to ensure that
the correct permissions are in place after the console begins to use
DisassociateFromAdministratorAccount
.
Disassociates the current Security Hub member account from the associated administrator account.
This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
4728 4729 4730 4731 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4728 def disassociate_from_master_account(params = {}, = {}) req = build_request(:disassociate_from_master_account, params) req.send_request() end |
#disassociate_members(params = {}) ⇒ Struct
Disassociates the specified member accounts from the associated administrator account.
Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually.
4767 4768 4769 4770 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4767 def disassociate_members(params = {}, = {}) req = build_request(:disassociate_members, params) req.send_request() end |
#enable_import_findings_for_product(params = {}) ⇒ Types::EnableImportFindingsForProductResponse
Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub.
When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied.
4815 4816 4817 4818 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4815 def enable_import_findings_for_product(params = {}, = {}) req = build_request(:enable_import_findings_for_product, params) req.send_request() end |
#enable_organization_admin_account(params = {}) ⇒ Struct
Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.
4849 4850 4851 4852 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4849 def enable_organization_admin_account(params = {}, = {}) req = build_request(:enable_organization_admin_account, params) req.send_request() end |
#enable_security_hub(params = {}) ⇒ Struct
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 other services that are integrated with Security Hub.
When you use the EnableSecurityHub
operation to enable Security Hub,
you also automatically enable the following standards:
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
Amazon Web Services Foundational Security Best Practices
Other standards are not automatically enabled.
To opt out of automatically enabled standards, 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 the setup information in the Security Hub User Guide.
4942 4943 4944 4945 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4942 def enable_security_hub(params = {}, = {}) req = build_request(:enable_security_hub, params) req.send_request() end |
#get_administrator_account(params = {}) ⇒ Types::GetAdministratorAccountResponse
Provides the details for the Security Hub administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
4986 4987 4988 4989 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4986 def get_administrator_account(params = {}, = {}) req = build_request(:get_administrator_account, params) req.send_request() end |
#get_configuration_policy(params = {}) ⇒ Types::GetConfigurationPolicyResponse
Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
5096 5097 5098 5099 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5096 def get_configuration_policy(params = {}, = {}) req = build_request(:get_configuration_policy, params) req.send_request() end |
#get_configuration_policy_association(params = {}) ⇒ Types::GetConfigurationPolicyAssociationResponse
Returns the association between a configuration and a target account, organizational unit, or the root. The configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
5168 5169 5170 5171 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5168 def get_configuration_policy_association(params = {}, = {}) req = build_request(:get_configuration_policy_association, params) req.send_request() end |
#get_enabled_standards(params = {}) ⇒ Types::GetEnabledStandardsResponse
Returns a list of the standards that are currently enabled.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5245 5246 5247 5248 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5245 def get_enabled_standards(params = {}, = {}) req = build_request(:get_enabled_standards, params) req.send_request() end |
#get_finding_aggregator(params = {}) ⇒ Types::GetFindingAggregatorResponse
Returns the current finding aggregation configuration.
5301 5302 5303 5304 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5301 def get_finding_aggregator(params = {}, = {}) req = build_request(:get_finding_aggregator, params) req.send_request() end |
#get_finding_history(params = {}) ⇒ Types::GetFindingHistoryResponse
Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5481 5482 5483 5484 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5481 def get_finding_history(params = {}, = {}) req = build_request(:get_finding_history, params) req.send_request() end |
#get_findings(params = {}) ⇒ Types::GetFindingsResponse
Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call GetFindings
from the aggregation Region, the results include all of the matching
findings from both the aggregation Region and the linked Regions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6346 6347 6348 6349 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 6346 def get_findings(params = {}, = {}) req = build_request(:get_findings, params) req.send_request() end |
#get_insight_results(params = {}) ⇒ Types::GetInsightResultsResponse
Lists the results of the Security Hub insight specified by the insight ARN.
6406 6407 6408 6409 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 6406 def get_insight_results(params = {}, = {}) req = build_request(:get_insight_results, params) req.send_request() end |
#get_insights(params = {}) ⇒ Types::GetInsightsResponse
Lists and describes insights for the specified insight ARNs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6852 6853 6854 6855 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 6852 def get_insights(params = {}, = {}) req = build_request(:get_insights, params) req.send_request() end |
#get_invitations_count(params = {}) ⇒ Types::GetInvitationsCountResponse
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
6887 6888 6889 6890 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 6887 def get_invitations_count(params = {}, = {}) req = build_request(:get_invitations_count, params) req.send_request() end |
#get_master_account(params = {}) ⇒ Types::GetMasterAccountResponse
This method is deprecated. Instead, use GetAdministratorAccount
.
The Security Hub console continues to use GetMasterAccount
. It will
eventually change to use GetAdministratorAccount
. Any IAM policies
that specifically control access to this function must continue to use
GetMasterAccount
. You should also add GetAdministratorAccount
to
your policies to ensure that the correct permissions are in place
after the console begins to use GetAdministratorAccount
.
Provides the details for the Security Hub administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
6922 6923 6924 6925 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 6922 def get_master_account(params = {}, = {}) req = build_request(:get_master_account, params) req.send_request() end |
#get_members(params = {}) ⇒ Types::GetMembersResponse
Returns the details for the Security Hub member accounts for the specified account IDs.
An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually.
The results include both member accounts that are managed using Organizations and accounts that were invited manually.
7008 7009 7010 7011 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7008 def get_members(params = {}, = {}) req = build_request(:get_members, params) req.send_request() end |
#get_security_control_definition(params = {}) ⇒ Types::GetSecurityControlDefinitionResponse
Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.
7109 7110 7111 7112 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7109 def get_security_control_definition(params = {}, = {}) req = build_request(:get_security_control_definition, params) req.send_request() end |
#invite_members(params = {}) ⇒ Types::InviteMembersResponse
Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.
Before you can use this action to invite a member, you must first use
the CreateMembers
action to create the member account in Security
Hub.
When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
7173 7174 7175 7176 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7173 def invite_members(params = {}, = {}) req = build_request(:invite_members, params) req.send_request() end |
#list_automation_rules(params = {}) ⇒ Types::ListAutomationRulesResponse
A list of automation rules and their metadata for the calling account.
7257 7258 7259 7260 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7257 def list_automation_rules(params = {}, = {}) req = build_request(:list_automation_rules, params) req.send_request() end |
#list_configuration_policies(params = {}) ⇒ Types::ListConfigurationPoliciesResponse
Lists the configuration policies that the Security Hub delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7339 7340 7341 7342 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7339 def list_configuration_policies(params = {}, = {}) req = build_request(:list_configuration_policies, params) req.send_request() end |
#list_configuration_policy_associations(params = {}) ⇒ Types::ListConfigurationPolicyAssociationsResponse
Provides information about the associations for your configuration policies and self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7436 7437 7438 7439 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7436 def list_configuration_policy_associations(params = {}, = {}) req = build_request(:list_configuration_policy_associations, params) req.send_request() end |
#list_enabled_products_for_import(params = {}) ⇒ Types::ListEnabledProductsForImportResponse
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7497 7498 7499 7500 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7497 def list_enabled_products_for_import(params = {}, = {}) req = build_request(:list_enabled_products_for_import, params) req.send_request() end |
#list_finding_aggregators(params = {}) ⇒ Types::ListFindingAggregatorsResponse
If finding aggregation is enabled, then ListFindingAggregators
returns the ARN of the finding aggregator. You can run this operation
from any Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7555 7556 7557 7558 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7555 def list_finding_aggregators(params = {}, = {}) req = build_request(:list_finding_aggregators, params) req.send_request() end |
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7627 7628 7629 7630 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7627 def list_invitations(params = {}, = {}) req = build_request(:list_invitations, params) req.send_request() end |
#list_members(params = {}) ⇒ Types::ListMembersResponse
Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7723 7724 7725 7726 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7723 def list_members(params = {}, = {}) req = build_request(:list_members, params) req.send_request() end |
#list_organization_admin_accounts(params = {}) ⇒ Types::ListOrganizationAdminAccountsResponse
Lists the Security Hub administrator accounts. Can only be called by the organization management account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7787 7788 7789 7790 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7787 def list_organization_admin_accounts(params = {}, = {}) req = build_request(:list_organization_admin_accounts, params) req.send_request() end |
#list_security_control_definitions(params = {}) ⇒ Types::ListSecurityControlDefinitionsResponse
Lists all of the security controls that apply to a specified standard.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7920 7921 7922 7923 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 7920 def list_security_control_definitions(params = {}, = {}) req = build_request(:list_security_control_definitions, params) req.send_request() end |
#list_standards_control_associations(params = {}) ⇒ Types::ListStandardsControlAssociationsResponse
Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8024 8025 8026 8027 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 8024 def list_standards_control_associations(params = {}, = {}) req = build_request(:list_standards_control_associations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags associated with a resource.
8070 8071 8072 8073 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 8070 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_configuration_policy_association(params = {}) ⇒ Types::StartConfigurationPolicyAssociationResponse
Associates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
8148 8149 8150 8151 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 8148 def start_configuration_policy_association(params = {}, = {}) req = build_request(:start_configuration_policy_association, params) req.send_request() end |
#start_configuration_policy_disassociation(params = {}) ⇒ Struct
Disassociates a target account, organizational unit, or the root from a specified configuration. When you disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
8200 8201 8202 8203 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 8200 def start_configuration_policy_disassociation(params = {}, = {}) req = build_request(:start_configuration_policy_disassociation, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to a resource.
8243 8244 8245 8246 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 8243 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a resource.
8282 8283 8284 8285 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 8282 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_action_target(params = {}) ⇒ Struct
Updates the name and description of a custom action target in Security Hub.
8325 8326 8327 8328 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 8325 def update_action_target(params = {}, = {}) req = build_request(:update_action_target, params) req.send_request() end |
#update_configuration_policy(params = {}) ⇒ Types::UpdateConfigurationPolicyResponse
Updates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
8525 8526 8527 8528 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 8525 def update_configuration_policy(params = {}, = {}) req = build_request(:update_configuration_policy, params) req.send_request() end |
#update_finding_aggregator(params = {}) ⇒ Types::UpdateFindingAggregatorResponse
Updates the finding aggregation configuration. Used to update the
Region linking mode and the list of included or excluded Regions. You
cannot use UpdateFindingAggregator
to change the aggregation Region.
You must run UpdateFindingAggregator
from the current aggregation
Region.
8630 8631 8632 8633 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 8630 def update_finding_aggregator(params = {}, = {}) req = build_request(:update_finding_aggregator, params) req.send_request() end |
#update_findings(params = {}) ⇒ Struct
UpdateFindings
is deprecated. Instead of UpdateFindings
, use
BatchUpdateFindings
.
Updates the Note
and RecordState
of the Security Hub-aggregated
findings that the filter attributes specify. Any member account that
can view the finding also sees the update to the finding.
9364 9365 9366 9367 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 9364 def update_findings(params = {}, = {}) req = build_request(:update_findings, params) req.send_request() end |
#update_insight(params = {}) ⇒ Struct
Updates the Security Hub insight identified by the specified insight ARN.
10118 10119 10120 10121 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 10118 def update_insight(params = {}, = {}) req = build_request(:update_insight, params) req.send_request() end |
#update_organization_configuration(params = {}) ⇒ Struct
Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation.
10198 10199 10200 10201 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 10198 def update_organization_configuration(params = {}, = {}) req = build_request(:update_organization_configuration, params) req.send_request() end |
#update_security_control(params = {}) ⇒ Struct
Updates the properties of a security control.
10266 10267 10268 10269 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 10266 def update_security_control(params = {}, = {}) req = build_request(:update_security_control, params) req.send_request() end |
#update_security_hub_configuration(params = {}) ⇒ Struct
Updates configuration options for Security Hub.
10318 10319 10320 10321 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 10318 def update_security_hub_configuration(params = {}, = {}) req = build_request(:update_security_hub_configuration, params) req.send_request() end |
#update_standards_control(params = {}) ⇒ Struct
Used to control whether an individual security standard control is enabled or disabled.
10361 10362 10363 10364 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 10361 def update_standards_control(params = {}, = {}) req = build_request(:update_standards_control, params) req.send_request() end |