- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SecurityHubClient
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 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 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 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 . 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 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 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 .
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 section of the Security Hub User Guide.
The following throttling limits apply to 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.
Installation
npm install @aws-sdk/client-securityhub
yarn add @aws-sdk/client-securityhub
pnpm add @aws-sdk/client-securityhub
SecurityHubClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AcceptAdministratorInvitationCommand | We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. 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. |
AcceptInvitationCommand | This method is deprecated. Instead, use The Security Hub console continues to use 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. |
BatchDeleteAutomationRulesCommand | Deletes one or more automation rules. |
BatchDisableStandardsCommand | Disables the standards specified by the provided For more information, see Security Standards section of the Security Hub User Guide. |
BatchEnableStandardsCommand | Enables the standards specified by the provided For more information, see the Security Standards section of the Security Hub User Guide. |
BatchGetAutomationRulesCommand | Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs). |
BatchGetConfigurationPolicyAssociationsCommand | 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. |
BatchGetSecurityControlsCommand | Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region. |
BatchGetStandardsControlAssociationsCommand | For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard. Calls to this operation return a |
BatchImportFindingsCommand | 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.
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,
Finding providers also should not use
Instead, finding providers use |
BatchUpdateAutomationRulesCommand | Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters. |
BatchUpdateFindingsCommand | 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 Administrator and member accounts can use
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. |
BatchUpdateStandardsControlAssociationsCommand | For a batch of security controls and standards, this operation updates the enablement status of a control in a standard. |
CreateActionTargetCommand | 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. |
CreateAutomationRuleCommand | Creates an automation rule based on input parameters. |
CreateConfigurationPolicyCommand | Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region. |
CreateFindingAggregatorCommand | The aggregation Region is now called the home Region. Used to enable cross-Region aggregation. This operation can be invoked from the home Region only. For information about how cross-Region aggregation works, see Understanding cross-Region aggregation in Security Hub in the Security Hub User Guide. |
CreateInsightCommand | 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 |
CreateMembersCommand | 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. For accounts that are managed using Organizations,
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the 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 Accounts that are managed using Organizations don't receive an invitation. They automatically become a member account in Security Hub.
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 |
DeclineInvitationsCommand | We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. Declines invitations to become a Security Hub member account. A prospective member account uses this operation to decline an invitation to become a member. Only member accounts that aren't part of an Amazon Web Services organization should use this operation. Organization accounts don't receive invitations. |
DeleteActionTargetCommand | 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. |
DeleteConfigurationPolicyCommand | Deletes a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts, organizational units, or the root by invoking the |
DeleteFindingAggregatorCommand | The aggregation Region is now called the home Region. Deletes a finding aggregator. When you delete the finding aggregator, you stop cross-Region aggregation. Finding replication stops occurring from the linked Regions to the home Region. When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region. |
DeleteInsightCommand | Deletes the insight specified by the |
DeleteInvitationsCommand | We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. Deletes invitations to become a Security Hub member account. A Security Hub administrator account can use this operation to delete invitations sent to one or more prospective member accounts. This operation is only used to delete invitations that are sent to prospective member accounts that aren't part of an Amazon Web Services organization. Organization accounts don't receive invitations. |
DeleteMembersCommand | 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. |
DescribeActionTargetsCommand | Returns a list of the custom action targets in Security Hub in your account. |
DescribeHubCommand | Returns details about the Hub resource in your account, including the |
DescribeOrganizationConfigurationCommand | Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation. |
DescribeProductsCommand | Returns information about product integrations in Security Hub. You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration. If you don't provide an integration ARN, then the results include all of the available product integrations. |
DescribeStandardsCommand | Returns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description. |
DescribeStandardsControlsCommand | 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. This operation returns an empty list for standard subscriptions where |
DisableImportFindingsForProductCommand | 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. |
DisableOrganizationAdminAccountCommand | Disables a Security Hub administrator account. Can only be called by the organization management account. |
DisableSecurityHubCommand | 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. |
DisassociateFromAdministratorAccountCommand | 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. |
DisassociateFromMasterAccountCommand | This method is deprecated. Instead, use The Security Hub console continues to use 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. |
DisassociateMembersCommand | 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. |
EnableImportFindingsForProductCommand | 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. |
EnableOrganizationAdminAccountCommand | Designates the Security Hub administrator account for an organization. Can only be called by the organization management account. |
EnableSecurityHubCommand | 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
Other standards are not automatically enabled. To opt out of automatically enabled standards, set After you enable Security Hub, to enable a standard, use the To learn more, see the setup information in the Security Hub User Guide. |
GetAdministratorAccountCommand | 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. |
GetConfigurationPolicyAssociationCommand | Returns the association between a configuration and a target account, organizational unit, or the root. The configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region. |
GetConfigurationPolicyCommand | Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. |
GetEnabledStandardsCommand | Returns a list of the standards that are currently enabled. |
GetFindingAggregatorCommand | The aggregation Region is now called the home Region. Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions. |
GetFindingHistoryCommand | Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF). |
GetFindingsCommand | Returns a list of findings that match the specified criteria. If cross-Region aggregation is enabled, then when you call |
GetInsightResultsCommand | Lists the results of the Security Hub insight specified by the insight ARN. |
GetInsightsCommand | Lists and describes insights for the specified insight ARNs. |
GetInvitationsCountCommand | We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. Returns the count of all Security Hub membership invitations that were sent to the calling member account, not including the currently accepted invitation. |
GetMasterAccountCommand | This method is deprecated. Instead, use The Security Hub console continues to use 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. |
GetMembersCommand | 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. |
GetSecurityControlDefinitionCommand | Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details. |
InviteMembersCommand | We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. 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 don't belong to an Amazon Web Services organization. Organization accounts don't receive invitations. Before you can use this action to invite a member, you must first use the When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated in the member account. |
ListAutomationRulesCommand | A list of automation rules and their metadata for the calling account. |
ListConfigurationPoliciesCommand | 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. |
ListConfigurationPolicyAssociationsCommand | Provides information about the associations for your configuration policies and self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region. |
ListEnabledProductsForImportCommand | Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub. |
ListFindingAggregatorsCommand | If cross-Region aggregation is enabled, then |
ListInvitationsCommand | We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. Lists all Security Hub membership invitations that were sent to the calling account. Only accounts that are managed by invitation can use this operation. Accounts that are managed using the integration with Organizations don't receive invitations. |
ListMembersCommand | 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. |
ListOrganizationAdminAccountsCommand | Lists the Security Hub administrator accounts. Can only be called by the organization management account. |
ListSecurityControlDefinitionsCommand | Lists all of the security controls that apply to a specified standard. |
ListStandardsControlAssociationsCommand | Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account. This operation omits standards control associations for standard subscriptions where |
ListTagsForResourceCommand | Returns a list of tags associated with a resource. |
StartConfigurationPolicyAssociationCommand | Associates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region. |
StartConfigurationPolicyDisassociationCommand | 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. |
TagResourceCommand | Adds one or more tags to a resource. |
UntagResourceCommand | Removes one or more tags from a resource. |
UpdateActionTargetCommand | Updates the name and description of a custom action target in Security Hub. |
UpdateConfigurationPolicyCommand | Updates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. |
UpdateFindingAggregatorCommand | The aggregation Region is now called the home Region. Updates cross-Region aggregation settings. You can use this operation to update the Region linking mode and the list of included or excluded Amazon Web Services Regions. However, you can't use this operation to change the home Region. You can invoke this operation from the current home Region only. |
UpdateFindingsCommand | The Finding updates made with |
UpdateInsightCommand | Updates the Security Hub insight identified by the specified insight ARN. |
UpdateOrganizationConfigurationCommand | Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation. |
UpdateSecurityControlCommand | Updates the properties of a security control. |
UpdateSecurityHubConfigurationCommand | Updates configuration options for Security Hub. |
UpdateStandardsControlCommand | Used to control whether an individual security standard control is enabled or disabled. Calls to this operation return a |
SecurityHubClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SecurityHubClientConfig