@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSSecurityHub extends Object implements AWSSecurityHub
AWSSecurityHub
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AcceptAdministratorInvitationResult |
acceptAdministratorInvitation(AcceptAdministratorInvitationRequest request)
Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the
invitation was sent from.
|
AcceptInvitationResult |
acceptInvitation(AcceptInvitationRequest request)
Deprecated.
|
BatchDeleteAutomationRulesResult |
batchDeleteAutomationRules(BatchDeleteAutomationRulesRequest request)
Deletes one or more automation rules.
|
BatchDisableStandardsResult |
batchDisableStandards(BatchDisableStandardsRequest request)
Disables the standards specified by the provided
StandardsSubscriptionArns . |
BatchEnableStandardsResult |
batchEnableStandards(BatchEnableStandardsRequest request)
Enables the standards specified by the provided
StandardsArn . |
BatchGetAutomationRulesResult |
batchGetAutomationRules(BatchGetAutomationRulesRequest request)
Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
|
BatchGetConfigurationPolicyAssociationsResult |
batchGetConfigurationPolicyAssociations(BatchGetConfigurationPolicyAssociationsRequest request)
Returns associations between an Security Hub configuration and a batch of target accounts, organizational units,
or the root.
|
BatchGetSecurityControlsResult |
batchGetSecurityControls(BatchGetSecurityControlsRequest request)
Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web
Services Region.
|
BatchGetStandardsControlAssociationsResult |
batchGetStandardsControlAssociations(BatchGetStandardsControlAssociationsRequest request)
For a batch of security controls and standards, identifies whether each control is currently enabled or disabled
in a standard.
|
BatchImportFindingsResult |
batchImportFindings(BatchImportFindingsRequest request)
Imports security findings generated by a finding provider into Security Hub.
|
BatchUpdateAutomationRulesResult |
batchUpdateAutomationRules(BatchUpdateAutomationRulesRequest request)
Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
|
BatchUpdateFindingsResult |
batchUpdateFindings(BatchUpdateFindingsRequest request)
Used by Security Hub customers to update information about their investigation into a finding.
|
BatchUpdateStandardsControlAssociationsResult |
batchUpdateStandardsControlAssociations(BatchUpdateStandardsControlAssociationsRequest request)
For a batch of security controls and standards, this operation updates the enablement status of a control in a
standard.
|
CreateActionTargetResult |
createActionTarget(CreateActionTargetRequest request)
Creates a custom action target in Security Hub.
|
CreateAutomationRuleResult |
createAutomationRule(CreateAutomationRuleRequest request)
Creates an automation rule based on input parameters.
|
CreateConfigurationPolicyResult |
createConfigurationPolicy(CreateConfigurationPolicyRequest request)
Creates a configuration policy with the defined configuration.
|
CreateFindingAggregatorResult |
createFindingAggregator(CreateFindingAggregatorRequest request)
Used to enable finding aggregation.
|
CreateInsightResult |
createInsight(CreateInsightRequest request)
Creates a custom insight in Security Hub.
|
CreateMembersResult |
createMembers(CreateMembersRequest request)
Creates a member association in Security Hub between the specified accounts and the account used to make the
request, which is the administrator account.
|
DeclineInvitationsResult |
declineInvitations(DeclineInvitationsRequest request)
Declines invitations to become a member account.
|
DeleteActionTargetResult |
deleteActionTarget(DeleteActionTargetRequest request)
Deletes a custom action target from Security Hub.
|
DeleteConfigurationPolicyResult |
deleteConfigurationPolicy(DeleteConfigurationPolicyRequest request)
Deletes a configuration policy.
|
DeleteFindingAggregatorResult |
deleteFindingAggregator(DeleteFindingAggregatorRequest request)
Deletes a finding aggregator.
|
DeleteInsightResult |
deleteInsight(DeleteInsightRequest request)
Deletes the insight specified by the
InsightArn . |
DeleteInvitationsResult |
deleteInvitations(DeleteInvitationsRequest request)
Deletes invitations received by the Amazon Web Services account to become a member account.
|
DeleteMembersResult |
deleteMembers(DeleteMembersRequest request)
Deletes the specified member accounts from Security Hub.
|
DescribeActionTargetsResult |
describeActionTargets(DescribeActionTargetsRequest request)
Returns a list of the custom action targets in Security Hub in your account.
|
DescribeHubResult |
describeHub(DescribeHubRequest request)
Returns details about the Hub resource in your account, including the
HubArn and the time when you
enabled Security Hub. |
DescribeOrganizationConfigurationResult |
describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest request)
Returns information about the way your organization is configured in Security Hub.
|
DescribeProductsResult |
describeProducts(DescribeProductsRequest request)
Returns information about product integrations in Security Hub.
|
DescribeStandardsResult |
describeStandards(DescribeStandardsRequest request)
Returns a list of the available standards in Security Hub.
|
DescribeStandardsControlsResult |
describeStandardsControls(DescribeStandardsControlsRequest request)
Returns a list of security standards controls.
|
DisableImportFindingsForProductResult |
disableImportFindingsForProduct(DisableImportFindingsForProductRequest request)
Disables the integration of the specified product with Security Hub.
|
DisableOrganizationAdminAccountResult |
disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest request)
Disables a Security Hub administrator account.
|
DisableSecurityHubResult |
disableSecurityHub(DisableSecurityHubRequest request)
Disables Security Hub in your account only in the current Amazon Web Services Region.
|
DisassociateFromAdministratorAccountResult |
disassociateFromAdministratorAccount(DisassociateFromAdministratorAccountRequest request)
Disassociates the current Security Hub member account from the associated administrator account.
|
DisassociateFromMasterAccountResult |
disassociateFromMasterAccount(DisassociateFromMasterAccountRequest request)
Deprecated.
|
DisassociateMembersResult |
disassociateMembers(DisassociateMembersRequest request)
Disassociates the specified member accounts from the associated administrator account.
|
EnableImportFindingsForProductResult |
enableImportFindingsForProduct(EnableImportFindingsForProductRequest request)
Enables the integration of a partner product with Security Hub.
|
EnableOrganizationAdminAccountResult |
enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest request)
Designates the Security Hub administrator account for an organization.
|
EnableSecurityHubResult |
enableSecurityHub(EnableSecurityHubRequest request)
Enables Security Hub for your account in the current Region or the Region you specify in the request.
|
GetAdministratorAccountResult |
getAdministratorAccount(GetAdministratorAccountRequest request)
Provides the details for the Security Hub administrator account for the current member account.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetConfigurationPolicyResult |
getConfigurationPolicy(GetConfigurationPolicyRequest request)
Provides information about a configuration policy.
|
GetConfigurationPolicyAssociationResult |
getConfigurationPolicyAssociation(GetConfigurationPolicyAssociationRequest request)
Returns the association between a configuration and a target account, organizational unit, or the root.
|
GetEnabledStandardsResult |
getEnabledStandards(GetEnabledStandardsRequest request)
Returns a list of the standards that are currently enabled.
|
GetFindingAggregatorResult |
getFindingAggregator(GetFindingAggregatorRequest request)
Returns the current finding aggregation configuration.
|
GetFindingHistoryResult |
getFindingHistory(GetFindingHistoryRequest request)
Returns history for a Security Hub finding in the last 90 days.
|
GetFindingsResult |
getFindings(GetFindingsRequest request)
Returns a list of findings that match the specified criteria.
|
GetInsightResultsResult |
getInsightResults(GetInsightResultsRequest request)
Lists the results of the Security Hub insight specified by the insight ARN.
|
GetInsightsResult |
getInsights(GetInsightsRequest request)
Lists and describes insights for the specified insight ARNs.
|
GetInvitationsCountResult |
getInvitationsCount(GetInvitationsCountRequest request)
Returns the count of all Security Hub membership invitations that were sent to the current member account, not
including the currently accepted invitation.
|
GetMasterAccountResult |
getMasterAccount(GetMasterAccountRequest request)
Deprecated.
|
GetMembersResult |
getMembers(GetMembersRequest request)
Returns the details for the Security Hub member accounts for the specified account IDs.
|
GetSecurityControlDefinitionResult |
getSecurityControlDefinition(GetSecurityControlDefinitionRequest request)
Retrieves the definition of a security control.
|
InviteMembersResult |
inviteMembers(InviteMembersRequest request)
Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account
that the invitation is sent from.
|
ListAutomationRulesResult |
listAutomationRules(ListAutomationRulesRequest request)
A list of automation rules and their metadata for the calling account.
|
ListConfigurationPoliciesResult |
listConfigurationPolicies(ListConfigurationPoliciesRequest request)
Lists the configuration policies that the Security Hub delegated administrator has created for your organization.
|
ListConfigurationPolicyAssociationsResult |
listConfigurationPolicyAssociations(ListConfigurationPolicyAssociationsRequest request)
Provides information about the associations for your configuration policies and self-managed behavior.
|
ListEnabledProductsForImportResult |
listEnabledProductsForImport(ListEnabledProductsForImportRequest request)
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security
Hub.
|
ListFindingAggregatorsResult |
listFindingAggregators(ListFindingAggregatorsRequest request)
If finding aggregation is enabled, then
ListFindingAggregators returns the ARN of the finding
aggregator. |
ListInvitationsResult |
listInvitations(ListInvitationsRequest request)
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
|
ListMembersResult |
listMembers(ListMembersRequest request)
Lists details about all member accounts for the current Security Hub administrator account.
|
ListOrganizationAdminAccountsResult |
listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest request)
Lists the Security Hub administrator accounts.
|
ListSecurityControlDefinitionsResult |
listSecurityControlDefinitions(ListSecurityControlDefinitionsRequest request)
Lists all of the security controls that apply to a specified standard.
|
ListStandardsControlAssociationsResult |
listStandardsControlAssociations(ListStandardsControlAssociationsRequest request)
Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags associated with a resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartConfigurationPolicyAssociationResult |
startConfigurationPolicyAssociation(StartConfigurationPolicyAssociationRequest request)
Associates a target account, organizational unit, or the root with a specified configuration.
|
StartConfigurationPolicyDisassociationResult |
startConfigurationPolicyDisassociation(StartConfigurationPolicyDisassociationRequest request)
Disassociates a target account, organizational unit, or the root from a specified configuration.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from a resource.
|
UpdateActionTargetResult |
updateActionTarget(UpdateActionTargetRequest request)
Updates the name and description of a custom action target in Security Hub.
|
UpdateConfigurationPolicyResult |
updateConfigurationPolicy(UpdateConfigurationPolicyRequest request)
Updates a configuration policy.
|
UpdateFindingAggregatorResult |
updateFindingAggregator(UpdateFindingAggregatorRequest request)
Updates the finding aggregation configuration.
|
UpdateFindingsResult |
updateFindings(UpdateFindingsRequest request)
UpdateFindings is a deprecated operation. |
UpdateInsightResult |
updateInsight(UpdateInsightRequest request)
Updates the Security Hub insight identified by the specified insight ARN.
|
UpdateOrganizationConfigurationResult |
updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest request)
Updates the configuration of your organization in Security Hub.
|
UpdateSecurityControlResult |
updateSecurityControl(UpdateSecurityControlRequest request)
Updates the properties of a security control.
|
UpdateSecurityHubConfigurationResult |
updateSecurityHubConfiguration(UpdateSecurityHubConfigurationRequest request)
Updates configuration options for Security Hub.
|
UpdateStandardsControlResult |
updateStandardsControl(UpdateStandardsControlRequest request)
Used to control whether an individual security standard control is enabled or disabled.
|
public AcceptAdministratorInvitationResult acceptAdministratorInvitation(AcceptAdministratorInvitationRequest request)
AWSSecurityHub
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.
acceptAdministratorInvitation
in interface AWSSecurityHub
@Deprecated public AcceptInvitationResult acceptInvitation(AcceptInvitationRequest request)
AWSSecurityHub
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.
acceptInvitation
in interface AWSSecurityHub
public BatchDeleteAutomationRulesResult batchDeleteAutomationRules(BatchDeleteAutomationRulesRequest request)
AWSSecurityHub
Deletes one or more automation rules.
batchDeleteAutomationRules
in interface AWSSecurityHub
public BatchDisableStandardsResult batchDisableStandards(BatchDisableStandardsRequest request)
AWSSecurityHub
Disables the standards specified by the provided StandardsSubscriptionArns
.
For more information, see Security Standards section of the Security Hub User Guide.
batchDisableStandards
in interface AWSSecurityHub
public BatchEnableStandardsResult batchEnableStandards(BatchEnableStandardsRequest request)
AWSSecurityHub
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.
batchEnableStandards
in interface AWSSecurityHub
public BatchGetAutomationRulesResult batchGetAutomationRules(BatchGetAutomationRulesRequest request)
AWSSecurityHub
Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
batchGetAutomationRules
in interface AWSSecurityHub
public BatchGetConfigurationPolicyAssociationsResult batchGetConfigurationPolicyAssociations(BatchGetConfigurationPolicyAssociationsRequest request)
AWSSecurityHub
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.
batchGetConfigurationPolicyAssociations
in interface AWSSecurityHub
public BatchGetSecurityControlsResult batchGetSecurityControls(BatchGetSecurityControlsRequest request)
AWSSecurityHub
Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
batchGetSecurityControls
in interface AWSSecurityHub
public BatchGetStandardsControlAssociationsResult batchGetStandardsControlAssociations(BatchGetStandardsControlAssociationsRequest request)
AWSSecurityHub
For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
batchGetStandardsControlAssociations
in interface AWSSecurityHub
public BatchImportFindingsResult batchImportFindings(BatchImportFindingsRequest request)
AWSSecurityHub
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.
batchImportFindings
in interface AWSSecurityHub
public BatchUpdateAutomationRulesResult batchUpdateAutomationRules(BatchUpdateAutomationRulesRequest request)
AWSSecurityHub
Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
batchUpdateAutomationRules
in interface AWSSecurityHub
public BatchUpdateFindingsResult batchUpdateFindings(BatchUpdateFindingsRequest request)
AWSSecurityHub
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.
batchUpdateFindings
in interface AWSSecurityHub
public BatchUpdateStandardsControlAssociationsResult batchUpdateStandardsControlAssociations(BatchUpdateStandardsControlAssociationsRequest request)
AWSSecurityHub
For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
batchUpdateStandardsControlAssociations
in interface AWSSecurityHub
public CreateActionTargetResult createActionTarget(CreateActionTargetRequest request)
AWSSecurityHub
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.
createActionTarget
in interface AWSSecurityHub
public CreateAutomationRuleResult createAutomationRule(CreateAutomationRuleRequest request)
AWSSecurityHub
Creates an automation rule based on input parameters.
createAutomationRule
in interface AWSSecurityHub
public CreateConfigurationPolicyResult createConfigurationPolicy(CreateConfigurationPolicyRequest request)
AWSSecurityHub
Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region.
createConfigurationPolicy
in interface AWSSecurityHub
public CreateFindingAggregatorResult createFindingAggregator(CreateFindingAggregatorRequest request)
AWSSecurityHub
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.
createFindingAggregator
in interface AWSSecurityHub
public CreateInsightResult createInsight(CreateInsightRequest request)
AWSSecurityHub
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
.
createInsight
in interface AWSSecurityHub
public CreateMembersResult createMembers(CreateMembersRequest request)
AWSSecurityHub
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.
createMembers
in interface AWSSecurityHub
public DeclineInvitationsResult declineInvitations(DeclineInvitationsRequest request)
AWSSecurityHub
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.
declineInvitations
in interface AWSSecurityHub
public DeleteActionTargetResult deleteActionTarget(DeleteActionTargetRequest request)
AWSSecurityHub
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.
deleteActionTarget
in interface AWSSecurityHub
public DeleteConfigurationPolicyResult deleteConfigurationPolicy(DeleteConfigurationPolicyRequest request)
AWSSecurityHub
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.
deleteConfigurationPolicy
in interface AWSSecurityHub
public DeleteFindingAggregatorResult deleteFindingAggregator(DeleteFindingAggregatorRequest request)
AWSSecurityHub
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.
deleteFindingAggregator
in interface AWSSecurityHub
public DeleteInsightResult deleteInsight(DeleteInsightRequest request)
AWSSecurityHub
Deletes the insight specified by the InsightArn
.
deleteInsight
in interface AWSSecurityHub
public DeleteInvitationsResult deleteInvitations(DeleteInvitationsRequest request)
AWSSecurityHub
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.
deleteInvitations
in interface AWSSecurityHub
public DeleteMembersResult deleteMembers(DeleteMembersRequest request)
AWSSecurityHub
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.
deleteMembers
in interface AWSSecurityHub
public DescribeActionTargetsResult describeActionTargets(DescribeActionTargetsRequest request)
AWSSecurityHub
Returns a list of the custom action targets in Security Hub in your account.
describeActionTargets
in interface AWSSecurityHub
public DescribeHubResult describeHub(DescribeHubRequest request)
AWSSecurityHub
Returns details about the Hub resource in your account, including the HubArn
and the time when you
enabled Security Hub.
describeHub
in interface AWSSecurityHub
public DescribeOrganizationConfigurationResult describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest request)
AWSSecurityHub
Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation.
describeOrganizationConfiguration
in interface AWSSecurityHub
public DescribeProductsResult describeProducts(DescribeProductsRequest request)
AWSSecurityHub
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.
describeProducts
in interface AWSSecurityHub
public DescribeStandardsResult describeStandards(DescribeStandardsRequest request)
AWSSecurityHub
Returns a list of the available standards in Security Hub.
For each standard, the results include the standard ARN, the name, and a description.
describeStandards
in interface AWSSecurityHub
public DescribeStandardsControlsResult describeStandardsControls(DescribeStandardsControlsRequest request)
AWSSecurityHub
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.
describeStandardsControls
in interface AWSSecurityHub
public DisableImportFindingsForProductResult disableImportFindingsForProduct(DisableImportFindingsForProductRequest request)
AWSSecurityHub
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.
disableImportFindingsForProduct
in interface AWSSecurityHub
public DisableOrganizationAdminAccountResult disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest request)
AWSSecurityHub
Disables a Security Hub administrator account. Can only be called by the organization management account.
disableOrganizationAdminAccount
in interface AWSSecurityHub
public DisableSecurityHubResult disableSecurityHub(DisableSecurityHubRequest request)
AWSSecurityHub
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.
disableSecurityHub
in interface AWSSecurityHub
public DisassociateFromAdministratorAccountResult disassociateFromAdministratorAccount(DisassociateFromAdministratorAccountRequest request)
AWSSecurityHub
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.
disassociateFromAdministratorAccount
in interface AWSSecurityHub
@Deprecated public DisassociateFromMasterAccountResult disassociateFromMasterAccount(DisassociateFromMasterAccountRequest request)
AWSSecurityHub
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.
disassociateFromMasterAccount
in interface AWSSecurityHub
public DisassociateMembersResult disassociateMembers(DisassociateMembersRequest request)
AWSSecurityHub
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.
disassociateMembers
in interface AWSSecurityHub
public EnableImportFindingsForProductResult enableImportFindingsForProduct(EnableImportFindingsForProductRequest request)
AWSSecurityHub
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.
enableImportFindingsForProduct
in interface AWSSecurityHub
public EnableOrganizationAdminAccountResult enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest request)
AWSSecurityHub
Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.
enableOrganizationAdminAccount
in interface AWSSecurityHub
public EnableSecurityHubResult enableSecurityHub(EnableSecurityHubRequest request)
AWSSecurityHub
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.
enableSecurityHub
in interface AWSSecurityHub
public GetAdministratorAccountResult getAdministratorAccount(GetAdministratorAccountRequest request)
AWSSecurityHub
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.
getAdministratorAccount
in interface AWSSecurityHub
public GetConfigurationPolicyResult getConfigurationPolicy(GetConfigurationPolicyRequest request)
AWSSecurityHub
Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
getConfigurationPolicy
in interface AWSSecurityHub
public GetConfigurationPolicyAssociationResult getConfigurationPolicyAssociation(GetConfigurationPolicyAssociationRequest request)
AWSSecurityHub
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.
getConfigurationPolicyAssociation
in interface AWSSecurityHub
public GetEnabledStandardsResult getEnabledStandards(GetEnabledStandardsRequest request)
AWSSecurityHub
Returns a list of the standards that are currently enabled.
getEnabledStandards
in interface AWSSecurityHub
public GetFindingAggregatorResult getFindingAggregator(GetFindingAggregatorRequest request)
AWSSecurityHub
Returns the current finding aggregation configuration.
getFindingAggregator
in interface AWSSecurityHub
public GetFindingHistoryResult getFindingHistory(GetFindingHistoryRequest request)
AWSSecurityHub
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).
getFindingHistory
in interface AWSSecurityHub
public GetFindingsResult getFindings(GetFindingsRequest request)
AWSSecurityHub
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.
getFindings
in interface AWSSecurityHub
public GetInsightResultsResult getInsightResults(GetInsightResultsRequest request)
AWSSecurityHub
Lists the results of the Security Hub insight specified by the insight ARN.
getInsightResults
in interface AWSSecurityHub
public GetInsightsResult getInsights(GetInsightsRequest request)
AWSSecurityHub
Lists and describes insights for the specified insight ARNs.
getInsights
in interface AWSSecurityHub
public GetInvitationsCountResult getInvitationsCount(GetInvitationsCountRequest request)
AWSSecurityHub
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
getInvitationsCount
in interface AWSSecurityHub
@Deprecated public GetMasterAccountResult getMasterAccount(GetMasterAccountRequest request)
AWSSecurityHub
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.
getMasterAccount
in interface AWSSecurityHub
public GetMembersResult getMembers(GetMembersRequest request)
AWSSecurityHub
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.
getMembers
in interface AWSSecurityHub
public GetSecurityControlDefinitionResult getSecurityControlDefinition(GetSecurityControlDefinitionRequest request)
AWSSecurityHub
Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.
getSecurityControlDefinition
in interface AWSSecurityHub
public InviteMembersResult inviteMembers(InviteMembersRequest request)
AWSSecurityHub
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.
inviteMembers
in interface AWSSecurityHub
public ListAutomationRulesResult listAutomationRules(ListAutomationRulesRequest request)
AWSSecurityHub
A list of automation rules and their metadata for the calling account.
listAutomationRules
in interface AWSSecurityHub
public ListConfigurationPoliciesResult listConfigurationPolicies(ListConfigurationPoliciesRequest request)
AWSSecurityHub
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.
listConfigurationPolicies
in interface AWSSecurityHub
public ListConfigurationPolicyAssociationsResult listConfigurationPolicyAssociations(ListConfigurationPolicyAssociationsRequest request)
AWSSecurityHub
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.
listConfigurationPolicyAssociations
in interface AWSSecurityHub
public ListEnabledProductsForImportResult listEnabledProductsForImport(ListEnabledProductsForImportRequest request)
AWSSecurityHub
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
listEnabledProductsForImport
in interface AWSSecurityHub
public ListFindingAggregatorsResult listFindingAggregators(ListFindingAggregatorsRequest request)
AWSSecurityHub
If finding aggregation is enabled, then ListFindingAggregators
returns the ARN of the finding
aggregator. You can run this operation from any Region.
listFindingAggregators
in interface AWSSecurityHub
public ListInvitationsResult listInvitations(ListInvitationsRequest request)
AWSSecurityHub
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.
listInvitations
in interface AWSSecurityHub
public ListMembersResult listMembers(ListMembersRequest request)
AWSSecurityHub
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.
listMembers
in interface AWSSecurityHub
public ListOrganizationAdminAccountsResult listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest request)
AWSSecurityHub
Lists the Security Hub administrator accounts. Can only be called by the organization management account.
listOrganizationAdminAccounts
in interface AWSSecurityHub
public ListSecurityControlDefinitionsResult listSecurityControlDefinitions(ListSecurityControlDefinitionsRequest request)
AWSSecurityHub
Lists all of the security controls that apply to a specified standard.
listSecurityControlDefinitions
in interface AWSSecurityHub
public ListStandardsControlAssociationsResult listStandardsControlAssociations(ListStandardsControlAssociationsRequest request)
AWSSecurityHub
Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
listStandardsControlAssociations
in interface AWSSecurityHub
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSSecurityHub
Returns a list of tags associated with a resource.
listTagsForResource
in interface AWSSecurityHub
public StartConfigurationPolicyAssociationResult startConfigurationPolicyAssociation(StartConfigurationPolicyAssociationRequest request)
AWSSecurityHub
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.
startConfigurationPolicyAssociation
in interface AWSSecurityHub
public StartConfigurationPolicyDisassociationResult startConfigurationPolicyDisassociation(StartConfigurationPolicyDisassociationRequest request)
AWSSecurityHub
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.
startConfigurationPolicyDisassociation
in interface AWSSecurityHub
public TagResourceResult tagResource(TagResourceRequest request)
AWSSecurityHub
Adds one or more tags to a resource.
tagResource
in interface AWSSecurityHub
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSSecurityHub
Removes one or more tags from a resource.
untagResource
in interface AWSSecurityHub
public UpdateActionTargetResult updateActionTarget(UpdateActionTargetRequest request)
AWSSecurityHub
Updates the name and description of a custom action target in Security Hub.
updateActionTarget
in interface AWSSecurityHub
public UpdateConfigurationPolicyResult updateConfigurationPolicy(UpdateConfigurationPolicyRequest request)
AWSSecurityHub
Updates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
updateConfigurationPolicy
in interface AWSSecurityHub
public UpdateFindingAggregatorResult updateFindingAggregator(UpdateFindingAggregatorRequest request)
AWSSecurityHub
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.
updateFindingAggregator
in interface AWSSecurityHub
public UpdateFindingsResult updateFindings(UpdateFindingsRequest request)
AWSSecurityHub
UpdateFindings
is a deprecated operation. Instead of UpdateFindings
, use the
BatchUpdateFindings
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 also sees the update to the finding.
Finding updates made with UpdateFindings
might not be persisted if the same finding is later updated
by the finding provider through the BatchImportFindings
operation.
updateFindings
in interface AWSSecurityHub
public UpdateInsightResult updateInsight(UpdateInsightRequest request)
AWSSecurityHub
Updates the Security Hub insight identified by the specified insight ARN.
updateInsight
in interface AWSSecurityHub
public UpdateOrganizationConfigurationResult updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest request)
AWSSecurityHub
Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation.
updateOrganizationConfiguration
in interface AWSSecurityHub
public UpdateSecurityControlResult updateSecurityControl(UpdateSecurityControlRequest request)
AWSSecurityHub
Updates the properties of a security control.
updateSecurityControl
in interface AWSSecurityHub
public UpdateSecurityHubConfigurationResult updateSecurityHubConfiguration(UpdateSecurityHubConfigurationRequest request)
AWSSecurityHub
Updates configuration options for Security Hub.
updateSecurityHubConfiguration
in interface AWSSecurityHub
public UpdateStandardsControlResult updateStandardsControl(UpdateStandardsControlRequest request)
AWSSecurityHub
Used to control whether an individual security standard control is enabled or disabled.
updateStandardsControl
in interface AWSSecurityHub
public void shutdown()
AWSSecurityHub
shutdown
in interface AWSSecurityHub
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSecurityHub
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSSecurityHub
request
- The originally executed request.