com.amazonaws.services.securityhub

Class AWSSecurityHubClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.securityhub.AWSSecurityHubClient

All Implemented Interfaces:

AWSSecurityHub

Direct Known Subclasses:

AWSSecurityHubAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSecurityHubClient
extends AmazonWebServiceClient
implements AWSSecurityHub

Client for accessing AWS SecurityHub. All service calls made using this client are blocking, and will not return until the service call completes.

Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the AWS Security Hub User Guide .

When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to.

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of the member account with the master account is created only in the us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from.

The following throttling limits apply to using Security Hub API operations.

• GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests per second.

• UpdateFindings - RateLimit of 1 request per second. BurstLimit of 5 requests per second.

• All other operations - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.securityhub.AWSSecurityHub

ENDPOINT_PREFIX

Method Summary

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.
static AWSSecurityHubClientBuilder	builder()
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.
DescribeProductsResult	describeProducts(DescribeProductsRequest request) Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.
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.
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.
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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of tags associated with a resource.
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.
UpdateStandardsControlResult	updateStandardsControl(UpdateStandardsControlRequest request) Used to control whether an individual security standard control is enabled or disabled.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.securityhub.AWSSecurityHub

shutdown

Method Detail

builder

public static AWSSecurityHubClientBuilder builder()

acceptInvitation

public 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.

When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.

Specified by:

acceptInvitation in interface AWSSecurityHub

Parameters:

acceptInvitationRequest -

Returns:

Result of the AcceptInvitation operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

See Also:

AWS API Documentation

batchDisableStandards

public BatchDisableStandardsResult batchDisableStandards(BatchDisableStandardsRequest request)

Disables the standards specified by the provided StandardsSubscriptionArns.

For more information, see Security Standards section of the AWS Security Hub User Guide.

Specified by:

batchDisableStandards in interface AWSSecurityHub

Parameters:

batchDisableStandardsRequest -

Returns:

Result of the BatchDisableStandards operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

See Also:

AWS API Documentation

batchEnableStandards

public BatchEnableStandardsResult batchEnableStandards(BatchEnableStandardsRequest request)

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.

Specified by:

batchEnableStandards in interface AWSSecurityHub

Parameters:

batchEnableStandardsRequest -

Returns:

Result of the BatchEnableStandards operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

See Also:

AWS API Documentation

batchImportFindings

public BatchImportFindingsResult batchImportFindings(BatchImportFindingsRequest request)

Imports 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.

• Confidence

• Criticality

• Note

• RelatedFindings

• Severity

• Types

• UserDefinedFields

• VerificationState

• Workflow

Specified by:

batchImportFindings in interface AWSSecurityHub

Parameters:

batchImportFindingsRequest -

Returns:

Result of the BatchImportFindings operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

See Also:

AWS API Documentation

batchUpdateFindings

public BatchUpdateFindingsResult batchUpdateFindings(BatchUpdateFindingsRequest request)

Used 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 accounts can use BatchUpdateFindings to update the following finding fields and objects.

• Confidence

• Criticality

• Note

• RelatedFindings

• Severity

• Types

• UserDefinedFields

• VerificationState

• Workflow

Member accounts can only use BatchUpdateFindings to update the Note object.

Specified by:

batchUpdateFindings in interface AWSSecurityHub

Parameters:

batchUpdateFindingsRequest -

Returns:

Result of the BatchUpdateFindings operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

See Also:

AWS API Documentation

createActionTarget

public CreateActionTargetResult createActionTarget(CreateActionTargetRequest request)

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.

Specified by:

createActionTarget in interface AWSSecurityHub

Parameters:

createActionTargetRequest -

Returns:

Result of the CreateActionTarget operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

See Also:

AWS API Documentation

createInsight

public CreateInsightResult createInsight(CreateInsightRequest request)

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.

Specified by:

createInsight in interface AWSSecurityHub

Parameters:

createInsightRequest -

Returns:

Result of the CreateInsight operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

See Also:

AWS API Documentation

createMembers

public 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. To successfully create a member, you must use this action from an account that already has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.

After you use CreateMembers to create member account associations in Security Hub, you must use the InviteMembers operation to invite the accounts to enable Security Hub and become member accounts in Security Hub.

If the account owner accepts the invitation, the account becomes a member account in Security Hub, and a permission policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start to be sent to both the member and master accounts.

To remove the association between the master and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

Specified by:

createMembers in interface AWSSecurityHub

Parameters:

createMembersRequest -

Returns:

Result of the CreateMembers operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

See Also:

AWS API Documentation

declineInvitations

public DeclineInvitationsResult declineInvitations(DeclineInvitationsRequest request)

Declines invitations to become a member account.

Specified by:

declineInvitations in interface AWSSecurityHub

Parameters:

declineInvitationsRequest -

Returns:

Result of the DeclineInvitations operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

deleteActionTarget

public DeleteActionTargetResult deleteActionTarget(DeleteActionTargetRequest request)

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.

Specified by:

deleteActionTarget in interface AWSSecurityHub

Parameters:

deleteActionTargetRequest -

Returns:

Result of the DeleteActionTarget operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

deleteInsight

public DeleteInsightResult deleteInsight(DeleteInsightRequest request)

Deletes the insight specified by the InsightArn.

Specified by:

deleteInsight in interface AWSSecurityHub

Parameters:

deleteInsightRequest -

Returns:

Result of the DeleteInsight operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

deleteInvitations

public DeleteInvitationsResult deleteInvitations(DeleteInvitationsRequest request)

Deletes invitations received by the AWS account to become a member account.

Specified by:

deleteInvitations in interface AWSSecurityHub

Parameters:

deleteInvitationsRequest -

Returns:

Result of the DeleteInvitations operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

See Also:

AWS API Documentation

deleteMembers

public DeleteMembersResult deleteMembers(DeleteMembersRequest request)

Deletes the specified member accounts from Security Hub.

Specified by:

deleteMembers in interface AWSSecurityHub

Parameters:

deleteMembersRequest -

Returns:

Result of the DeleteMembers operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

describeActionTargets

public DescribeActionTargetsResult describeActionTargets(DescribeActionTargetsRequest request)

Returns a list of the custom action targets in Security Hub in your account.

Specified by:

describeActionTargets in interface AWSSecurityHub

Parameters:

describeActionTargetsRequest -

Returns:

Result of the DescribeActionTargets operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

describeHub

public DescribeHubResult describeHub(DescribeHubRequest request)

Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

Specified by:

describeHub in interface AWSSecurityHub

Parameters:

describeHubRequest -

Returns:

Result of the DescribeHub operation returned by the service.

Throws:

InternalException - Internal server error.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

describeProducts

public DescribeProductsResult describeProducts(DescribeProductsRequest request)

Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.

Specified by:

describeProducts in interface AWSSecurityHub

Parameters:

describeProductsRequest -

Returns:

Result of the DescribeProducts operation returned by the service.

Throws:

InternalException - Internal server error.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

See Also:

AWS API Documentation

describeStandards

public DescribeStandardsResult describeStandards(DescribeStandardsRequest request)

Returns a list of the available standards in Security Hub.

For each standard, the results include the standard ARN, the name, and a description.

Specified by:

describeStandards in interface AWSSecurityHub

Parameters:

describeStandardsRequest -

Returns:

Result of the DescribeStandards operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

See Also:

AWS API Documentation

describeStandardsControls

public DescribeStandardsControlsResult describeStandardsControls(DescribeStandardsControlsRequest request)

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.

Specified by:

describeStandardsControls in interface AWSSecurityHub

Parameters:

describeStandardsControlsRequest -

Returns:

Result of the DescribeStandardsControls operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

disableImportFindingsForProduct

public DisableImportFindingsForProductResult disableImportFindingsForProduct(DisableImportFindingsForProductRequest request)

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.

Specified by:

disableImportFindingsForProduct in interface AWSSecurityHub

Parameters:

disableImportFindingsForProductRequest -

Returns:

Result of the DisableImportFindingsForProduct operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

See Also:

AWS API Documentation

disableSecurityHub

public DisableSecurityHubResult disableSecurityHub(DisableSecurityHubRequest request)

Disables 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.

Specified by:

disableSecurityHub in interface AWSSecurityHub

Parameters:

disableSecurityHubRequest -

Returns:

Result of the DisableSecurityHub operation returned by the service.

Throws:

InternalException - Internal server error.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

disassociateFromMasterAccount

public DisassociateFromMasterAccountResult disassociateFromMasterAccount(DisassociateFromMasterAccountRequest request)

Disassociates the current Security Hub member account from the associated master account.

Specified by:

disassociateFromMasterAccount in interface AWSSecurityHub

Parameters:

disassociateFromMasterAccountRequest -

Returns:

Result of the DisassociateFromMasterAccount operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

disassociateMembers

public DisassociateMembersResult disassociateMembers(DisassociateMembersRequest request)

Disassociates the specified member accounts from the associated master account.

Specified by:

disassociateMembers in interface AWSSecurityHub

Parameters:

disassociateMembersRequest -

Returns:

Result of the DisassociateMembers operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

enableImportFindingsForProduct

public EnableImportFindingsForProductResult enableImportFindingsForProduct(EnableImportFindingsForProductRequest request)

Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub.

When you enable a product integration, a permission policy that grants permission for the product to send findings to Security Hub is applied.

Specified by:

enableImportFindingsForProduct in interface AWSSecurityHub

Parameters:

enableImportFindingsForProductRequest -

Returns:

Result of the EnableImportFindingsForProduct operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

See Also:

AWS API Documentation

enableSecurityHub

public EnableSecurityHubResult enableSecurityHub(EnableSecurityHubRequest request)

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 CIS AWS Foundations standard. You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. To not enable the CIS AWS Foundations standard, 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.

Specified by:

enableSecurityHub in interface AWSSecurityHub

Parameters:

enableSecurityHubRequest -

Returns:

Result of the EnableSecurityHub operation returned by the service.

Throws:

InternalException - Internal server error.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

AccessDeniedException - You don't have permission to perform the action specified in the request.

See Also:

AWS API Documentation

getEnabledStandards

public GetEnabledStandardsResult getEnabledStandards(GetEnabledStandardsRequest request)

Returns a list of the standards that are currently enabled.

Specified by:

getEnabledStandards in interface AWSSecurityHub

Parameters:

getEnabledStandardsRequest -

Returns:

Result of the GetEnabledStandards operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

See Also:

AWS API Documentation

getFindings

public GetFindingsResult getFindings(GetFindingsRequest request)

Returns a list of findings that match the specified criteria.

Specified by:

getFindings in interface AWSSecurityHub

Parameters:

getFindingsRequest -

Returns:

Result of the GetFindings operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

See Also:

AWS API Documentation

getInsightResults

public GetInsightResultsResult getInsightResults(GetInsightResultsRequest request)

Lists the results of the Security Hub insight specified by the insight ARN.

Specified by:

getInsightResults in interface AWSSecurityHub

Parameters:

getInsightResultsRequest -

Returns:

Result of the GetInsightResults operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

getInsights

public GetInsightsResult getInsights(GetInsightsRequest request)

Lists and describes insights for the specified insight ARNs.

Specified by:

getInsights in interface AWSSecurityHub

Parameters:

getInsightsRequest -

Returns:

Result of the GetInsights operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

getInvitationsCount

public 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.

Specified by:

getInvitationsCount in interface AWSSecurityHub

Parameters:

getInvitationsCountRequest -

Returns:

Result of the GetInvitationsCount operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

See Also:

AWS API Documentation

getMasterAccount

public GetMasterAccountResult getMasterAccount(GetMasterAccountRequest request)

Provides the details for the Security Hub master account for the current member account.

Specified by:

getMasterAccount in interface AWSSecurityHub

Parameters:

getMasterAccountRequest -

Returns:

Result of the GetMasterAccount operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

getMembers

public GetMembersResult getMembers(GetMembersRequest request)

Returns the details for the Security Hub member accounts for the specified account IDs.

Specified by:

getMembers in interface AWSSecurityHub

Parameters:

getMembersRequest -

Returns:

Result of the GetMembers operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

inviteMembers

public InviteMembersResult inviteMembers(InviteMembersRequest request)

Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.

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 accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from the member account.

Specified by:

inviteMembers in interface AWSSecurityHub

Parameters:

inviteMembersRequest -

Returns:

Result of the InviteMembers operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

listEnabledProductsForImport

public ListEnabledProductsForImportResult listEnabledProductsForImport(ListEnabledProductsForImportRequest request)

Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.

Specified by:

listEnabledProductsForImport in interface AWSSecurityHub

Parameters:

listEnabledProductsForImportRequest -

Returns:

Result of the ListEnabledProductsForImport operation returned by the service.

Throws:

InternalException - Internal server error.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

See Also:

AWS API Documentation

listInvitations

public ListInvitationsResult listInvitations(ListInvitationsRequest request)

Lists all Security Hub membership invitations that were sent to the current AWS account.

Specified by:

listInvitations in interface AWSSecurityHub

Parameters:

listInvitationsRequest -

Returns:

Result of the ListInvitations operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

See Also:

AWS API Documentation

listMembers

public ListMembersResult listMembers(ListMembersRequest request)

Lists details about all member accounts for the current Security Hub master account.

Specified by:

listMembers in interface AWSSecurityHub

Parameters:

listMembersRequest -

Returns:

Result of the ListMembers operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns a list of tags associated with a resource.

Specified by:

listTagsForResource in interface AWSSecurityHub

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds one or more tags to a resource.

Specified by:

tagResource in interface AWSSecurityHub

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes one or more tags from a resource.

Specified by:

untagResource in interface AWSSecurityHub

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

updateActionTarget

public UpdateActionTargetResult updateActionTarget(UpdateActionTargetRequest request)

Updates the name and description of a custom action target in Security Hub.

Specified by:

updateActionTarget in interface AWSSecurityHub

Parameters:

updateActionTargetRequest -

Returns:

Result of the UpdateActionTarget operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

updateFindings

public UpdateFindingsResult updateFindings(UpdateFindingsRequest request)

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.

Specified by:

updateFindings in interface AWSSecurityHub

Parameters:

updateFindingsRequest -

Returns:

Result of the UpdateFindings operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

updateInsight

public UpdateInsightResult updateInsight(UpdateInsightRequest request)

Updates the Security Hub insight identified by the specified insight ARN.

Specified by:

updateInsight in interface AWSSecurityHub

Parameters:

updateInsightRequest -

Returns:

Result of the UpdateInsight operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

LimitExceededException - The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

updateStandardsControl

public UpdateStandardsControlResult updateStandardsControl(UpdateStandardsControlRequest request)

Used to control whether an individual security standard control is enabled or disabled.

Specified by:

updateStandardsControl in interface AWSSecurityHub

Parameters:

updateStandardsControlRequest -

Returns:

Result of the UpdateStandardsControl operation returned by the service.

Throws:

InternalException - Internal server error.

InvalidInputException - The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException - AWS Security Hub isn't enabled for the account used to make this request.

ResourceNotFoundException - The request was rejected because we can't find the specified resource.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

Specified by:

getCachedResponseMetadata in interface AWSSecurityHub

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.