1---2name: aws-securityhub3description: AWS SecurityHub API skill. Use when working with AWS SecurityHub for administrator, master, automationrules. Covers 79 endpoints.4---5
6# AWS SecurityHub
7API version: 2018-10-26
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
172. GET /accounts -- verify access
183. POST /administrator -- create first administrator
19
20## Endpoints
21
2279 endpoints across 21 groups. See references/api-spec.lap for full details.
23
24### administrator
25| Method | Path | Description |
26|--------|------|-------------|
27| POST | /administrator | 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. |
28| POST | /administrator/disassociate | 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. |
29| GET | /administrator | 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. |
30
31### master
32| Method | Path | Description |
33|--------|------|-------------|
34| POST | /master | 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. |
35| POST | /master/disassociate | 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. |
36| GET | /master | 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. |
37
38### automationrules
39| Method | Path | Description |
40|--------|------|-------------|
41| POST | /automationrules/delete | Deletes one or more automation rules. |
42| POST | /automationrules/get | Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs). |
43| PATCH | /automationrules/update | Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters. |
44| POST | /automationrules/create | Creates an automation rule based on input parameters. |
45| GET | /automationrules/list | A list of automation rules and their metadata for the calling account. |
46
47### standards
48| Method | Path | Description |
49|--------|------|-------------|
50| POST | /standards/deregister | Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Security Standards section of the Security Hub User Guide. |
51| POST | /standards/register | 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. |
52| GET | /standards | Returns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description. |
53| GET | /standards/controls/{StandardsSubscriptionArn+} | 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. |
54| POST | /standards/get | Returns a list of the standards that are currently enabled. |
55| PATCH | /standards/control/{StandardsControlArn+} | Used to control whether an individual security standard control is enabled or disabled. |
56
57### configurationPolicyAssociation
58| Method | Path | Description |
59|--------|------|-------------|
60| POST | /configurationPolicyAssociation/batchget | 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. |
61| POST | /configurationPolicyAssociation/get | 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. |
62| POST | /configurationPolicyAssociation/list | 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. |
63| POST | /configurationPolicyAssociation/associate | 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. |
64| POST | /configurationPolicyAssociation/disassociate | 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. |
65
66### securityControls
67| Method | Path | Description |
68|--------|------|-------------|
69| POST | /securityControls/batchGet | Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region. |
70| GET | /securityControls/definitions | Lists all of the security controls that apply to a specified standard. |
71
72### associations
73| Method | Path | Description |
74|--------|------|-------------|
75| POST | /associations/batchGet | For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard. |
76| PATCH | /associations | For a batch of security controls and standards, this operation updates the enablement status of a control in a standard. |
77| GET | /associations | Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account. |
78
79### findings
80| Method | Path | Description |
81|--------|------|-------------|
82| POST | /findings/import | 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 the AwsAccountId 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. |
83| PATCH | /findings/batchupdate | 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. |
84| POST | /findings | 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. |
85| PATCH | /findings | UpdateFindings is a deprecated operation. Instead of UpdateFindings, use the BatchUpdateFindings operation. The UpdateFindings operation updates the Note and RecordState of the Security Hub aggregated findings that the filter attributes specify. Any member account that can view the finding can also see the update to the finding. Finding updates made with UpdateFindings aren't persisted if the same finding is later updated by the finding provider through the BatchImportFindings operation. In addition, Security Hub doesn't record updates made with UpdateFindings in the finding history. |
86
87### actionTargets
88| Method | Path | Description |
89|--------|------|-------------|
90| POST | /actionTargets | 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. |
91| DELETE | /actionTargets/{ActionTargetArn+} | 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. |
92| POST | /actionTargets/get | Returns a list of the custom action targets in Security Hub in your account. |
93| PATCH | /actionTargets/{ActionTargetArn+} | Updates the name and description of a custom action target in Security Hub. |
94
95### configurationPolicy
96| Method | Path | Description |
97|--------|------|-------------|
98| POST | /configurationPolicy/create | Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region. |
99| DELETE | /configurationPolicy/{Identifier} | 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 StartConfigurationPolicyDisassociation operation. |
100| GET | /configurationPolicy/get/{Identifier} | Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. |
101| GET | /configurationPolicy/list | 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. |
102| PATCH | /configurationPolicy/{Identifier} | Updates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. |
103
104### findingAggregator
105| Method | Path | Description |
106|--------|------|-------------|
107| POST | /findingAggregator/create | 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. |
108| DELETE | /findingAggregator/delete/{FindingAggregatorArn+} | 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. |
109| GET | /findingAggregator/get/{FindingAggregatorArn+} | Returns the current finding aggregation configuration. |
110| GET | /findingAggregator/list | If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region. |
111| PATCH | /findingAggregator/update | 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. |
112
113### insights
114| Method | Path | Description |
115|--------|------|-------------|
116| POST | /insights | 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. |
117| DELETE | /insights/{InsightArn+} | Deletes the insight specified by the InsightArn. |
118| GET | /insights/results/{InsightArn+} | Lists the results of the Security Hub insight specified by the insight ARN. |
119| POST | /insights/get | Lists and describes insights for the specified insight ARNs. |
120| PATCH | /insights/{InsightArn+} | Updates the Security Hub insight identified by the specified insight ARN. |
121
122### members
123| Method | Path | Description |
124|--------|------|-------------|
125| POST | /members | 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. |
126| POST | /members/delete | 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. |
127| POST | /members/disassociate | 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. |
128| POST | /members/get | 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. |
129| POST | /members/invite | 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. |
130| GET | /members | 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. |
131
132### invitations
133| Method | Path | Description |
134|--------|------|-------------|
135| POST | /invitations/decline | 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. |
136| POST | /invitations/delete | 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. |
137| GET | /invitations/count | Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation. |
138| GET | /invitations | 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. |
139
140### accounts
141| Method | Path | Description |
142|--------|------|-------------|
143| GET | /accounts | Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub. |
144| DELETE | /accounts | 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. |
145| POST | /accounts | 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. |
146| PATCH | /accounts | Updates configuration options for Security Hub. |
147
148### organization
149| Method | Path | Description |
150|--------|------|-------------|
151| GET | /organization/configuration | Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation. |
152| POST | /organization/admin/disable | Disables a Security Hub administrator account. Can only be called by the organization management account. |
153| POST | /organization/admin/enable | Designates the Security Hub administrator account for an organization. Can only be called by the organization management account. |
154| GET | /organization/admin | Lists the Security Hub administrator accounts. Can only be called by the organization management account. |
155| POST | /organization/configuration | Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation. |
156
157### products
158| Method | Path | Description |
159|--------|------|-------------|
160| GET | /products | Returns information about product integrations in Security Hub. You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration. If you do not provide an integration ARN, then the results include all of the available product integrations. |
161
162### productSubscriptions
163| Method | Path | Description |
164|--------|------|-------------|
165| DELETE | /productSubscriptions/{ProductSubscriptionArn+} | 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. |
166| POST | /productSubscriptions | 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. |
167| GET | /productSubscriptions | Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub. |
168
169### findingHistory
170| Method | Path | Description |
171|--------|------|-------------|
172| POST | /findingHistory/get | 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). |
173
174### securityControl
175| Method | Path | Description |
176|--------|------|-------------|
177| GET | /securityControl/definition | Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details. |
178| PATCH | /securityControl/update | Updates the properties of a security control. |
179
180### tags
181| Method | Path | Description |
182|--------|------|-------------|
183| GET | /tags/{ResourceArn} | Returns a list of tags associated with a resource. |
184| POST | /tags/{ResourceArn} | Adds one or more tags to a resource. |
185| DELETE | /tags/{ResourceArn} | Removes one or more tags from a resource. |
186
187## Common Questions
188
189Match user requests to endpoints in references/api-spec.lap. Key patterns:
190- "Create a administrator?" -> POST /administrator
191- "Create a master?" -> POST /master
192- "Create a delete?" -> POST /automationrules/delete
193- "Create a deregister?" -> POST /standards/deregister
194- "Create a register?" -> POST /standards/register
195- "Create a get?" -> POST /automationrules/get
196- "Create a batchget?" -> POST /configurationPolicyAssociation/batchget
197- "Create a batchGet?" -> POST /securityControls/batchGet
198- "Create a batchGet?" -> POST /associations/batchGet
199- "Create a import?" -> POST /findings/import
200- "Create a actionTarget?" -> POST /actionTargets
201- "Create a create?" -> POST /automationrules/create
202- "Create a create?" -> POST /configurationPolicy/create
203- "Create a create?" -> POST /findingAggregator/create
204- "Create a insight?" -> POST /insights
205- "Create a member?" -> POST /members
206- "Create a decline?" -> POST /invitations/decline
207- "Delete a actionTarget?" -> DELETE /actionTargets/{ActionTargetArn+}
208- "Delete a configurationPolicy?" -> DELETE /configurationPolicy/{Identifier}
209- "Delete a delete?" -> DELETE /findingAggregator/delete/{FindingAggregatorArn+}
210- "Delete a insight?" -> DELETE /insights/{InsightArn+}
211- "Create a delete?" -> POST /invitations/delete
212- "Create a delete?" -> POST /members/delete
213- "Create a get?" -> POST /actionTargets/get
214- "List all accounts?" -> GET /accounts
215- "List all configuration?" -> GET /organization/configuration
216- "List all products?" -> GET /products
217- "List all standards?" -> GET /standards
218- "Get control details?" -> GET /standards/controls/{StandardsSubscriptionArn+}
219- "Delete a productSubscription?" -> DELETE /productSubscriptions/{ProductSubscriptionArn+}
220- "Create a disable?" -> POST /organization/admin/disable
221- "Create a disassociate?" -> POST /administrator/disassociate
222- "Create a disassociate?" -> POST /master/disassociate
223- "Create a disassociate?" -> POST /members/disassociate
224- "Create a productSubscription?" -> POST /productSubscriptions
225- "Create a enable?" -> POST /organization/admin/enable
226- "Create a account?" -> POST /accounts
227- "List all administrator?" -> GET /administrator
228- "Get get details?" -> GET /configurationPolicy/get/{Identifier}
229- "Create a get?" -> POST /configurationPolicyAssociation/get
230- "Create a get?" -> POST /standards/get
231- "Get get details?" -> GET /findingAggregator/get/{FindingAggregatorArn+}
232- "Create a get?" -> POST /findingHistory/get
233- "Create a finding?" -> POST /findings
234- "Get result details?" -> GET /insights/results/{InsightArn+}
235- "Create a get?" -> POST /insights/get
236- "List all count?" -> GET /invitations/count
237- "List all master?" -> GET /master
238- "Create a get?" -> POST /members/get
239- "List all definition?" -> GET /securityControl/definition
240- "Create a invite?" -> POST /members/invite
241- "List all list?" -> GET /automationrules/list
242- "List all list?" -> GET /configurationPolicy/list
243- "Create a list?" -> POST /configurationPolicyAssociation/list
244- "List all productSubscriptions?" -> GET /productSubscriptions
245- "List all list?" -> GET /findingAggregator/list
246- "List all invitations?" -> GET /invitations
247- "List all members?" -> GET /members
248- "List all admin?" -> GET /organization/admin
249- "List all definitions?" -> GET /securityControls/definitions
250- "List all associations?" -> GET /associations
251- "Get tag details?" -> GET /tags/{ResourceArn}
252- "Create a associate?" -> POST /configurationPolicyAssociation/associate
253- "Create a disassociate?" -> POST /configurationPolicyAssociation/disassociate
254- "Delete a tag?" -> DELETE /tags/{ResourceArn}
255- "Partially update a actionTarget?" -> PATCH /actionTargets/{ActionTargetArn+}
256- "Partially update a configurationPolicy?" -> PATCH /configurationPolicy/{Identifier}
257- "Partially update a insight?" -> PATCH /insights/{InsightArn+}
258- "Create a configuration?" -> POST /organization/configuration
259- "Partially update a control?" -> PATCH /standards/control/{StandardsControlArn+}
260- "How to authenticate?" -> See Auth section
261
262## Response Tips
263- Check response schemas in references/api-spec.lap for field details
264- Create/update endpoints typically return the created/updated object
265
266## References
267- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
268
269> Generated from the official API spec by [LAP](https://lap.sh)
Lap-Platform