@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 |
|---|---|
AcceptInvitationResult |
acceptInvitation(AcceptInvitationRequest request)
Accepts the invitation to be a member account and be monitored by the Security Hub master account that the
invitation was sent from.
|
BatchDisableStandardsResult |
batchDisableStandards(BatchDisableStandardsRequest request)
Disables the standards specified by the provided
StandardsSubscriptionArns. |
BatchEnableStandardsResult |
batchEnableStandards(BatchEnableStandardsRequest request)
Enables the standards specified by the provided
StandardsArn. |
BatchImportFindingsResult |
batchImportFindings(BatchImportFindingsRequest request)
Imports security findings generated from an integrated third-party product into Security Hub.
|
BatchUpdateFindingsResult |
batchUpdateFindings(BatchUpdateFindingsRequest request)
Used by Security Hub customers to update information about their investigation into a finding.
|
CreateActionTargetResult |
createActionTarget(CreateActionTargetRequest request)
Creates a custom action target in Security Hub.
|
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 master account.
|
DeclineInvitationsResult |
declineInvitations(DeclineInvitationsRequest request)
Declines invitations to become a member account.
|
DeleteActionTargetResult |
deleteActionTarget(DeleteActionTargetRequest request)
Deletes a custom action target from Security Hub.
|
DeleteInsightResult |
deleteInsight(DeleteInsightRequest request)
Deletes the insight specified by the
InsightArn. |
DeleteInvitationsResult |
deleteInvitations(DeleteInvitationsRequest request)
Deletes invitations received by the AWS 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 Organizations configuration for 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 Region.
|
DisassociateFromMasterAccountResult |
disassociateFromMasterAccount(DisassociateFromMasterAccountRequest request)
Disassociates the current Security Hub member account from the associated master account.
|
DisassociateMembersResult |
disassociateMembers(DisassociateMembersRequest request)
Disassociates the specified member accounts from the associated master 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.
|
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.
|
GetEnabledStandardsResult |
getEnabledStandards(GetEnabledStandardsRequest request)
Returns a list of the standards that are currently enabled.
|
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)
Provides the details for the Security Hub master account for the current member account.
|
GetMembersResult |
getMembers(GetMembersRequest request)
Returns the details for the Security Hub member accounts for the specified account IDs.
|
InviteMembersResult |
inviteMembers(InviteMembersRequest request)
Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is
sent from.
|
ListEnabledProductsForImportResult |
listEnabledProductsForImport(ListEnabledProductsForImportRequest request)
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security
Hub.
|
ListInvitationsResult |
listInvitations(ListInvitationsRequest request)
Lists all Security Hub membership invitations that were sent to the current AWS account.
|
ListMembersResult |
listMembers(ListMembersRequest request)
Lists details about all member accounts for the current Security Hub master account.
|
ListOrganizationAdminAccountsResult |
listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest request)
Lists the Security Hub administrator accounts.
|
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.
|
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.
|
UpdateFindingsResult |
updateFindings(UpdateFindingsRequest request)
UpdateFindings is deprecated. |
UpdateInsightResult |
updateInsight(UpdateInsightRequest request)
Updates the Security Hub insight identified by the specified insight ARN.
|
UpdateOrganizationConfigurationResult |
updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest request)
Used to update the configuration related to Organizations.
|
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 AcceptInvitationResult acceptInvitation(AcceptInvitationRequest request)
AWSSecurityHubAccepts the invitation to be a member account and be monitored by the Security Hub master 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 master account to view findings generated in the member account.
acceptInvitation in interface AWSSecurityHubpublic BatchDisableStandardsResult batchDisableStandards(BatchDisableStandardsRequest request)
AWSSecurityHub
Disables the standards specified by the provided StandardsSubscriptionArns.
For more information, see Security Standards section of the AWS Security Hub User Guide.
batchDisableStandards in interface AWSSecurityHubpublic 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 AWS Security Hub User Guide.
batchEnableStandards in interface AWSSecurityHubpublic BatchImportFindingsResult batchImportFindings(BatchImportFindingsRequest request)
AWSSecurityHubImports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created, 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
BatchImportFindings can be used to update the following finding fields and objects only if they have
not been updated using BatchUpdateFindings. After they are updated using
BatchUpdateFindings, these fields cannot be updated using BatchImportFindings.
Confidence
Criticality
RelatedFindings
Severity
Types
batchImportFindings in interface AWSSecurityHubpublic BatchUpdateFindingsResult batchUpdateFindings(BatchUpdateFindingsRequest request)
AWSSecurityHubUsed by Security Hub customers to update information about their investigation into a finding. Requested by master accounts or member accounts. Master 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.
Master 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 AWS Security Hub User Guide.
batchUpdateFindings in interface AWSSecurityHubpublic CreateActionTargetResult createActionTarget(CreateActionTargetRequest request)
AWSSecurityHubCreates 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 AWSSecurityHubpublic CreateInsightResult createInsight(CreateInsightRequest request)
AWSSecurityHubCreates 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 AWSSecurityHubpublic CreateMembersResult createMembers(CreateMembersRequest request)
AWSSecurityHubCreates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. If you are integrated with Organizations, then the master account is the Security Hub administrator account that is designated by the organization management account.
CreateMembers is always used to add accounts that are not organization members.
For accounts that are part of an organization, CreateMembers is only used in the following cases:
Security Hub is not configured to automatically add new accounts in an organization.
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 part of an organization do not receive an invitation. They automatically become a member account in Security Hub.
A permissions policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in a member account, findings are sent to both the member and master accounts.
To remove the association between the master and member accounts, use the
DisassociateFromMasterAccount or DisassociateMembers operation.
createMembers in interface AWSSecurityHubpublic DeclineInvitationsResult declineInvitations(DeclineInvitationsRequest request)
AWSSecurityHubDeclines invitations to become a member account.
This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.
declineInvitations in interface AWSSecurityHubpublic DeleteActionTargetResult deleteActionTarget(DeleteActionTargetRequest request)
AWSSecurityHubDeletes 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 AWSSecurityHubpublic DeleteInsightResult deleteInsight(DeleteInsightRequest request)
AWSSecurityHub
Deletes the insight specified by the InsightArn.
deleteInsight in interface AWSSecurityHubpublic DeleteInvitationsResult deleteInvitations(DeleteInvitationsRequest request)
AWSSecurityHubDeletes invitations received by the AWS account to become a member account.
This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.
deleteInvitations in interface AWSSecurityHubpublic DeleteMembersResult deleteMembers(DeleteMembersRequest request)
AWSSecurityHubDeletes 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.
deleteMembers in interface AWSSecurityHubpublic DescribeActionTargetsResult describeActionTargets(DescribeActionTargetsRequest request)
AWSSecurityHubReturns a list of the custom action targets in Security Hub in your account.
describeActionTargets in interface AWSSecurityHubpublic 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 AWSSecurityHubpublic DescribeOrganizationConfigurationResult describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest request)
AWSSecurityHubReturns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.
describeOrganizationConfiguration in interface AWSSecurityHubpublic DescribeProductsResult describeProducts(DescribeProductsRequest request)
AWSSecurityHubReturns 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 AWSSecurityHubpublic DescribeStandardsResult describeStandards(DescribeStandardsRequest request)
AWSSecurityHubReturns 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 AWSSecurityHubpublic DescribeStandardsControlsResult describeStandardsControls(DescribeStandardsControlsRequest request)
AWSSecurityHubReturns 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 AWSSecurityHubpublic DisableImportFindingsForProductResult disableImportFindingsForProduct(DisableImportFindingsForProductRequest request)
AWSSecurityHubDisables 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 AWSSecurityHubpublic DisableOrganizationAdminAccountResult disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest request)
AWSSecurityHubDisables a Security Hub administrator account. Can only be called by the organization management account.
disableOrganizationAdminAccount in interface AWSSecurityHubpublic DisableSecurityHubResult disableSecurityHub(DisableSecurityHubRequest request)
AWSSecurityHubDisables 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 a master 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 master 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 AWSSecurityHubpublic DisassociateFromMasterAccountResult disassociateFromMasterAccount(DisassociateFromMasterAccountRequest request)
AWSSecurityHubDisassociates the current Security Hub member account from the associated master account.
This operation is only used by accounts that are not part of an organization. For organization accounts, only the master account (the designated Security Hub administrator) can disassociate a member account.
disassociateFromMasterAccount in interface AWSSecurityHubpublic DisassociateMembersResult disassociateMembers(DisassociateMembersRequest request)
AWSSecurityHubDisassociates the specified member accounts from the associated master account.
Can be used to disassociate both accounts that are in an organization and accounts that were invited manually.
disassociateMembers in interface AWSSecurityHubpublic EnableImportFindingsForProductResult enableImportFindingsForProduct(EnableImportFindingsForProductRequest request)
AWSSecurityHubEnables 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 AWSSecurityHubpublic EnableOrganizationAdminAccountResult enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest request)
AWSSecurityHubDesignates the Security Hub administrator account for an organization. Can only be called by the organization management account.
enableOrganizationAdminAccount in interface AWSSecurityHubpublic EnableSecurityHubResult enableSecurityHub(EnableSecurityHubRequest request)
AWSSecurityHubEnables 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.
CIS AWS Foundations
AWS Foundational Security Best Practices
You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard.
To not enable the 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 Setting Up AWS Security Hub in the AWS Security Hub User Guide.
enableSecurityHub in interface AWSSecurityHubpublic GetEnabledStandardsResult getEnabledStandards(GetEnabledStandardsRequest request)
AWSSecurityHubReturns a list of the standards that are currently enabled.
getEnabledStandards in interface AWSSecurityHubpublic GetFindingsResult getFindings(GetFindingsRequest request)
AWSSecurityHubReturns a list of findings that match the specified criteria.
getFindings in interface AWSSecurityHubpublic GetInsightResultsResult getInsightResults(GetInsightResultsRequest request)
AWSSecurityHubLists the results of the Security Hub insight specified by the insight ARN.
getInsightResults in interface AWSSecurityHubpublic GetInsightsResult getInsights(GetInsightsRequest request)
AWSSecurityHubLists and describes insights for the specified insight ARNs.
getInsights in interface AWSSecurityHubpublic GetInvitationsCountResult getInvitationsCount(GetInvitationsCountRequest request)
AWSSecurityHubReturns 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 AWSSecurityHubpublic GetMasterAccountResult getMasterAccount(GetMasterAccountRequest request)
AWSSecurityHubProvides the details for the Security Hub master account for the current member account.
Can be used by both member accounts that are in an organization and accounts that were invited manually.
getMasterAccount in interface AWSSecurityHubpublic GetMembersResult getMembers(GetMembersRequest request)
AWSSecurityHubReturns the details for the Security Hub member accounts for the specified account IDs.
A master account can be either a delegated Security Hub administrator account for an organization or a master account that enabled Security Hub manually.
The results include both member accounts that are in an organization and accounts that were invited manually.
getMembers in interface AWSSecurityHubpublic InviteMembersResult inviteMembers(InviteMembersRequest request)
AWSSecurityHubInvites other AWS accounts to become member accounts for the Security Hub master 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 master account can view the findings generated from the member account.
inviteMembers in interface AWSSecurityHubpublic ListEnabledProductsForImportResult listEnabledProductsForImport(ListEnabledProductsForImportRequest request)
AWSSecurityHubLists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
listEnabledProductsForImport in interface AWSSecurityHubpublic ListInvitationsResult listInvitations(ListInvitationsRequest request)
AWSSecurityHubLists all Security Hub membership invitations that were sent to the current AWS account.
This operation is only used by accounts that do not belong to an organization. Organization accounts do not receive invitations.
listInvitations in interface AWSSecurityHubpublic ListMembersResult listMembers(ListMembersRequest request)
AWSSecurityHubLists details about all member accounts for the current Security Hub master account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
listMembers in interface AWSSecurityHubpublic ListOrganizationAdminAccountsResult listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest request)
AWSSecurityHubLists the Security Hub administrator accounts. Can only be called by the organization management account.
listOrganizationAdminAccounts in interface AWSSecurityHubpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSSecurityHubReturns a list of tags associated with a resource.
listTagsForResource in interface AWSSecurityHubpublic TagResourceResult tagResource(TagResourceRequest request)
AWSSecurityHubAdds one or more tags to a resource.
tagResource in interface AWSSecurityHubpublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSSecurityHubRemoves one or more tags from a resource.
untagResource in interface AWSSecurityHubpublic UpdateActionTargetResult updateActionTarget(UpdateActionTargetRequest request)
AWSSecurityHubUpdates the name and description of a custom action target in Security Hub.
updateActionTarget in interface AWSSecurityHubpublic UpdateFindingsResult updateFindings(UpdateFindingsRequest request)
AWSSecurityHub
UpdateFindings is deprecated. Instead of UpdateFindings, use
BatchUpdateFindings.
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.
updateFindings in interface AWSSecurityHubpublic UpdateInsightResult updateInsight(UpdateInsightRequest request)
AWSSecurityHubUpdates the Security Hub insight identified by the specified insight ARN.
updateInsight in interface AWSSecurityHubpublic UpdateOrganizationConfigurationResult updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest request)
AWSSecurityHubUsed to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.
updateOrganizationConfiguration in interface AWSSecurityHubpublic UpdateSecurityHubConfigurationResult updateSecurityHubConfiguration(UpdateSecurityHubConfigurationRequest request)
AWSSecurityHubUpdates configuration options for Security Hub.
updateSecurityHubConfiguration in interface AWSSecurityHubpublic UpdateStandardsControlResult updateStandardsControl(UpdateStandardsControlRequest request)
AWSSecurityHubUsed to control whether an individual security standard control is enabled or disabled.
updateStandardsControl in interface AWSSecurityHubpublic void shutdown()
AWSSecurityHubshutdown in interface AWSSecurityHubpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSecurityHubResponse 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 AWSSecurityHubrequest - The originally executed request.