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
We recommend using Organizations instead of Security Hub invitations to manage your member accounts. -
#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
The aggregation Region is now called the home Region. -
#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
We recommend using Organizations instead of Security Hub invitations to manage your member accounts. -
#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
The aggregation Region is now called the home Region. -
#delete_insight(params = {}) ⇒ Types::DeleteInsightResponse
Deletes the insight specified by the
InsightArn
. -
#delete_invitations(params = {}) ⇒ Types::DeleteInvitationsResponse
We recommend using Organizations instead of Security Hub invitations to manage your member accounts. -
#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
The aggregation Region is now called the home Region. -
#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
We recommend using Organizations instead of Security Hub invitations to manage your member accounts. -
#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
We recommend using Organizations instead of Security Hub invitations to manage your member accounts. -
#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 cross-Region aggregation is enabled, then
ListFindingAggregators
returns the Amazon Resource Name (ARN) of the finding aggregator. -
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
We recommend using Organizations instead of Security Hub invitations to manage your member accounts. -
#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
The aggregation Region is now called the home Region. -
#update_findings(params = {}) ⇒ Struct
UpdateFindings
is a deprecated operation. -
#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.
444 445 446 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 444 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.
504 505 506 507 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 504 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.
551 552 553 554 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 551 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.
612 613 614 615 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 612 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.
678 679 680 681 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 678 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.
754 755 756 757 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 754 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).
1042 1043 1044 1045 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1042 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.
1144 1145 1146 1147 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1144 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.
1258 1259 1260 1261 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1258 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.
1363 1364 1365 1366 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1363 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.
1495 1496 1497 1498 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1495 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.
1858 1859 1860 1861 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1858 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
don't 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.
2090 2091 2092 2093 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2090 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.
2172 2173 2174 2175 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2172 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.
2229 2230 2231 2232 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2229 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.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2662 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.
2857 2858 2859 2860 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2857 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 cross-Region aggregation. This operation can be invoked from the home Region only.
For information about how cross-Region aggregation works, see Understanding cross-Region aggregation in Security Hub in the Security Hub User Guide.
2968 2969 2970 2971 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2968 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
.
3739 3740 3741 3742 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3739 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 don't 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.
3846 3847 3848 3849 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3846 def create_members(params = {}, = {}) req = build_request(:create_members, params) req.send_request() end |
#decline_invitations(params = {}) ⇒ Types::DeclineInvitationsResponse
Declines invitations to become a Security Hub member account.
A prospective member account uses this operation to decline an invitation to become a member.
Only member accounts that aren't part of an Amazon Web Services organization should use this operation. Organization accounts don't receive invitations.
3914 3915 3916 3917 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3914 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.
3962 3963 3964 3965 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3962 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.
3998 3999 4000 4001 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3998 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 cross-Region aggregation. Finding replication stops occurring from the linked Regions to the home Region.
When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region.
4042 4043 4044 4045 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4042 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
.
4084 4085 4086 4087 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4084 def delete_insight(params = {}, = {}) req = build_request(:delete_insight, params) req.send_request() end |
#delete_invitations(params = {}) ⇒ Types::DeleteInvitationsResponse
Deletes invitations to become a Security Hub member account.
A Security Hub administrator account can use this operation to delete invitations sent to one or more prospective member accounts.
This operation is only used to delete invitations that are sent to prospective member accounts that aren't part of an Amazon Web Services organization. Organization accounts don't receive invitations.
4153 4154 4155 4156 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4153 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.
4206 4207 4208 4209 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4206 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.
4280 4281 4282 4283 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4280 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.
4333 4334 4335 4336 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4333 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.
4382 4383 4384 4385 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4382 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 don't 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.
4482 4483 4484 4485 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4482 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.
4571 4572 4573 4574 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4571 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.
4679 4680 4681 4682 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4679 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.
4713 4714 4715 4716 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4713 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.
4747 4748 4749 4750 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4747 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.
4781 4782 4783 4784 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4781 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.
4807 4808 4809 4810 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4807 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.
4837 4838 4839 4840 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4837 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.
4876 4877 4878 4879 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4876 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.
4924 4925 4926 4927 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4924 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.
4958 4959 4960 4961 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4958 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.
5051 5052 5053 5054 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5051 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.
5095 5096 5097 5098 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5095 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.
5205 5206 5207 5208 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5205 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.
5277 5278 5279 5280 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5277 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.
5354 5355 5356 5357 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5354 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 configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions.
5416 5417 5418 5419 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5416 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.
5596 5597 5598 5599 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5596 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 cross-Region aggregation is enabled, then when you call
GetFindings
from the home Region, the results include all of the
matching findings from both the home Region and linked Regions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.