amazonaws.com – securityhub
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 .
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-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.
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:securityhub/2018-10-26.json
- Provider
- amazonaws.com:securityhub / securityhub
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/securityhub/2018-10-26/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/securityhub/2018-10-26/openapi.yaml
Tools (63)
Extracted live via the executor SDK.
-
accounts.describeHubReturns details about the Hub resource in your account, including the
HubArnand the time when you enabled Security Hub. -
accounts.disableSecurityHubDisables 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.
-
accounts.enableSecurityHubEnables 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
EnableSecurityHuboperation 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
EnableDefaultStandardstofalse.After you enable Security Hub, to enable a standard, use the
BatchEnableStandardsoperation. To disable a standard, use theBatchDisableStandardsoperation.To learn more, see the in the Security Hub User Guide.
-
-
accounts.updateSecurityHubConfigurationUpdates configuration options for Security Hub.
-
actionTargets.createActionTargetCreates 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.
-
actionTargets.deleteActionTargetDeletes 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.
-
actionTargets.describeActionTargetsReturns a list of the custom action targets in Security Hub in your account.
-
actionTargets.updateActionTargetUpdates the name and description of a custom action target in Security Hub.
-
administrator.acceptAdministratorInvitationAccepts 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.
-
administrator.disassociateFromAdministratorAccountDisassociates 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.
-
administrator.getAdministratorAccountProvides 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.
-
associations.batchGetStandardsControlAssociationsFor a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
-
associations.batchUpdateStandardsControlAssociationsFor a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
-
associationsSecurityControlId.listStandardsControlAssociationsSpecifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
-
findingAggregator.createFindingAggregatorUsed to enable finding aggregation. Must be called from the aggregation Region.
For more details about cross-Region replication, see in the Security Hub User Guide.
-
findingAggregator.deleteFindingAggregatorDeletes 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.
-
findingAggregator.getFindingAggregatorReturns the current finding aggregation configuration.
-
findingAggregator.listFindingAggregatorsIf finding aggregation is enabled, then
ListFindingAggregatorsreturns the ARN of the finding aggregator. You can run this operation from any Region. -
findingAggregator.updateFindingAggregatorUpdates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use
UpdateFindingAggregatorto change the aggregation Region.You must run
UpdateFindingAggregatorfrom the current aggregation Region. -
findings.batchImportFindingsImports 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.
BatchImportFindingsmust be called by one of the following:-
The Amazon Web Services account that is associated with a finding if you are using the 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,
BatchImportFindingscannot 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
BatchImportFindingsto update the following attributes.-
Confidence -
Criticality -
RelatedFindings -
Severity -
Types
Instead, finding providers use
FindingProviderFieldsto provide values for these attributes. -
-
findings.batchUpdateFindingsUsed 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
BatchUpdateFindingsdo not affect the value ofUpdatedAtfor a finding.Administrator and member accounts can use
BatchUpdateFindingsto 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 in the Security Hub User Guide.
-
-
findings.getFindingsReturns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindingsfrom the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions. -
findings.updateFindingsUpdateFindingsis deprecated. Instead ofUpdateFindings, useBatchUpdateFindings.Updates the
NoteandRecordStateof 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. -
insights.createInsightCreates 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. -
insights.deleteInsightDeletes the insight specified by the
InsightArn. -
insights.getInsightResultsLists the results of the Security Hub insight specified by the insight ARN.
-
insights.getInsightsLists and describes insights for the specified insight ARNs.
-
insights.updateInsightUpdates the Security Hub insight identified by the specified insight ARN.
-
invitations.declineInvitationsDeclines 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.
-
invitations.deleteInvitationsDeletes 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.
-
invitations.getInvitationsCountReturns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
-
invitations.listInvitationsLists 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.
-
master.acceptInvitationThis method is deprecated. Instead, use
AcceptAdministratorInvitation.The Security Hub console continues to use
AcceptInvitation. It will eventually change to useAcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to useAcceptInvitation. You should also addAcceptAdministratorInvitationto your policies to ensure that the correct permissions are in place after the console begins to useAcceptAdministratorInvitation.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.
-
master.disassociateFromMasterAccountThis method is deprecated. Instead, use
DisassociateFromAdministratorAccount.The Security Hub console continues to use
DisassociateFromMasterAccount. It will eventually change to useDisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to useDisassociateFromMasterAccount. You should also addDisassociateFromAdministratorAccountto your policies to ensure that the correct permissions are in place after the console begins to useDisassociateFromAdministratorAccount.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.
-
master.getMasterAccountThis method is deprecated. Instead, use
GetAdministratorAccount.The Security Hub console continues to use
GetMasterAccount. It will eventually change to useGetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to useGetMasterAccount. You should also addGetAdministratorAccountto your policies to ensure that the correct permissions are in place after the console begins to useGetAdministratorAccount.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.
-
members.createMembersCreates 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.
CreateMembersis always used to add accounts that are not organization members.For accounts that are managed using Organizations,
CreateMembersis 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
EnableSecurityHuboperation.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
InviteMembersoperation. 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
DisassociateFromMasterAccountorDisassociateMembersoperation. -
-
members.deleteMembersDeletes 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.
-
members.disassociateMembersDisassociates 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.
-
members.getMembersReturns 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.
-
members.inviteMembersInvites 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
CreateMembersaction 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.
-
members.listMembersLists 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.
-
organization.describeOrganizationConfigurationReturns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.
-
organization.disableOrganizationAdminAccountDisables a Security Hub administrator account. Can only be called by the organization management account.
-
organization.enableOrganizationAdminAccountDesignates the Security Hub administrator account for an organization. Can only be called by the organization management account.
-
organization.listOrganizationAdminAccountsLists the Security Hub administrator accounts. Can only be called by the organization management account.
-
organization.updateOrganizationConfigurationUsed to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.
-
products.describeProductsReturns 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.
-
productSubscriptions.disableImportFindingsForProductDisables 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.
-
productSubscriptions.enableImportFindingsForProductEnables 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.
-
productSubscriptions.listEnabledProductsForImportLists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
-
securityControls.batchGetSecurityControlsProvides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
-
securityControls.listSecurityControlDefinitionsLists all of the security controls that apply to a specified standard.
-
standards.batchDisableStandardsDisables the standards specified by the provided
StandardsSubscriptionArns.For more information, see section of the Security Hub User Guide.
-
standards.batchEnableStandardsEnables the standards specified by the provided
StandardsArn. To obtain the ARN for a standard, use theDescribeStandardsoperation.For more information, see the section of the Security Hub User Guide.
-
standards.describeStandardsReturns a list of the available standards in Security Hub.
For each standard, the results include the standard ARN, the name, and a description.
-
standards.describeStandardsControlsReturns 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.
-
standards.getEnabledStandardsReturns a list of the standards that are currently enabled.
-
standards.updateStandardsControlUsed to control whether an individual security standard control is enabled or disabled.
-
tags.listTagsForResourceReturns a list of tags associated with a resource.
-
tags.tagResourceAdds one or more tags to a resource.
-
tags.untagResourceRemoves one or more tags from a resource.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools