@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSecurityHub
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSecurityHub
instead.
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.
BatchEnableStandards
- RateLimit
of 1 request per second, BurstLimit
of 1 request per second.
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.
UpdateStandardsControl
- 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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AcceptInvitationResult |
acceptInvitation(AcceptInvitationRequest acceptInvitationRequest)
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 batchDisableStandardsRequest)
Disables the standards specified by the provided
StandardsSubscriptionArns . |
BatchEnableStandardsResult |
batchEnableStandards(BatchEnableStandardsRequest batchEnableStandardsRequest)
Enables the standards specified by the provided
StandardsArn . |
BatchImportFindingsResult |
batchImportFindings(BatchImportFindingsRequest batchImportFindingsRequest)
Imports security findings generated from an integrated third-party product into Security Hub.
|
BatchUpdateFindingsResult |
batchUpdateFindings(BatchUpdateFindingsRequest batchUpdateFindingsRequest)
Used by Security Hub customers to update information about their investigation into a finding.
|
CreateActionTargetResult |
createActionTarget(CreateActionTargetRequest createActionTargetRequest)
Creates a custom action target in Security Hub.
|
CreateInsightResult |
createInsight(CreateInsightRequest createInsightRequest)
Creates a custom insight in Security Hub.
|
CreateMembersResult |
createMembers(CreateMembersRequest createMembersRequest)
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 declineInvitationsRequest)
Declines invitations to become a member account.
|
DeleteActionTargetResult |
deleteActionTarget(DeleteActionTargetRequest deleteActionTargetRequest)
Deletes a custom action target from Security Hub.
|
DeleteInsightResult |
deleteInsight(DeleteInsightRequest deleteInsightRequest)
Deletes the insight specified by the
InsightArn . |
DeleteInvitationsResult |
deleteInvitations(DeleteInvitationsRequest deleteInvitationsRequest)
Deletes invitations received by the AWS account to become a member account.
|
DeleteMembersResult |
deleteMembers(DeleteMembersRequest deleteMembersRequest)
Deletes the specified member accounts from Security Hub.
|
DescribeActionTargetsResult |
describeActionTargets(DescribeActionTargetsRequest describeActionTargetsRequest)
Returns a list of the custom action targets in Security Hub in your account.
|
DescribeHubResult |
describeHub(DescribeHubRequest describeHubRequest)
Returns details about the Hub resource in your account, including the
HubArn and the time when you
enabled Security Hub. |
DescribeOrganizationConfigurationResult |
describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest)
Returns information about the Organizations configuration for Security Hub.
|
DescribeProductsResult |
describeProducts(DescribeProductsRequest describeProductsRequest)
Returns information about product integrations in Security Hub.
|
DescribeStandardsResult |
describeStandards(DescribeStandardsRequest describeStandardsRequest)
Returns a list of the available standards in Security Hub.
|
DescribeStandardsControlsResult |
describeStandardsControls(DescribeStandardsControlsRequest describeStandardsControlsRequest)
Returns a list of security standards controls.
|
DisableImportFindingsForProductResult |
disableImportFindingsForProduct(DisableImportFindingsForProductRequest disableImportFindingsForProductRequest)
Disables the integration of the specified product with Security Hub.
|
DisableOrganizationAdminAccountResult |
disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest)
Disables a Security Hub administrator account.
|
DisableSecurityHubResult |
disableSecurityHub(DisableSecurityHubRequest disableSecurityHubRequest)
Disables Security Hub in your account only in the current Region.
|
DisassociateFromMasterAccountResult |
disassociateFromMasterAccount(DisassociateFromMasterAccountRequest disassociateFromMasterAccountRequest)
Disassociates the current Security Hub member account from the associated master account.
|
DisassociateMembersResult |
disassociateMembers(DisassociateMembersRequest disassociateMembersRequest)
Disassociates the specified member accounts from the associated master account.
|
EnableImportFindingsForProductResult |
enableImportFindingsForProduct(EnableImportFindingsForProductRequest enableImportFindingsForProductRequest)
Enables the integration of a partner product with Security Hub.
|
EnableOrganizationAdminAccountResult |
enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest)
Designates the Security Hub administrator account for an organization.
|
EnableSecurityHubResult |
enableSecurityHub(EnableSecurityHubRequest enableSecurityHubRequest)
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 getEnabledStandardsRequest)
Returns a list of the standards that are currently enabled.
|
GetFindingsResult |
getFindings(GetFindingsRequest getFindingsRequest)
Returns a list of findings that match the specified criteria.
|
GetInsightResultsResult |
getInsightResults(GetInsightResultsRequest getInsightResultsRequest)
Lists the results of the Security Hub insight specified by the insight ARN.
|
GetInsightsResult |
getInsights(GetInsightsRequest getInsightsRequest)
Lists and describes insights for the specified insight ARNs.
|
GetInvitationsCountResult |
getInvitationsCount(GetInvitationsCountRequest getInvitationsCountRequest)
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 getMasterAccountRequest)
Provides the details for the Security Hub master account for the current member account.
|
GetMembersResult |
getMembers(GetMembersRequest getMembersRequest)
Returns the details for the Security Hub member accounts for the specified account IDs.
|
InviteMembersResult |
inviteMembers(InviteMembersRequest inviteMembersRequest)
Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is
sent from.
|
ListEnabledProductsForImportResult |
listEnabledProductsForImport(ListEnabledProductsForImportRequest listEnabledProductsForImportRequest)
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security
Hub.
|
ListInvitationsResult |
listInvitations(ListInvitationsRequest listInvitationsRequest)
Lists all Security Hub membership invitations that were sent to the current AWS account.
|
ListMembersResult |
listMembers(ListMembersRequest listMembersRequest)
Lists details about all member accounts for the current Security Hub master account.
|
ListOrganizationAdminAccountsResult |
listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest)
Lists the Security Hub administrator accounts.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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 tagResourceRequest)
Adds one or more tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a resource.
|
UpdateActionTargetResult |
updateActionTarget(UpdateActionTargetRequest updateActionTargetRequest)
Updates the name and description of a custom action target in Security Hub.
|
UpdateFindingsResult |
updateFindings(UpdateFindingsRequest updateFindingsRequest)
UpdateFindings is deprecated. |
UpdateInsightResult |
updateInsight(UpdateInsightRequest updateInsightRequest)
Updates the Security Hub insight identified by the specified insight ARN.
|
UpdateOrganizationConfigurationResult |
updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest)
Used to update the configuration related to Organizations.
|
UpdateSecurityHubConfigurationResult |
updateSecurityHubConfiguration(UpdateSecurityHubConfigurationRequest updateSecurityHubConfigurationRequest)
Updates configuration options for Security Hub.
|
UpdateStandardsControlResult |
updateStandardsControl(UpdateStandardsControlRequest updateStandardsControlRequest)
Used to control whether an individual security standard control is enabled or disabled.
|
static final String ENDPOINT_PREFIX
AcceptInvitationResult acceptInvitation(AcceptInvitationRequest acceptInvitationRequest)
Accepts 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.
acceptInvitationRequest
- 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 or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.BatchDisableStandardsResult batchDisableStandards(BatchDisableStandardsRequest batchDisableStandardsRequest)
Disables the standards specified by the provided StandardsSubscriptionArns
.
For more information, see Security Standards section of the AWS Security Hub User Guide.
batchDisableStandardsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.BatchEnableStandardsResult batchEnableStandards(BatchEnableStandardsRequest batchEnableStandardsRequest)
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.
batchEnableStandardsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.BatchImportFindingsResult batchImportFindings(BatchImportFindingsRequest batchImportFindingsRequest)
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.
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
batchImportFindingsRequest
- 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 or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.BatchUpdateFindingsResult batchUpdateFindings(BatchUpdateFindingsRequest batchUpdateFindingsRequest)
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 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.
batchUpdateFindingsRequest
- 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 or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.CreateActionTargetResult createActionTarget(CreateActionTargetRequest createActionTargetRequest)
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.
createActionTargetRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceConflictException
- The resource specified in the request conflicts with an existing resource.CreateInsightResult createInsight(CreateInsightRequest createInsightRequest)
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
.
createInsightRequest
- 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 or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceConflictException
- The resource specified in the request conflicts with an existing resource.CreateMembersResult createMembers(CreateMembersRequest createMembersRequest)
Creates 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.
createMembersRequest
- 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 or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceConflictException
- The resource specified in the request conflicts with an existing resource.DeclineInvitationsResult declineInvitations(DeclineInvitationsRequest declineInvitationsRequest)
Declines 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.
declineInvitationsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.DeleteActionTargetResult deleteActionTarget(DeleteActionTargetRequest deleteActionTargetRequest)
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.
deleteActionTargetRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.DeleteInsightResult deleteInsight(DeleteInsightRequest deleteInsightRequest)
Deletes the insight specified by the InsightArn
.
deleteInsightRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.DeleteInvitationsResult deleteInvitations(DeleteInvitationsRequest deleteInvitationsRequest)
Deletes 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.
deleteInvitationsRequest
- 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 or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.DeleteMembersResult deleteMembers(DeleteMembersRequest deleteMembersRequest)
Deletes 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.
deleteMembersRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.DescribeActionTargetsResult describeActionTargets(DescribeActionTargetsRequest describeActionTargetsRequest)
Returns a list of the custom action targets in Security Hub in your account.
describeActionTargetsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.DescribeHubResult describeHub(DescribeHubRequest describeHubRequest)
Returns details about the Hub resource in your account, including the HubArn
and the time when you
enabled Security Hub.
describeHubRequest
- InternalException
- Internal server error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.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.DescribeOrganizationConfigurationResult describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest)
Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.
describeOrganizationConfigurationRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.DescribeProductsResult describeProducts(DescribeProductsRequest describeProductsRequest)
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.
describeProductsRequest
- InternalException
- Internal server error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.DescribeStandardsResult describeStandards(DescribeStandardsRequest describeStandardsRequest)
Returns a list of the available standards in Security Hub.
For each standard, the results include the standard ARN, the name, and a description.
describeStandardsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.DescribeStandardsControlsResult describeStandardsControls(DescribeStandardsControlsRequest describeStandardsControlsRequest)
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.
describeStandardsControlsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.DisableImportFindingsForProductResult disableImportFindingsForProduct(DisableImportFindingsForProductRequest disableImportFindingsForProductRequest)
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.
disableImportFindingsForProductRequest
- 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
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.DisableOrganizationAdminAccountResult disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest)
Disables a Security Hub administrator account. Can only be called by the organization management account.
disableOrganizationAdminAccountRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.DisableSecurityHubResult disableSecurityHub(DisableSecurityHubRequest disableSecurityHubRequest)
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.
disableSecurityHubRequest
- InternalException
- Internal server error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.DisassociateFromMasterAccountResult disassociateFromMasterAccount(DisassociateFromMasterAccountRequest disassociateFromMasterAccountRequest)
Disassociates 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.
disassociateFromMasterAccountRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.DisassociateMembersResult disassociateMembers(DisassociateMembersRequest disassociateMembersRequest)
Disassociates 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.
disassociateMembersRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.EnableImportFindingsForProductResult enableImportFindingsForProduct(EnableImportFindingsForProductRequest enableImportFindingsForProductRequest)
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.
enableImportFindingsForProductRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.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 or
throttling limits. The error code describes the limit exceeded.EnableOrganizationAdminAccountResult enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest)
Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.
enableOrganizationAdminAccountRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.EnableSecurityHubResult enableSecurityHub(EnableSecurityHubRequest enableSecurityHubRequest)
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.
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.
enableSecurityHubRequest
- InternalException
- Internal server error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.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.GetEnabledStandardsResult getEnabledStandards(GetEnabledStandardsRequest getEnabledStandardsRequest)
Returns a list of the standards that are currently enabled.
getEnabledStandardsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.GetFindingsResult getFindings(GetFindingsRequest getFindingsRequest)
Returns a list of findings that match the specified criteria.
getFindingsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.GetInsightResultsResult getInsightResults(GetInsightResultsRequest getInsightResultsRequest)
Lists the results of the Security Hub insight specified by the insight ARN.
getInsightResultsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.GetInsightsResult getInsights(GetInsightsRequest getInsightsRequest)
Lists and describes insights for the specified insight ARNs.
getInsightsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.GetInvitationsCountResult getInvitationsCount(GetInvitationsCountRequest getInvitationsCountRequest)
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
getInvitationsCountRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.GetMasterAccountResult getMasterAccount(GetMasterAccountRequest getMasterAccountRequest)
Provides 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.
getMasterAccountRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.GetMembersResult getMembers(GetMembersRequest getMembersRequest)
Returns 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.
getMembersRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.InviteMembersResult inviteMembers(InviteMembersRequest inviteMembersRequest)
Invites 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.
inviteMembersRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.ListEnabledProductsForImportResult listEnabledProductsForImport(ListEnabledProductsForImportRequest listEnabledProductsForImportRequest)
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
listEnabledProductsForImportRequest
- InternalException
- Internal server error.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ListInvitationsResult listInvitations(ListInvitationsRequest listInvitationsRequest)
Lists 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.
listInvitationsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ListMembersResult listMembers(ListMembersRequest listMembersRequest)
Lists 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.
listMembersRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ListOrganizationAdminAccountsResult listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest)
Lists the Security Hub administrator accounts. Can only be called by the organization management account.
listOrganizationAdminAccountsRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags associated with a resource.
listTagsForResourceRequest
- 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags to a resource.
tagResourceRequest
- 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a resource.
untagResourceRequest
- 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.UpdateActionTargetResult updateActionTarget(UpdateActionTargetRequest updateActionTargetRequest)
Updates the name and description of a custom action target in Security Hub.
updateActionTargetRequest
- 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
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.UpdateFindingsResult updateFindings(UpdateFindingsRequest updateFindingsRequest)
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.
updateFindingsRequest
- 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 or
throttling limits. The error code describes the limit exceeded.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.UpdateInsightResult updateInsight(UpdateInsightRequest updateInsightRequest)
Updates the Security Hub insight identified by the specified insight ARN.
updateInsightRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.UpdateOrganizationConfigurationResult updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest)
Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.
updateOrganizationConfigurationRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.UpdateSecurityHubConfigurationResult updateSecurityHubConfiguration(UpdateSecurityHubConfigurationRequest updateSecurityHubConfigurationRequest)
Updates configuration options for Security Hub.
updateSecurityHubConfigurationRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.LimitExceededException
- The request was rejected because it attempted to create resources beyond the current AWS account or
throttling limits. The error code describes the limit exceeded.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.UpdateStandardsControlResult updateStandardsControl(UpdateStandardsControlRequest updateStandardsControlRequest)
Used to control whether an individual security standard control is enabled or disabled.
updateStandardsControlRequest
- InternalException
- Internal server error.InvalidInputException
- The request was rejected because you supplied an invalid or out-of-range value for an input parameter.InvalidAccessException
- There is an issue with the account used to make the request. Either Security Hub is not enabled for the
account, or the account does not have permission to perform this action.ResourceNotFoundException
- The request was rejected because we can't find the specified resource.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.