View Source aws_securityhub (aws v1.0.4)
Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps you assess your Amazon Web Services environment against security industry standards and best practices.
Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and supported third-party products and helps you analyze your security trends and identify the highest priority security issues.
To help you manage the security state of your organization, Security Hub supports multiple security standards. These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services, and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes several security controls, each of which represents a security best practice. Security Hub runs checks against security controls and generates control findings to help you assess your compliance against security best practices.
In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services, such as Amazon GuardDuty and Amazon Inspector, and supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You can also send Security Hub findings to other Amazon Web Services and supported third-party products.
Security Hub offers automation features that help you triage and remediate security issues. For example, you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with Amazon EventBridge to trigger automatic responses to specific findings.
This guide, the Security Hub API Reference, provides information about the Security Hub API. This includes supported resources, HTTP methods, parameters, and schemas. If you're new to Security Hub, you might find it helpful to also review the Security Hub User Guide : https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html. The user guide explains key concepts and provides procedures that demonstrate how to use Security Hub features. It also provides information about topics such as integrating Security Hub with other Amazon Web Services.
In addition to interacting with Security Hub by making calls to the Security Hub API, you can use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell, Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to Security Hub and other Amazon Web Services . They also handle tasks such as signing requests, managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools and SDKs, see Tools to Build on Amazon Web Services: http://aws.amazon.com/developer/tools/.
With the exception of operations that are related to central configuration, Security Hub API 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, call the same API operation in each Region in which you want to apply the change. When you use central configuration, API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of central configuration operations, see the Central configuration terms and concepts: https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html#central-configuration-concepts section of the Security Hub User Guide.
The following throttling limits apply to Security Hub API operations.
BatchEnableStandards-RateLimitof 1 request per second.BurstLimitof 1 request per second.GetFindings-RateLimitof 3 requests per second.BurstLimitof 6 requests per second.BatchImportFindings-RateLimitof 10 requests per second.BurstLimitof 30 requests per second.BatchUpdateFindings-RateLimitof 10 requests per second.BurstLimitof 30 requests per second.UpdateStandardsControl-RateLimitof 1 request per second.BurstLimitof 5 requests per second.All other operations -
RateLimitof 10 requests per second.BurstLimitof 30 requests per second.
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.
Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root.
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.
Creates a custom action target in Security Hub.
Creates a configuration policy with the defined configuration.
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 configuration policy.
Deletes a finding aggregator.
InsightArn.Deletes invitations received by the Amazon Web Services account to become a member account.
Deletes the specified member accounts from Security Hub.
HubArn and the time when you enabled Security Hub.Returns information about the way your organization is configured in 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 Amazon Web Services 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.
Provides information about a configuration policy.
Returns the association between a configuration and a target account, organizational unit, or the root.
Returns history for a Security Hub finding in the last 90 days.
Returns a list of findings that match the specified criteria.
This method is deprecated.
Returns the details for the Security Hub member accounts for the specified account IDs.
Retrieves the definition of a security control.
Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
Lists the configuration policies that the Security Hub delegated administrator has created for your organization.
Provides information about the associations for your configuration policies and self-managed behavior.
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.
Associates a target account, organizational unit, or the root with a specified configuration.
Disassociates a target account, organizational unit, or the root from a specified configuration.
Updates a configuration policy.
Updates the finding aggregation configuration.
UpdateFindings is deprecated.
Updates the configuration of your organization in Security Hub.
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.
Enables the standards specified by the provided StandardsArn.
To obtain the ARN for a standard, use the DescribeStandards operation.
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.batch_get_configuration_policy_associations(Client, Input0, Options0)
View Sourcebatch_get_standards_control_associations(Client, Input0, Options0)
View SourceImports 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: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-custom-providers.html#securityhub-custom-providers-bfi-reqs 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
BatchImportFindingsfrom needs to be the same as theAwsAccountIdattribute 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
BatchImportFindingsfrom 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.
NoteUserDefinedFieldsVerificationStateWorkflow
Finding providers also should not use BatchImportFindings to update the following attributes.
ConfidenceCriticalityRelatedFindingsSeverityTypes
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.
ConfidenceCriticalityNoteRelatedFindingsSeverityTypesUserDefinedFieldsVerificationStateWorkflow
batch_update_standards_control_associations(Client, Input0, Options0)
View SourceCreates 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.Creates a configuration policy with the defined configuration.
Only the Security Hub delegated administrator can invoke this operation from the home Region.Used to enable finding aggregation.
Must be called from the aggregation Region.
For more details about cross-Region replication, see Configuring finding aggregation: https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html 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 theGroupByAttribute.
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 theDisassociateFromMasterAccount 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.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.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 theStartConfigurationPolicyDisassociation operation.
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.delete_finding_aggregator(Client, FindingAggregatorArn, Input0, Options0)
View SourceInsightArn.
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.
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.HubArn and the time when you enabled Security Hub.
Returns information about the way your organization is configured in Security Hub.
Only the Security Hub administrator account can invoke this operation.describe_organization_configuration(Client, QueryMap, HeadersMap, Options0)
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.Returns a list of the available standards in Security Hub.
For each standard, the results include the standard ARN, the name, and a description.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.describe_standards_controls(Client, StandardsSubscriptionArn, QueryMap, HeadersMap)
View Sourcedescribe_standards_controls(Client, StandardsSubscriptionArn, QueryMap, HeadersMap, Options0)
View Sourcedisable_import_findings_for_product(Client, ProductSubscriptionArn, Input)
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.disable_import_findings_for_product(Client, ProductSubscriptionArn, Input0, Options0)
View SourceDisables a Security Hub administrator account.
Can only be called by the organization management account.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.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.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.
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.Provides information about a configuration policy.
Only the Security Hub delegated administrator can invoke this operation from the home Region.get_configuration_policy(Client, Identifier, QueryMap, HeadersMap)
View Sourceget_configuration_policy(Client, Identifier, QueryMap, HeadersMap, Options0)
View SourceReturns 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.get_finding_aggregator(Client, FindingAggregatorArn, QueryMap, HeadersMap)
View Sourceget_finding_aggregator(Client, FindingAggregatorArn, QueryMap, HeadersMap, Options0)
View SourceReturns 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).Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you callGetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
get_insight_results(Client, InsightArn, QueryMap, HeadersMap, Options0)
View SourceThis 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.Retrieves the definition of a security control.
The definition includes the control title, description, Region availability, parameter definitions, and other details.get_security_control_definition(Client, SecurityControlId, QueryMap, HeadersMap)
View Sourceget_security_control_definition(Client, SecurityControlId, QueryMap, HeadersMap, Options0)
View SourceInvites 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.
Lists the configuration policies that the Security Hub delegated administrator has created for your organization.
Only the delegated administrator can invoke this operation from the home Region.list_configuration_policies(Client, QueryMap, HeadersMap, Options0)
View SourceProvides information about the associations for your configuration policies and self-managed behavior.
Only the Security Hub delegated administrator can invoke this operation from the home Region.list_enabled_products_for_import(Client, QueryMap, HeadersMap, Options0)
View SourceIf 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.
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.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.Lists the Security Hub administrator accounts.
Can only be called by the organization management account.list_organization_admin_accounts(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_security_control_definitions(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_standards_control_associations(Client, SecurityControlId, QueryMap, HeadersMap)
View Sourcelist_standards_control_associations(Client, SecurityControlId, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceAssociates a target account, organizational unit, or the root with a specified configuration.
The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.Disassociates a target account, organizational unit, or the root from a specified configuration.
When you disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.start_configuration_policy_disassociation(Client, Input0, Options0)
View SourceUpdates a configuration policy.
Only the Security Hub delegated administrator can invoke this operation from the home Region.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.
UpdateFindingAggregator from the current aggregation Region.
UpdateFindings is deprecated.
Instead of UpdateFindings, use BatchUpdateFindings.
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 configuration of your organization in Security Hub.
Only the Security Hub administrator account can invoke this operation.