View Source AWS.SecurityHub (aws-elixir v0.13.3)
Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources.
It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the Security HubUser Guide.
When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, run the same command for each Region in which you want to apply the change.
For example, if your Region is set to us-west-2
, when you use CreateMembers
to add a member account to Security Hub, the association of the member account
with the administrator account is created only in the us-west-2
Region.
Security Hub must be enabled for the member account in the same Region that the
invitation was sent from.
The following throttling limits apply to using Security Hub API operations.
BatchEnableStandards
-RateLimit
of 1 request per second.BurstLimit
of 1 request per second.GetFindings
-RateLimit
of 3 requests per second.BurstLimit
of 6 requests per second.BatchImportFindings
-RateLimit
of 10 requests per second.BurstLimit
of 30 requests per second.BatchUpdateFindings
-RateLimit
of 10 requests per second.BurstLimit
of 30 requests per second.UpdateStandardsControl
-RateLimit
of 1 request per second.BurstLimit
of 5 requests per second.All other operations -
RateLimit
of 10 requests per second.BurstLimit
of 30 requests per second.
Link to this section Summary
Functions
Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
This method is deprecated.
Disables the standards specified by the provided StandardsSubscriptionArns
.
Enables the standards specified by the provided StandardsArn
.
Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
Imports security findings generated by a finding provider into Security Hub.
Used by Security Hub customers to update information about their investigation into a finding.
For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
Creates a custom action target in Security Hub.
Used to enable finding aggregation.
Creates a custom insight in Security Hub.
Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account.
Declines invitations to become a member account.
Deletes a custom action target from Security Hub.
Deletes a finding aggregator.
Deletes the insight specified by the InsightArn
.
Deletes invitations received by the Amazon Web Services account to become a member account.
Deletes the specified member accounts from Security Hub.
Returns a list of the custom action targets in Security Hub in your account.
Returns details about the Hub resource in your account, including the HubArn
and the time when you enabled Security Hub.
Returns information about the Organizations configuration for Security Hub.
Returns information about product integrations in Security Hub.
Returns a list of the available standards in Security Hub.
Returns a list of security standards controls.
Disables the integration of the specified product with Security Hub.
Disables a Security Hub administrator account.
Disables Security Hub in your account only in the current Region.
Disassociates the current Security Hub member account from the associated administrator account.
This method is deprecated.
Disassociates the specified member accounts from the associated administrator account.
Enables the integration of a partner product with Security Hub.
Designates the Security Hub administrator account for an organization.
Enables Security Hub for your account in the current Region or the Region you specify in the request.
Provides the details for the Security Hub administrator account for the current member account.
Returns a list of the standards that are currently enabled.
Returns the current finding aggregation configuration.
Returns a list of findings that match the specified criteria.
Lists the results of the Security Hub insight specified by the insight ARN.
Lists and describes insights for the specified insight ARNs.
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
This method is deprecated.
Returns the details for the Security Hub member accounts for the specified account IDs.
Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
If finding aggregation is enabled, then ListFindingAggregators
returns the ARN
of the finding aggregator.
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
Lists details about all member accounts for the current Security Hub administrator account.
Lists the Security Hub administrator accounts.
Lists all of the security controls that apply to a specified standard.
Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
Returns a list of tags associated with a resource.
Adds one or more tags to a resource.
Removes one or more tags from a resource.
Updates the name and description of a custom action target in Security Hub.
Updates the finding aggregation configuration.
UpdateFindings
is deprecated.
Updates the Security Hub insight identified by the specified insight ARN.
Used to update the configuration related to Organizations.
Updates configuration options for Security Hub.
Used to control whether an individual security standard control is enabled or disabled.
Link to this section Functions
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.
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.
Disables the standards specified by the provided StandardsSubscriptionArns
.
For more information, see Security Standards section of the Security Hub User Guide.
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.
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(client, input, options \\ [])
View SourceFor a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
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.
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.
batch_update_standards_control_associations(client, input, options \\ [])
View SourceFor a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
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.
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.
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
.
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.
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.
delete_action_target(client, action_target_arn, input, options \\ [])
View SourceDeletes 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.
delete_finding_aggregator(client, finding_aggregator_arn, input, options \\ [])
View SourceDeletes 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.
Deletes the insight specified by the InsightArn
.
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.
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.
Returns a list of the custom action targets in Security Hub in your account.
Returns details about the Hub resource in your account, including the HubArn
and the time when you enabled Security Hub.
Returns information about the Organizations configuration for Security Hub.
Can only be called from a Security Hub administrator account.
describe_products(client, max_results \\ nil, next_token \\ nil, product_arn \\ nil, options \\ [])
View SourceReturns 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.
describe_standards(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of the available standards in Security Hub.
For each standard, the results include the standard ARN, the name, and a description.
describe_standards_controls(client, standards_subscription_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns 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.
disable_import_findings_for_product(client, product_subscription_arn, input, options \\ [])
View SourceDisables 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.
Disables a Security Hub administrator account.
Can only be called by the organization management account.
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.
disassociate_from_administrator_account(client, input, options \\ [])
View SourceDisassociates 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.
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.
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.
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.
Designates the Security Hub administrator account for an organization.
Can only be called by the organization management account.
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.
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.
Returns a list of the standards that are currently enabled.
get_finding_aggregator(client, finding_aggregator_arn, options \\ [])
View SourceReturns the current finding aggregation configuration.
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.
Lists the results of the Security Hub insight specified by the insight ARN.
Lists and describes insights for the specified insight ARNs.
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
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.
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.
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.
list_enabled_products_for_import(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
list_finding_aggregators(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceIf finding aggregation is enabled, then ListFindingAggregators
returns the ARN
of the finding aggregator.
You can run this operation from any Region.
list_invitations(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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.
list_members(client, max_results \\ nil, next_token \\ nil, only_associated \\ nil, options \\ [])
View SourceLists 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.
list_organization_admin_accounts(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the Security Hub administrator accounts.
Can only be called by the organization management account.
list_security_control_definitions(client, max_results \\ nil, next_token \\ nil, standards_arn \\ nil, options \\ [])
View SourceLists all of the security controls that apply to a specified standard.
list_standards_control_associations(client, max_results \\ nil, next_token \\ nil, security_control_id, options \\ [])
View SourceSpecifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
Returns a list of tags associated with a resource.
Adds one or more tags to a resource.
Removes one or more tags from a resource.
update_action_target(client, action_target_arn, input, options \\ [])
View SourceUpdates the name and description of a custom action target in Security Hub.
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.
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.
Updates the Security Hub insight identified by the specified insight ARN.
Used to update the configuration related to Organizations.
Can only be called from a Security Hub administrator account.
Updates configuration options for Security Hub.
update_standards_control(client, standards_control_arn, input, options \\ [])
View SourceUsed to control whether an individual security standard control is enabled or disabled.