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_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_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_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_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_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 Organizations configuration for 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 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_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_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.
-
#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_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.
-
#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_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
Used to update the configuration related to Organizations.
-
#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.
365 366 367 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 365 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.
402 403 404 405 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 402 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.
449 450 451 452 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 449 def accept_invitation(params = {}, = {}) req = build_request(:accept_invitation, 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.
491 492 493 494 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 491 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.
540 541 542 543 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 540 def batch_enable_standards(params = {}, = {}) req = build_request(:batch_enable_standards, 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.
583 584 585 586 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 583 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.
640 641 642 643 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 640 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.
726 727 728 729 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 726 def batch_import_findings(params = {}, = {}) req = build_request(:batch_import_findings, 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.
898 899 900 901 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 898 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.
941 942 943 944 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 941 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.
981 982 983 984 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 981 def create_action_target(params = {}, = {}) req = build_request(:create_action_target, 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.
1057 1058 1059 1060 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1057 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
.
1736 1737 1738 1739 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1736 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.
1820 1821 1822 1823 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1820 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.
1857 1858 1859 1860 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1857 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.
1889 1890 1891 1892 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1889 def delete_action_target(params = {}, = {}) req = build_request(:delete_action_target, 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.
1918 1919 1920 1921 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1918 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
.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1946 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.
1985 1986 1987 1988 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 1985 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.
Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.
2018 2019 2020 2021 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2018 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.
2069 2070 2071 2072 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2069 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.
2104 2105 2106 2107 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2104 def describe_hub(params = {}, = {}) req = build_request(:describe_hub, params) req.send_request() end |
#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse
Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.
2128 2129 2130 2131 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2128 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.
2191 2192 2193 2194 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2191 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.
2242 2243 2244 2245 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2242 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.
2305 2306 2307 2308 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2305 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.
2329 2330 2331 2332 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2329 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.
2353 2354 2355 2356 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2353 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 Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.
When you disable Security Hub for an administrator account, it doesn't disable Security Hub for any associated member accounts.
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.
2379 2380 2381 2382 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2379 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.
2397 2398 2399 2400 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2397 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.
2427 2428 2429 2430 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2427 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.
2454 2455 2456 2457 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2454 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.
2487 2488 2489 2490 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2487 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.
2511 2512 2513 2514 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2511 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.
2589 2590 2591 2592 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2589 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.
2615 2616 2617 2618 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2615 def get_administrator_account(params = {}, = {}) req = build_request(:get_administrator_account, 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.
2668 2669 2670 2671 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2668 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.
2704 2705 2706 2707 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 2704 def get_finding_aggregator(params = {}, = {}) req = build_request(:get_finding_aggregator, 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.
3398 3399 3400 3401 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3398 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.
3431 3432 3433 3434 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3431 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.
3800 3801 3802 3803 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3800 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.
3821 3822 3823 3824 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3821 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.
3856 3857 3858 3859 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3856 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.
3904 3905 3906 3907 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3904 def get_members(params = {}, = {}) req = build_request(:get_members, 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.
3948 3949 3950 3951 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3948 def invite_members(params = {}, = {}) req = build_request(:invite_members, 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.
3992 3993 3994 3995 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 3992 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.
4033 4034 4035 4036 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4033 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.
4084 4085 4086 4087 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4084 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.
4149 4150 4151 4152 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4149 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.
4192 4193 4194 4195 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4192 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.
4245 4246 4247 4248 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4245 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.
4305 4306 4307 4308 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4305 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.
4334 4335 4336 4337 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4334 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to a resource.
4364 4365 4366 4367 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4364 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.
4391 4392 4393 4394 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4391 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.
4422 4423 4424 4425 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4422 def update_action_target(params = {}, = {}) req = build_request(:update_action_target, 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.
4500 4501 4502 4503 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 4500 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.
5172 5173 5174 5175 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5172 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.
5840 5841 5842 5843 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5840 def update_insight(params = {}, = {}) req = build_request(:update_insight, params) req.send_request() end |
#update_organization_configuration(params = {}) ⇒ Struct
Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.
5886 5887 5888 5889 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5886 def update_organization_configuration(params = {}, = {}) req = build_request(:update_organization_configuration, params) req.send_request() end |
#update_security_hub_configuration(params = {}) ⇒ Struct
Updates configuration options for Security Hub.
5927 5928 5929 5930 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5927 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.
5959 5960 5961 5962 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/client.rb', line 5959 def update_standards_control(params = {}, = {}) req = build_request(:update_standards_control, params) req.send_request() end |