Interface SecurityHubAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.
Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services 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 Amazon Web Services 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 Security Hub User Guide .
When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services Region that is currently active or in the specific Amazon Web Services 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, run the same command for each Region in which you want to apply the change.
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 administrator 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-RateLimitof 1 request per second.BurstLimitof 1 request per second. -
GetFindings-RateLimitof 3 requests per second.BurstLimitof 6 requests per second. -
BatchImportFindings-RateLimitof 10 requests per second.BurstLimitof 30 requests per second. -
BatchUpdateFindings-RateLimitof 10 requests per second.BurstLimitof 30 requests per second. -
UpdateStandardsControl-RateLimitof 1 request per second.BurstLimitof 5 requests per second. -
All other operations -
RateLimitof 10 requests per second.BurstLimitof 30 requests per second.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionacceptAdministratorInvitation(Consumer<AcceptAdministratorInvitationRequest.Builder> acceptAdministratorInvitationRequest) Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.acceptAdministratorInvitation(AcceptAdministratorInvitationRequest acceptAdministratorInvitationRequest) Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.acceptInvitation(Consumer<AcceptInvitationRequest.Builder> acceptInvitationRequest) Deprecated.This API has been deprecated, use AcceptAdministratorInvitation API instead.acceptInvitation(AcceptInvitationRequest acceptInvitationRequest) Deprecated.This API has been deprecated, use AcceptAdministratorInvitation API instead.batchDeleteAutomationRules(Consumer<BatchDeleteAutomationRulesRequest.Builder> batchDeleteAutomationRulesRequest) Deletes one or more automation rules.batchDeleteAutomationRules(BatchDeleteAutomationRulesRequest batchDeleteAutomationRulesRequest) Deletes one or more automation rules.batchDisableStandards(Consumer<BatchDisableStandardsRequest.Builder> batchDisableStandardsRequest) Disables the standards specified by the providedStandardsSubscriptionArns.batchDisableStandards(BatchDisableStandardsRequest batchDisableStandardsRequest) Disables the standards specified by the providedStandardsSubscriptionArns.batchEnableStandards(Consumer<BatchEnableStandardsRequest.Builder> batchEnableStandardsRequest) Enables the standards specified by the providedStandardsArn.batchEnableStandards(BatchEnableStandardsRequest batchEnableStandardsRequest) Enables the standards specified by the providedStandardsArn.batchGetAutomationRules(Consumer<BatchGetAutomationRulesRequest.Builder> batchGetAutomationRulesRequest) Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).batchGetAutomationRules(BatchGetAutomationRulesRequest batchGetAutomationRulesRequest) Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).batchGetSecurityControls(Consumer<BatchGetSecurityControlsRequest.Builder> batchGetSecurityControlsRequest) Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.batchGetSecurityControls(BatchGetSecurityControlsRequest batchGetSecurityControlsRequest) Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.batchGetStandardsControlAssociations(Consumer<BatchGetStandardsControlAssociationsRequest.Builder> batchGetStandardsControlAssociationsRequest) For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.batchGetStandardsControlAssociations(BatchGetStandardsControlAssociationsRequest batchGetStandardsControlAssociationsRequest) For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.batchImportFindings(Consumer<BatchImportFindingsRequest.Builder> batchImportFindingsRequest) Imports security findings generated by a finding provider into Security Hub.batchImportFindings(BatchImportFindingsRequest batchImportFindingsRequest) Imports security findings generated by a finding provider into Security Hub.batchUpdateAutomationRules(Consumer<BatchUpdateAutomationRulesRequest.Builder> batchUpdateAutomationRulesRequest) Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.batchUpdateAutomationRules(BatchUpdateAutomationRulesRequest batchUpdateAutomationRulesRequest) Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.batchUpdateFindings(Consumer<BatchUpdateFindingsRequest.Builder> batchUpdateFindingsRequest) Used by Security Hub customers to update information about their investigation into a finding.batchUpdateFindings(BatchUpdateFindingsRequest batchUpdateFindingsRequest) Used by Security Hub customers to update information about their investigation into a finding.batchUpdateStandardsControlAssociations(Consumer<BatchUpdateStandardsControlAssociationsRequest.Builder> batchUpdateStandardsControlAssociationsRequest) For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.batchUpdateStandardsControlAssociations(BatchUpdateStandardsControlAssociationsRequest batchUpdateStandardsControlAssociationsRequest) For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.builder()Create a builder that can be used to configure and create aSecurityHubAsyncClient.static SecurityHubAsyncClientcreate()Create aSecurityHubAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createActionTarget(Consumer<CreateActionTargetRequest.Builder> createActionTargetRequest) Creates a custom action target in Security Hub.createActionTarget(CreateActionTargetRequest createActionTargetRequest) Creates a custom action target in Security Hub.createAutomationRule(Consumer<CreateAutomationRuleRequest.Builder> createAutomationRuleRequest) Creates an automation rule based on input parameters.createAutomationRule(CreateAutomationRuleRequest createAutomationRuleRequest) Creates an automation rule based on input parameters.createFindingAggregator(Consumer<CreateFindingAggregatorRequest.Builder> createFindingAggregatorRequest) Used to enable finding aggregation.createFindingAggregator(CreateFindingAggregatorRequest createFindingAggregatorRequest) Used to enable finding aggregation.default CompletableFuture<CreateInsightResponse> createInsight(Consumer<CreateInsightRequest.Builder> createInsightRequest) Creates a custom insight in Security Hub.default CompletableFuture<CreateInsightResponse> createInsight(CreateInsightRequest createInsightRequest) Creates a custom insight in Security Hub.default CompletableFuture<CreateMembersResponse> createMembers(Consumer<CreateMembersRequest.Builder> createMembersRequest) Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account.default CompletableFuture<CreateMembersResponse> 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 administrator account.declineInvitations(Consumer<DeclineInvitationsRequest.Builder> declineInvitationsRequest) Declines invitations to become a member account.declineInvitations(DeclineInvitationsRequest declineInvitationsRequest) Declines invitations to become a member account.deleteActionTarget(Consumer<DeleteActionTargetRequest.Builder> deleteActionTargetRequest) Deletes a custom action target from Security Hub.deleteActionTarget(DeleteActionTargetRequest deleteActionTargetRequest) Deletes a custom action target from Security Hub.deleteFindingAggregator(Consumer<DeleteFindingAggregatorRequest.Builder> deleteFindingAggregatorRequest) Deletes a finding aggregator.deleteFindingAggregator(DeleteFindingAggregatorRequest deleteFindingAggregatorRequest) Deletes a finding aggregator.default CompletableFuture<DeleteInsightResponse> deleteInsight(Consumer<DeleteInsightRequest.Builder> deleteInsightRequest) Deletes the insight specified by theInsightArn.default CompletableFuture<DeleteInsightResponse> deleteInsight(DeleteInsightRequest deleteInsightRequest) Deletes the insight specified by theInsightArn.deleteInvitations(Consumer<DeleteInvitationsRequest.Builder> deleteInvitationsRequest) Deletes invitations received by the Amazon Web Services account to become a member account.deleteInvitations(DeleteInvitationsRequest deleteInvitationsRequest) Deletes invitations received by the Amazon Web Services account to become a member account.default CompletableFuture<DeleteMembersResponse> deleteMembers(Consumer<DeleteMembersRequest.Builder> deleteMembersRequest) Deletes the specified member accounts from Security Hub.default CompletableFuture<DeleteMembersResponse> deleteMembers(DeleteMembersRequest deleteMembersRequest) Deletes the specified member accounts from Security Hub.describeActionTargets(Consumer<DescribeActionTargetsRequest.Builder> describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.describeActionTargets(DescribeActionTargetsRequest describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.default DescribeActionTargetsPublisherdescribeActionTargetsPaginator(Consumer<DescribeActionTargetsRequest.Builder> describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.default DescribeActionTargetsPublisherdescribeActionTargetsPaginator(DescribeActionTargetsRequest describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.default CompletableFuture<DescribeHubResponse> describeHub(Consumer<DescribeHubRequest.Builder> describeHubRequest) Returns details about the Hub resource in your account, including theHubArnand the time when you enabled Security Hub.default CompletableFuture<DescribeHubResponse> describeHub(DescribeHubRequest describeHubRequest) Returns details about the Hub resource in your account, including theHubArnand the time when you enabled Security Hub.describeOrganizationConfiguration(Consumer<DescribeOrganizationConfigurationRequest.Builder> describeOrganizationConfigurationRequest) Returns information about the Organizations configuration for Security Hub.describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest) Returns information about the Organizations configuration for Security Hub.describeProducts(Consumer<DescribeProductsRequest.Builder> describeProductsRequest) Returns information about product integrations in Security Hub.describeProducts(DescribeProductsRequest describeProductsRequest) Returns information about product integrations in Security Hub.default DescribeProductsPublisherdescribeProductsPaginator(Consumer<DescribeProductsRequest.Builder> describeProductsRequest) Returns information about product integrations in Security Hub.default DescribeProductsPublisherdescribeProductsPaginator(DescribeProductsRequest describeProductsRequest) Returns information about product integrations in Security Hub.describeStandards(Consumer<DescribeStandardsRequest.Builder> describeStandardsRequest) Returns a list of the available standards in Security Hub.describeStandards(DescribeStandardsRequest describeStandardsRequest) Returns a list of the available standards in Security Hub.describeStandardsControls(Consumer<DescribeStandardsControlsRequest.Builder> describeStandardsControlsRequest) Returns a list of security standards controls.describeStandardsControls(DescribeStandardsControlsRequest describeStandardsControlsRequest) Returns a list of security standards controls.describeStandardsControlsPaginator(Consumer<DescribeStandardsControlsRequest.Builder> describeStandardsControlsRequest) Returns a list of security standards controls.describeStandardsControlsPaginator(DescribeStandardsControlsRequest describeStandardsControlsRequest) Returns a list of security standards controls.default DescribeStandardsPublisherdescribeStandardsPaginator(Consumer<DescribeStandardsRequest.Builder> describeStandardsRequest) Returns a list of the available standards in Security Hub.default DescribeStandardsPublisherdescribeStandardsPaginator(DescribeStandardsRequest describeStandardsRequest) Returns a list of the available standards in Security Hub.disableImportFindingsForProduct(Consumer<DisableImportFindingsForProductRequest.Builder> disableImportFindingsForProductRequest) Disables the integration of the specified product with Security Hub.disableImportFindingsForProduct(DisableImportFindingsForProductRequest disableImportFindingsForProductRequest) Disables the integration of the specified product with Security Hub.disableOrganizationAdminAccount(Consumer<DisableOrganizationAdminAccountRequest.Builder> disableOrganizationAdminAccountRequest) Disables a Security Hub administrator account.disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest) Disables a Security Hub administrator account.Disables Security Hub in your account only in the current Amazon Web Services Region.disableSecurityHub(Consumer<DisableSecurityHubRequest.Builder> disableSecurityHubRequest) Disables Security Hub in your account only in the current Amazon Web Services Region.disableSecurityHub(DisableSecurityHubRequest disableSecurityHubRequest) Disables Security Hub in your account only in the current Amazon Web Services Region.disassociateFromAdministratorAccount(Consumer<DisassociateFromAdministratorAccountRequest.Builder> disassociateFromAdministratorAccountRequest) Disassociates the current Security Hub member account from the associated administrator account.disassociateFromAdministratorAccount(DisassociateFromAdministratorAccountRequest disassociateFromAdministratorAccountRequest) Disassociates the current Security Hub member account from the associated administrator account.disassociateFromMasterAccount(Consumer<DisassociateFromMasterAccountRequest.Builder> disassociateFromMasterAccountRequest) Deprecated.This API has been deprecated, use DisassociateFromAdministratorAccount API instead.disassociateFromMasterAccount(DisassociateFromMasterAccountRequest disassociateFromMasterAccountRequest) Deprecated.This API has been deprecated, use DisassociateFromAdministratorAccount API instead.disassociateMembers(Consumer<DisassociateMembersRequest.Builder> disassociateMembersRequest) Disassociates the specified member accounts from the associated administrator account.disassociateMembers(DisassociateMembersRequest disassociateMembersRequest) Disassociates the specified member accounts from the associated administrator account.enableImportFindingsForProduct(Consumer<EnableImportFindingsForProductRequest.Builder> enableImportFindingsForProductRequest) Enables the integration of a partner product with Security Hub.enableImportFindingsForProduct(EnableImportFindingsForProductRequest enableImportFindingsForProductRequest) Enables the integration of a partner product with Security Hub.enableOrganizationAdminAccount(Consumer<EnableOrganizationAdminAccountRequest.Builder> enableOrganizationAdminAccountRequest) Designates the Security Hub administrator account for an organization.enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest) Designates the Security Hub administrator account for an organization.Enables Security Hub for your account in the current Region or the Region you specify in the request.enableSecurityHub(Consumer<EnableSecurityHubRequest.Builder> enableSecurityHubRequest) Enables Security Hub for your account in the current Region or the Region you specify in the request.enableSecurityHub(EnableSecurityHubRequest enableSecurityHubRequest) Enables Security Hub for your account in the current Region or the Region you specify in the request.getAdministratorAccount(Consumer<GetAdministratorAccountRequest.Builder> getAdministratorAccountRequest) Provides the details for the Security Hub administrator account for the current member account.getAdministratorAccount(GetAdministratorAccountRequest getAdministratorAccountRequest) Provides the details for the Security Hub administrator account for the current member account.getEnabledStandards(Consumer<GetEnabledStandardsRequest.Builder> getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.getEnabledStandards(GetEnabledStandardsRequest getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.default GetEnabledStandardsPublishergetEnabledStandardsPaginator(Consumer<GetEnabledStandardsRequest.Builder> getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.default GetEnabledStandardsPublishergetEnabledStandardsPaginator(GetEnabledStandardsRequest getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.getFindingAggregator(Consumer<GetFindingAggregatorRequest.Builder> getFindingAggregatorRequest) Returns the current finding aggregation configuration.getFindingAggregator(GetFindingAggregatorRequest getFindingAggregatorRequest) Returns the current finding aggregation configuration.getFindingHistory(Consumer<GetFindingHistoryRequest.Builder> getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days.getFindingHistory(GetFindingHistoryRequest getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days.default GetFindingHistoryPublishergetFindingHistoryPaginator(Consumer<GetFindingHistoryRequest.Builder> getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days.default GetFindingHistoryPublishergetFindingHistoryPaginator(GetFindingHistoryRequest getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days.default CompletableFuture<GetFindingsResponse> Returns a list of findings that match the specified criteria.default CompletableFuture<GetFindingsResponse> getFindings(Consumer<GetFindingsRequest.Builder> getFindingsRequest) Returns a list of findings that match the specified criteria.default CompletableFuture<GetFindingsResponse> getFindings(GetFindingsRequest getFindingsRequest) Returns a list of findings that match the specified criteria.default GetFindingsPublisherReturns a list of findings that match the specified criteria.default GetFindingsPublishergetFindingsPaginator(Consumer<GetFindingsRequest.Builder> getFindingsRequest) Returns a list of findings that match the specified criteria.default GetFindingsPublishergetFindingsPaginator(GetFindingsRequest getFindingsRequest) Returns a list of findings that match the specified criteria.getInsightResults(Consumer<GetInsightResultsRequest.Builder> getInsightResultsRequest) Lists the results of the Security Hub insight specified by the insight ARN.getInsightResults(GetInsightResultsRequest getInsightResultsRequest) Lists the results of the Security Hub insight specified by the insight ARN.default CompletableFuture<GetInsightsResponse> getInsights(Consumer<GetInsightsRequest.Builder> getInsightsRequest) Lists and describes insights for the specified insight ARNs.default CompletableFuture<GetInsightsResponse> getInsights(GetInsightsRequest getInsightsRequest) Lists and describes insights for the specified insight ARNs.default GetInsightsPublishergetInsightsPaginator(Consumer<GetInsightsRequest.Builder> getInsightsRequest) Lists and describes insights for the specified insight ARNs.default GetInsightsPublishergetInsightsPaginator(GetInsightsRequest getInsightsRequest) Lists and describes insights for the specified insight ARNs.Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.getInvitationsCount(Consumer<GetInvitationsCountRequest.Builder> getInvitationsCountRequest) Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.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.Deprecated.This API has been deprecated, use GetAdministratorAccount API instead.getMasterAccount(Consumer<GetMasterAccountRequest.Builder> getMasterAccountRequest) Deprecated.This API has been deprecated, use GetAdministratorAccount API instead.getMasterAccount(GetMasterAccountRequest getMasterAccountRequest) Deprecated.This API has been deprecated, use GetAdministratorAccount API instead.default CompletableFuture<GetMembersResponse> getMembers(Consumer<GetMembersRequest.Builder> getMembersRequest) Returns the details for the Security Hub member accounts for the specified account IDs.default CompletableFuture<GetMembersResponse> getMembers(GetMembersRequest getMembersRequest) Returns the details for the Security Hub member accounts for the specified account IDs.default CompletableFuture<InviteMembersResponse> inviteMembers(Consumer<InviteMembersRequest.Builder> inviteMembersRequest) Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.default CompletableFuture<InviteMembersResponse> inviteMembers(InviteMembersRequest inviteMembersRequest) Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.listAutomationRules(Consumer<ListAutomationRulesRequest.Builder> listAutomationRulesRequest) A list of automation rules and their metadata for the calling account.listAutomationRules(ListAutomationRulesRequest listAutomationRulesRequest) A list of automation rules and their metadata for the calling account.Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.listEnabledProductsForImport(Consumer<ListEnabledProductsForImportRequest.Builder> listEnabledProductsForImportRequest) Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.listEnabledProductsForImport(ListEnabledProductsForImportRequest listEnabledProductsForImportRequest) Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.listEnabledProductsForImportPaginator(Consumer<ListEnabledProductsForImportRequest.Builder> listEnabledProductsForImportRequest) Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.listEnabledProductsForImportPaginator(ListEnabledProductsForImportRequest listEnabledProductsForImportRequest) Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.listFindingAggregators(Consumer<ListFindingAggregatorsRequest.Builder> listFindingAggregatorsRequest) If finding aggregation is enabled, thenListFindingAggregatorsreturns the ARN of the finding aggregator.listFindingAggregators(ListFindingAggregatorsRequest listFindingAggregatorsRequest) If finding aggregation is enabled, thenListFindingAggregatorsreturns the ARN of the finding aggregator.default ListFindingAggregatorsPublisherlistFindingAggregatorsPaginator(Consumer<ListFindingAggregatorsRequest.Builder> listFindingAggregatorsRequest) If finding aggregation is enabled, thenListFindingAggregatorsreturns the ARN of the finding aggregator.default ListFindingAggregatorsPublisherlistFindingAggregatorsPaginator(ListFindingAggregatorsRequest listFindingAggregatorsRequest) If finding aggregation is enabled, thenListFindingAggregatorsreturns the ARN of the finding aggregator.default CompletableFuture<ListInvitationsResponse> Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.default CompletableFuture<ListInvitationsResponse> listInvitations(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.default CompletableFuture<ListInvitationsResponse> listInvitations(ListInvitationsRequest listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.default ListInvitationsPublisherLists all Security Hub membership invitations that were sent to the current Amazon Web Services account.default ListInvitationsPublisherlistInvitationsPaginator(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.default ListInvitationsPublisherlistInvitationsPaginator(ListInvitationsRequest listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.default CompletableFuture<ListMembersResponse> Lists details about all member accounts for the current Security Hub administrator account.default CompletableFuture<ListMembersResponse> listMembers(Consumer<ListMembersRequest.Builder> listMembersRequest) Lists details about all member accounts for the current Security Hub administrator account.default CompletableFuture<ListMembersResponse> listMembers(ListMembersRequest listMembersRequest) Lists details about all member accounts for the current Security Hub administrator account.default ListMembersPublisherLists details about all member accounts for the current Security Hub administrator account.default ListMembersPublisherlistMembersPaginator(Consumer<ListMembersRequest.Builder> listMembersRequest) Lists details about all member accounts for the current Security Hub administrator account.default ListMembersPublisherlistMembersPaginator(ListMembersRequest listMembersRequest) Lists details about all member accounts for the current Security Hub administrator account.listOrganizationAdminAccounts(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest) Lists the Security Hub administrator accounts.listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest) Lists the Security Hub administrator accounts.listOrganizationAdminAccountsPaginator(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest) Lists the Security Hub administrator accounts.listOrganizationAdminAccountsPaginator(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest) Lists the Security Hub administrator accounts.listSecurityControlDefinitions(Consumer<ListSecurityControlDefinitionsRequest.Builder> listSecurityControlDefinitionsRequest) Lists all of the security controls that apply to a specified standard.listSecurityControlDefinitions(ListSecurityControlDefinitionsRequest listSecurityControlDefinitionsRequest) Lists all of the security controls that apply to a specified standard.listSecurityControlDefinitionsPaginator(Consumer<ListSecurityControlDefinitionsRequest.Builder> listSecurityControlDefinitionsRequest) Lists all of the security controls that apply to a specified standard.listSecurityControlDefinitionsPaginator(ListSecurityControlDefinitionsRequest listSecurityControlDefinitionsRequest) Lists all of the security controls that apply to a specified standard.listStandardsControlAssociations(Consumer<ListStandardsControlAssociationsRequest.Builder> listStandardsControlAssociationsRequest) Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.listStandardsControlAssociations(ListStandardsControlAssociationsRequest listStandardsControlAssociationsRequest) Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.listStandardsControlAssociationsPaginator(Consumer<ListStandardsControlAssociationsRequest.Builder> listStandardsControlAssociationsRequest) Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.listStandardsControlAssociationsPaginator(ListStandardsControlAssociationsRequest listStandardsControlAssociationsRequest) Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags associated with a resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags associated with a resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to a resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to a resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from a resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from a resource.updateActionTarget(Consumer<UpdateActionTargetRequest.Builder> updateActionTargetRequest) Updates the name and description of a custom action target in Security Hub.updateActionTarget(UpdateActionTargetRequest updateActionTargetRequest) Updates the name and description of a custom action target in Security Hub.updateFindingAggregator(Consumer<UpdateFindingAggregatorRequest.Builder> updateFindingAggregatorRequest) Updates the finding aggregation configuration.updateFindingAggregator(UpdateFindingAggregatorRequest updateFindingAggregatorRequest) Updates the finding aggregation configuration.default CompletableFuture<UpdateFindingsResponse> updateFindings(Consumer<UpdateFindingsRequest.Builder> updateFindingsRequest) UpdateFindingsis deprecated.default CompletableFuture<UpdateFindingsResponse> updateFindings(UpdateFindingsRequest updateFindingsRequest) UpdateFindingsis deprecated.default CompletableFuture<UpdateInsightResponse> updateInsight(Consumer<UpdateInsightRequest.Builder> updateInsightRequest) Updates the Security Hub insight identified by the specified insight ARN.default CompletableFuture<UpdateInsightResponse> updateInsight(UpdateInsightRequest updateInsightRequest) Updates the Security Hub insight identified by the specified insight ARN.updateOrganizationConfiguration(Consumer<UpdateOrganizationConfigurationRequest.Builder> updateOrganizationConfigurationRequest) Used to update the configuration related to Organizations.updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest) Used to update the configuration related to Organizations.updateSecurityHubConfiguration(Consumer<UpdateSecurityHubConfigurationRequest.Builder> updateSecurityHubConfigurationRequest) Updates configuration options for Security Hub.updateSecurityHubConfiguration(UpdateSecurityHubConfigurationRequest updateSecurityHubConfigurationRequest) Updates configuration options for Security Hub.updateStandardsControl(Consumer<UpdateStandardsControlRequest.Builder> updateStandardsControlRequest) Used to control whether an individual security standard control is enabled or disabled.updateStandardsControl(UpdateStandardsControlRequest updateStandardsControlRequest) Used to control whether an individual security standard control is enabled or disabled.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
acceptAdministratorInvitation
default CompletableFuture<AcceptAdministratorInvitationResponse> acceptAdministratorInvitation(AcceptAdministratorInvitationRequest acceptAdministratorInvitationRequest) Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
- Parameters:
acceptAdministratorInvitationRequest-- Returns:
- A Java Future containing the result of the AcceptAdministratorInvitation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services 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 The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acceptAdministratorInvitation
default CompletableFuture<AcceptAdministratorInvitationResponse> acceptAdministratorInvitation(Consumer<AcceptAdministratorInvitationRequest.Builder> acceptAdministratorInvitationRequest) Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
This is a convenience which creates an instance of the
AcceptAdministratorInvitationRequest.Builderavoiding the need to create one manually viaAcceptAdministratorInvitationRequest.builder()- Parameters:
acceptAdministratorInvitationRequest- AConsumerthat will call methods onAcceptAdministratorInvitationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AcceptAdministratorInvitation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services 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 The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acceptInvitation
@Deprecated default CompletableFuture<AcceptInvitationResponse> acceptInvitation(AcceptInvitationRequest acceptInvitationRequest) Deprecated.This API has been deprecated, use AcceptAdministratorInvitation API instead.This method is deprecated. Instead, use
AcceptAdministratorInvitation.The Security Hub console continues to use
AcceptInvitation. It will eventually change to useAcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to useAcceptInvitation. You should also addAcceptAdministratorInvitationto your policies to ensure that the correct permissions are in place after the console begins to useAcceptAdministratorInvitation.Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
- Parameters:
acceptInvitationRequest-- Returns:
- A Java Future containing the result of the AcceptInvitation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services 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 The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acceptInvitation
@Deprecated default CompletableFuture<AcceptInvitationResponse> acceptInvitation(Consumer<AcceptInvitationRequest.Builder> acceptInvitationRequest) Deprecated.This API has been deprecated, use AcceptAdministratorInvitation API instead.This method is deprecated. Instead, use
AcceptAdministratorInvitation.The Security Hub console continues to use
AcceptInvitation. It will eventually change to useAcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to useAcceptInvitation. You should also addAcceptAdministratorInvitationto your policies to ensure that the correct permissions are in place after the console begins to useAcceptAdministratorInvitation.Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
This is a convenience which creates an instance of the
AcceptInvitationRequest.Builderavoiding the need to create one manually viaAcceptInvitationRequest.builder()- Parameters:
acceptInvitationRequest- AConsumerthat will call methods onAcceptInvitationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AcceptInvitation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services 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 The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteAutomationRules
default CompletableFuture<BatchDeleteAutomationRulesResponse> batchDeleteAutomationRules(BatchDeleteAutomationRulesRequest batchDeleteAutomationRulesRequest) Deletes one or more automation rules.
- Parameters:
batchDeleteAutomationRulesRequest-- Returns:
- A Java Future containing the result of the BatchDeleteAutomationRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteAutomationRules
default CompletableFuture<BatchDeleteAutomationRulesResponse> batchDeleteAutomationRules(Consumer<BatchDeleteAutomationRulesRequest.Builder> batchDeleteAutomationRulesRequest) Deletes one or more automation rules.
This is a convenience which creates an instance of the
BatchDeleteAutomationRulesRequest.Builderavoiding the need to create one manually viaBatchDeleteAutomationRulesRequest.builder()- Parameters:
batchDeleteAutomationRulesRequest- AConsumerthat will call methods onBatchDeleteAutomationRulesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchDeleteAutomationRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDisableStandards
default CompletableFuture<BatchDisableStandardsResponse> batchDisableStandards(BatchDisableStandardsRequest batchDisableStandardsRequest) Disables the standards specified by the provided
StandardsSubscriptionArns.For more information, see Security Standards section of the Security Hub User Guide.
- Parameters:
batchDisableStandardsRequest-- Returns:
- A Java Future containing the result of the BatchDisableStandards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDisableStandards
default CompletableFuture<BatchDisableStandardsResponse> batchDisableStandards(Consumer<BatchDisableStandardsRequest.Builder> batchDisableStandardsRequest) Disables the standards specified by the provided
StandardsSubscriptionArns.For more information, see Security Standards section of the Security Hub User Guide.
This is a convenience which creates an instance of the
BatchDisableStandardsRequest.Builderavoiding the need to create one manually viaBatchDisableStandardsRequest.builder()- Parameters:
batchDisableStandardsRequest- AConsumerthat will call methods onBatchDisableStandardsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchDisableStandards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchEnableStandards
default CompletableFuture<BatchEnableStandardsResponse> batchEnableStandards(BatchEnableStandardsRequest batchEnableStandardsRequest) Enables the standards specified by the provided
StandardsArn. To obtain the ARN for a standard, use theDescribeStandardsoperation.For more information, see the Security Standards section of the Security Hub User Guide.
- Parameters:
batchEnableStandardsRequest-- Returns:
- A Java Future containing the result of the BatchEnableStandards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchEnableStandards
default CompletableFuture<BatchEnableStandardsResponse> batchEnableStandards(Consumer<BatchEnableStandardsRequest.Builder> batchEnableStandardsRequest) Enables the standards specified by the provided
StandardsArn. To obtain the ARN for a standard, use theDescribeStandardsoperation.For more information, see the Security Standards section of the Security Hub User Guide.
This is a convenience which creates an instance of the
BatchEnableStandardsRequest.Builderavoiding the need to create one manually viaBatchEnableStandardsRequest.builder()- Parameters:
batchEnableStandardsRequest- AConsumerthat will call methods onBatchEnableStandardsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchEnableStandards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetAutomationRules
default CompletableFuture<BatchGetAutomationRulesResponse> batchGetAutomationRules(BatchGetAutomationRulesRequest batchGetAutomationRulesRequest) Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
- Parameters:
batchGetAutomationRulesRequest-- Returns:
- A Java Future containing the result of the BatchGetAutomationRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You don't have permission to perform the action specified in the request.
- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetAutomationRules
default CompletableFuture<BatchGetAutomationRulesResponse> batchGetAutomationRules(Consumer<BatchGetAutomationRulesRequest.Builder> batchGetAutomationRulesRequest) Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
This is a convenience which creates an instance of the
BatchGetAutomationRulesRequest.Builderavoiding the need to create one manually viaBatchGetAutomationRulesRequest.builder()- Parameters:
batchGetAutomationRulesRequest- AConsumerthat will call methods onBatchGetAutomationRulesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchGetAutomationRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You don't have permission to perform the action specified in the request.
- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetSecurityControls
default CompletableFuture<BatchGetSecurityControlsResponse> batchGetSecurityControls(BatchGetSecurityControlsRequest batchGetSecurityControlsRequest) Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
- Parameters:
batchGetSecurityControlsRequest-- Returns:
- A Java Future containing the result of the BatchGetSecurityControls operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetSecurityControls
default CompletableFuture<BatchGetSecurityControlsResponse> batchGetSecurityControls(Consumer<BatchGetSecurityControlsRequest.Builder> batchGetSecurityControlsRequest) Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
This is a convenience which creates an instance of the
BatchGetSecurityControlsRequest.Builderavoiding the need to create one manually viaBatchGetSecurityControlsRequest.builder()- Parameters:
batchGetSecurityControlsRequest- AConsumerthat will call methods onBatchGetSecurityControlsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchGetSecurityControls operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetStandardsControlAssociations
default CompletableFuture<BatchGetStandardsControlAssociationsResponse> batchGetStandardsControlAssociations(BatchGetStandardsControlAssociationsRequest batchGetStandardsControlAssociationsRequest) For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
- Parameters:
batchGetStandardsControlAssociationsRequest-- Returns:
- A Java Future containing the result of the BatchGetStandardsControlAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetStandardsControlAssociations
default CompletableFuture<BatchGetStandardsControlAssociationsResponse> batchGetStandardsControlAssociations(Consumer<BatchGetStandardsControlAssociationsRequest.Builder> batchGetStandardsControlAssociationsRequest) For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
This is a convenience which creates an instance of the
BatchGetStandardsControlAssociationsRequest.Builderavoiding the need to create one manually viaBatchGetStandardsControlAssociationsRequest.builder()- Parameters:
batchGetStandardsControlAssociationsRequest- AConsumerthat will call methods onBatchGetStandardsControlAssociationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchGetStandardsControlAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchImportFindings
default CompletableFuture<BatchImportFindingsResponse> batchImportFindings(BatchImportFindingsRequest batchImportFindingsRequest) Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.
BatchImportFindingsmust be called by one of the following:-
The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling
BatchImportFindingsfrom needs to be the same as theAwsAccountIdattribute for the finding. -
An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call
BatchImportFindingsfrom the allow-listed account and send findings from different customer accounts in the same batch.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created,
BatchImportFindingscannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.-
Note -
UserDefinedFields -
VerificationState -
Workflow
Finding providers also should not use
BatchImportFindingsto update the following attributes.-
Confidence -
Criticality -
RelatedFindings -
Severity -
Types
Instead, finding providers use
FindingProviderFieldsto provide values for these attributes.- Parameters:
batchImportFindingsRequest-- Returns:
- A Java Future containing the result of the BatchImportFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchImportFindings
default CompletableFuture<BatchImportFindingsResponse> batchImportFindings(Consumer<BatchImportFindingsRequest.Builder> batchImportFindingsRequest) Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.
BatchImportFindingsmust be called by one of the following:-
The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling
BatchImportFindingsfrom needs to be the same as theAwsAccountIdattribute for the finding. -
An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call
BatchImportFindingsfrom the allow-listed account and send findings from different customer accounts in the same batch.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created,
BatchImportFindingscannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.-
Note -
UserDefinedFields -
VerificationState -
Workflow
Finding providers also should not use
BatchImportFindingsto update the following attributes.-
Confidence -
Criticality -
RelatedFindings -
Severity -
Types
Instead, finding providers use
FindingProviderFieldsto provide values for these attributes.
This is a convenience which creates an instance of the
BatchImportFindingsRequest.Builderavoiding the need to create one manually viaBatchImportFindingsRequest.builder()- Parameters:
batchImportFindingsRequest- AConsumerthat will call methods onBatchImportFindingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchImportFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchUpdateAutomationRules
default CompletableFuture<BatchUpdateAutomationRulesResponse> batchUpdateAutomationRules(BatchUpdateAutomationRulesRequest batchUpdateAutomationRulesRequest) Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
- Parameters:
batchUpdateAutomationRulesRequest-- Returns:
- A Java Future containing the result of the BatchUpdateAutomationRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchUpdateAutomationRules
default CompletableFuture<BatchUpdateAutomationRulesResponse> batchUpdateAutomationRules(Consumer<BatchUpdateAutomationRulesRequest.Builder> batchUpdateAutomationRulesRequest) Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
This is a convenience which creates an instance of the
BatchUpdateAutomationRulesRequest.Builderavoiding the need to create one manually viaBatchUpdateAutomationRulesRequest.builder()- Parameters:
batchUpdateAutomationRulesRequest- AConsumerthat will call methods onBatchUpdateAutomationRulesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchUpdateAutomationRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchUpdateFindings
default CompletableFuture<BatchUpdateFindingsResponse> batchUpdateFindings(BatchUpdateFindingsRequest batchUpdateFindingsRequest) Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from
BatchUpdateFindingsdo not affect the value ofUpdatedAtfor a finding.Administrator and member accounts can use
BatchUpdateFindingsto update the following finding fields and objects.-
Confidence -
Criticality -
Note -
RelatedFindings -
Severity -
Types -
UserDefinedFields -
VerificationState -
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
- Parameters:
batchUpdateFindingsRequest-- Returns:
- A Java Future containing the result of the BatchUpdateFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchUpdateFindings
default CompletableFuture<BatchUpdateFindingsResponse> batchUpdateFindings(Consumer<BatchUpdateFindingsRequest.Builder> batchUpdateFindingsRequest) Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from
BatchUpdateFindingsdo not affect the value ofUpdatedAtfor a finding.Administrator and member accounts can use
BatchUpdateFindingsto update the following finding fields and objects.-
Confidence -
Criticality -
Note -
RelatedFindings -
Severity -
Types -
UserDefinedFields -
VerificationState -
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
This is a convenience which creates an instance of the
BatchUpdateFindingsRequest.Builderavoiding the need to create one manually viaBatchUpdateFindingsRequest.builder()- Parameters:
batchUpdateFindingsRequest- AConsumerthat will call methods onBatchUpdateFindingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchUpdateFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchUpdateStandardsControlAssociations
default CompletableFuture<BatchUpdateStandardsControlAssociationsResponse> batchUpdateStandardsControlAssociations(BatchUpdateStandardsControlAssociationsRequest batchUpdateStandardsControlAssociationsRequest) For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
- Parameters:
batchUpdateStandardsControlAssociationsRequest-- Returns:
- A Java Future containing the result of the BatchUpdateStandardsControlAssociations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchUpdateStandardsControlAssociations
default CompletableFuture<BatchUpdateStandardsControlAssociationsResponse> batchUpdateStandardsControlAssociations(Consumer<BatchUpdateStandardsControlAssociationsRequest.Builder> batchUpdateStandardsControlAssociationsRequest) For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
This is a convenience which creates an instance of the
BatchUpdateStandardsControlAssociationsRequest.Builderavoiding the need to create one manually viaBatchUpdateStandardsControlAssociationsRequest.builder()- Parameters:
batchUpdateStandardsControlAssociationsRequest- AConsumerthat will call methods onBatchUpdateStandardsControlAssociationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchUpdateStandardsControlAssociations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createActionTarget
default CompletableFuture<CreateActionTargetResponse> 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.
- Parameters:
createActionTargetRequest-- Returns:
- A Java Future containing the result of the CreateActionTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceConflictException The resource specified in the request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createActionTarget
default CompletableFuture<CreateActionTargetResponse> createActionTarget(Consumer<CreateActionTargetRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateActionTargetRequest.Builderavoiding the need to create one manually viaCreateActionTargetRequest.builder()- Parameters:
createActionTargetRequest- AConsumerthat will call methods onCreateActionTargetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateActionTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceConflictException The resource specified in the request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAutomationRule
default CompletableFuture<CreateAutomationRuleResponse> createAutomationRule(CreateAutomationRuleRequest createAutomationRuleRequest) Creates an automation rule based on input parameters.
- Parameters:
createAutomationRuleRequest-- Returns:
- A Java Future containing the result of the CreateAutomationRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You don't have permission to perform the action specified in the request.
- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAutomationRule
default CompletableFuture<CreateAutomationRuleResponse> createAutomationRule(Consumer<CreateAutomationRuleRequest.Builder> createAutomationRuleRequest) Creates an automation rule based on input parameters.
This is a convenience which creates an instance of the
CreateAutomationRuleRequest.Builderavoiding the need to create one manually viaCreateAutomationRuleRequest.builder()- Parameters:
createAutomationRuleRequest- AConsumerthat will call methods onCreateAutomationRuleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAutomationRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You don't have permission to perform the action specified in the request.
- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFindingAggregator
default CompletableFuture<CreateFindingAggregatorResponse> createFindingAggregator(CreateFindingAggregatorRequest createFindingAggregatorRequest) Used to enable finding aggregation. Must be called from the aggregation Region.
For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.
- Parameters:
createFindingAggregatorRequest-- Returns:
- A Java Future containing the result of the CreateFindingAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the request.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFindingAggregator
default CompletableFuture<CreateFindingAggregatorResponse> createFindingAggregator(Consumer<CreateFindingAggregatorRequest.Builder> createFindingAggregatorRequest) Used to enable finding aggregation. Must be called from the aggregation Region.
For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.
This is a convenience which creates an instance of the
CreateFindingAggregatorRequest.Builderavoiding the need to create one manually viaCreateFindingAggregatorRequest.builder()- Parameters:
createFindingAggregatorRequest- AConsumerthat will call methods onCreateFindingAggregatorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateFindingAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the request.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createInsight
default CompletableFuture<CreateInsightResponse> 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.- Parameters:
createInsightRequest-- Returns:
- A Java Future containing the result of the CreateInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceConflictException The resource specified in the request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createInsight
default CompletableFuture<CreateInsightResponse> createInsight(Consumer<CreateInsightRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateInsightRequest.Builderavoiding the need to create one manually viaCreateInsightRequest.builder()- Parameters:
createInsightRequest- AConsumerthat will call methods onCreateInsightRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceConflictException The resource specified in the request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMembers
default CompletableFuture<CreateMembersResponse> 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 administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.
CreateMembersis always used to add accounts that are not organization members.For accounts that are managed using Organizations,
CreateMembersis only used in the following cases:-
Security Hub is not configured to automatically add new organization accounts.
-
The account was disassociated or deleted in Security Hub.
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the
EnableSecurityHuboperation.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
InviteMembersoperation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.
-
If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
-
For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
A permissions policy is added that permits the administrator account to view the findings generated in the member account.
To remove the association between the administrator and member accounts, use the
DisassociateFromMasterAccountorDisassociateMembersoperation.- Parameters:
createMembersRequest-- Returns:
- A Java Future containing the result of the CreateMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceConflictException The resource specified in the request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createMembers
default CompletableFuture<CreateMembersResponse> createMembers(Consumer<CreateMembersRequest.Builder> createMembersRequest) Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.
CreateMembersis always used to add accounts that are not organization members.For accounts that are managed using Organizations,
CreateMembersis only used in the following cases:-
Security Hub is not configured to automatically add new organization accounts.
-
The account was disassociated or deleted in Security Hub.
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the
EnableSecurityHuboperation.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
InviteMembersoperation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.
-
If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
-
For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
A permissions policy is added that permits the administrator account to view the findings generated in the member account.
To remove the association between the administrator and member accounts, use the
DisassociateFromMasterAccountorDisassociateMembersoperation.
This is a convenience which creates an instance of the
CreateMembersRequest.Builderavoiding the need to create one manually viaCreateMembersRequest.builder()- Parameters:
createMembersRequest- AConsumerthat will call methods onCreateMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceConflictException The resource specified in the request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
declineInvitations
default CompletableFuture<DeclineInvitationsResponse> declineInvitations(DeclineInvitationsRequest declineInvitationsRequest) Declines invitations to become a member account.
A prospective member account uses this operation to decline an invitation to become a member.
This operation is only called by member accounts that aren't part of an organization. Organization accounts don't receive invitations.
- Parameters:
declineInvitationsRequest-- Returns:
- A Java Future containing the result of the DeclineInvitations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
declineInvitations
default CompletableFuture<DeclineInvitationsResponse> declineInvitations(Consumer<DeclineInvitationsRequest.Builder> declineInvitationsRequest) Declines invitations to become a member account.
A prospective member account uses this operation to decline an invitation to become a member.
This operation is only called by member accounts that aren't part of an organization. Organization accounts don't receive invitations.
This is a convenience which creates an instance of the
DeclineInvitationsRequest.Builderavoiding the need to create one manually viaDeclineInvitationsRequest.builder()- Parameters:
declineInvitationsRequest- AConsumerthat will call methods onDeclineInvitationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeclineInvitations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteActionTarget
default CompletableFuture<DeleteActionTargetResponse> 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.
- Parameters:
deleteActionTargetRequest-- Returns:
- A Java Future containing the result of the DeleteActionTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteActionTarget
default CompletableFuture<DeleteActionTargetResponse> deleteActionTarget(Consumer<DeleteActionTargetRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteActionTargetRequest.Builderavoiding the need to create one manually viaDeleteActionTargetRequest.builder()- Parameters:
deleteActionTargetRequest- AConsumerthat will call methods onDeleteActionTargetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteActionTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFindingAggregator
default CompletableFuture<DeleteFindingAggregatorResponse> deleteFindingAggregator(DeleteFindingAggregatorRequest deleteFindingAggregatorRequest) Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.
When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.
- Parameters:
deleteFindingAggregatorRequest-- Returns:
- A Java Future containing the result of the DeleteFindingAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFindingAggregator
default CompletableFuture<DeleteFindingAggregatorResponse> deleteFindingAggregator(Consumer<DeleteFindingAggregatorRequest.Builder> deleteFindingAggregatorRequest) Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.
When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.
This is a convenience which creates an instance of the
DeleteFindingAggregatorRequest.Builderavoiding the need to create one manually viaDeleteFindingAggregatorRequest.builder()- Parameters:
deleteFindingAggregatorRequest- AConsumerthat will call methods onDeleteFindingAggregatorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteFindingAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInsight
default CompletableFuture<DeleteInsightResponse> deleteInsight(DeleteInsightRequest deleteInsightRequest) Deletes the insight specified by the
InsightArn.- Parameters:
deleteInsightRequest-- Returns:
- A Java Future containing the result of the DeleteInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInsight
default CompletableFuture<DeleteInsightResponse> deleteInsight(Consumer<DeleteInsightRequest.Builder> deleteInsightRequest) Deletes the insight specified by the
InsightArn.
This is a convenience which creates an instance of the
DeleteInsightRequest.Builderavoiding the need to create one manually viaDeleteInsightRequest.builder()- Parameters:
deleteInsightRequest- AConsumerthat will call methods onDeleteInsightRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInvitations
default CompletableFuture<DeleteInvitationsResponse> deleteInvitations(DeleteInvitationsRequest deleteInvitationsRequest) Deletes invitations received by the Amazon Web Services account to become a member account.
A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.
This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. Organization accounts don't receive invitations.
- Parameters:
deleteInvitationsRequest-- Returns:
- A Java Future containing the result of the DeleteInvitations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services 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 The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInvitations
default CompletableFuture<DeleteInvitationsResponse> deleteInvitations(Consumer<DeleteInvitationsRequest.Builder> deleteInvitationsRequest) Deletes invitations received by the Amazon Web Services account to become a member account.
A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.
This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. Organization accounts don't receive invitations.
This is a convenience which creates an instance of the
DeleteInvitationsRequest.Builderavoiding the need to create one manually viaDeleteInvitationsRequest.builder()- Parameters:
deleteInvitationsRequest- AConsumerthat will call methods onDeleteInvitationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteInvitations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services 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 The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMembers
default CompletableFuture<DeleteMembersResponse> deleteMembers(DeleteMembersRequest deleteMembersRequest) Deletes the specified member accounts from Security Hub.
You can invoke this API only to delete accounts that became members through invitation. You can't invoke this API to delete accounts that belong to an Organizations organization.
- Parameters:
deleteMembersRequest-- Returns:
- A Java Future containing the result of the DeleteMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMembers
default CompletableFuture<DeleteMembersResponse> deleteMembers(Consumer<DeleteMembersRequest.Builder> deleteMembersRequest) Deletes the specified member accounts from Security Hub.
You can invoke this API only to delete accounts that became members through invitation. You can't invoke this API to delete accounts that belong to an Organizations organization.
This is a convenience which creates an instance of the
DeleteMembersRequest.Builderavoiding the need to create one manually viaDeleteMembersRequest.builder()- Parameters:
deleteMembersRequest- AConsumerthat will call methods onDeleteMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActionTargets
default CompletableFuture<DescribeActionTargetsResponse> describeActionTargets(DescribeActionTargetsRequest describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.
- Parameters:
describeActionTargetsRequest-- Returns:
- A Java Future containing the result of the DescribeActionTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActionTargets
default CompletableFuture<DescribeActionTargetsResponse> describeActionTargets(Consumer<DescribeActionTargetsRequest.Builder> describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.
This is a convenience which creates an instance of the
DescribeActionTargetsRequest.Builderavoiding the need to create one manually viaDescribeActionTargetsRequest.builder()- Parameters:
describeActionTargetsRequest- AConsumerthat will call methods onDescribeActionTargetsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeActionTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActionTargetsPaginator
default DescribeActionTargetsPublisher describeActionTargetsPaginator(DescribeActionTargetsRequest describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.
This is a variant of
describeActionTargets(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsPublisher publisher = client.describeActionTargetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsPublisher publisher = client.describeActionTargetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeActionTargets(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsRequest)operation.- Parameters:
describeActionTargetsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActionTargetsPaginator
default DescribeActionTargetsPublisher describeActionTargetsPaginator(Consumer<DescribeActionTargetsRequest.Builder> describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.
This is a variant of
describeActionTargets(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsPublisher publisher = client.describeActionTargetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsPublisher publisher = client.describeActionTargetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeActionTargets(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsRequest)operation.This is a convenience which creates an instance of the
DescribeActionTargetsRequest.Builderavoiding the need to create one manually viaDescribeActionTargetsRequest.builder()- Parameters:
describeActionTargetsRequest- AConsumerthat will call methods onDescribeActionTargetsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHub
Returns details about the Hub resource in your account, including the
HubArnand the time when you enabled Security Hub.- Parameters:
describeHubRequest-- Returns:
- A Java Future containing the result of the DescribeHub operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeHub
default CompletableFuture<DescribeHubResponse> describeHub(Consumer<DescribeHubRequest.Builder> describeHubRequest) Returns details about the Hub resource in your account, including the
HubArnand the time when you enabled Security Hub.
This is a convenience which creates an instance of the
DescribeHubRequest.Builderavoiding the need to create one manually viaDescribeHubRequest.builder()- Parameters:
describeHubRequest- AConsumerthat will call methods onDescribeHubRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeHub operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfiguration
default CompletableFuture<DescribeOrganizationConfigurationResponse> describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest) Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.
- Parameters:
describeOrganizationConfigurationRequest-- Returns:
- A Java Future containing the result of the DescribeOrganizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfiguration
default CompletableFuture<DescribeOrganizationConfigurationResponse> describeOrganizationConfiguration(Consumer<DescribeOrganizationConfigurationRequest.Builder> describeOrganizationConfigurationRequest) Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.
This is a convenience which creates an instance of the
DescribeOrganizationConfigurationRequest.Builderavoiding the need to create one manually viaDescribeOrganizationConfigurationRequest.builder()- Parameters:
describeOrganizationConfigurationRequest- AConsumerthat will call methods onDescribeOrganizationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeOrganizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProducts
default CompletableFuture<DescribeProductsResponse> 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.
- Parameters:
describeProductsRequest-- Returns:
- A Java Future containing the result of the DescribeProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProducts
default CompletableFuture<DescribeProductsResponse> describeProducts(Consumer<DescribeProductsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeProductsRequest.Builderavoiding the need to create one manually viaDescribeProductsRequest.builder()- Parameters:
describeProductsRequest- AConsumerthat will call methods onDescribeProductsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProductsPaginator
default DescribeProductsPublisher describeProductsPaginator(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.
This is a variant of
describeProducts(software.amazon.awssdk.services.securityhub.model.DescribeProductsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.DescribeProductsPublisher publisher = client.describeProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.DescribeProductsPublisher publisher = client.describeProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.DescribeProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.DescribeProductsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeProducts(software.amazon.awssdk.services.securityhub.model.DescribeProductsRequest)operation.- Parameters:
describeProductsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProductsPaginator
default DescribeProductsPublisher describeProductsPaginator(Consumer<DescribeProductsRequest.Builder> 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.
This is a variant of
describeProducts(software.amazon.awssdk.services.securityhub.model.DescribeProductsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.DescribeProductsPublisher publisher = client.describeProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.DescribeProductsPublisher publisher = client.describeProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.DescribeProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.DescribeProductsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeProducts(software.amazon.awssdk.services.securityhub.model.DescribeProductsRequest)operation.This is a convenience which creates an instance of the
DescribeProductsRequest.Builderavoiding the need to create one manually viaDescribeProductsRequest.builder()- Parameters:
describeProductsRequest- AConsumerthat will call methods onDescribeProductsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStandards
default CompletableFuture<DescribeStandardsResponse> 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.
- Parameters:
describeStandardsRequest-- Returns:
- A Java Future containing the result of the DescribeStandards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStandards
default CompletableFuture<DescribeStandardsResponse> describeStandards(Consumer<DescribeStandardsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeStandardsRequest.Builderavoiding the need to create one manually viaDescribeStandardsRequest.builder()- Parameters:
describeStandardsRequest- AConsumerthat will call methods onDescribeStandardsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeStandards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStandardsControls
default CompletableFuture<DescribeStandardsControlsResponse> 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.
- Parameters:
describeStandardsControlsRequest-- Returns:
- A Java Future containing the result of the DescribeStandardsControls operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStandardsControls
default CompletableFuture<DescribeStandardsControlsResponse> describeStandardsControls(Consumer<DescribeStandardsControlsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeStandardsControlsRequest.Builderavoiding the need to create one manually viaDescribeStandardsControlsRequest.builder()- Parameters:
describeStandardsControlsRequest- AConsumerthat will call methods onDescribeStandardsControlsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeStandardsControls operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStandardsControlsPaginator
default DescribeStandardsControlsPublisher describeStandardsControlsPaginator(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.
This is a variant of
describeStandardsControls(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsPublisher publisher = client.describeStandardsControlsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsPublisher publisher = client.describeStandardsControlsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStandardsControls(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsRequest)operation.- Parameters:
describeStandardsControlsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStandardsControlsPaginator
default DescribeStandardsControlsPublisher describeStandardsControlsPaginator(Consumer<DescribeStandardsControlsRequest.Builder> 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.
This is a variant of
describeStandardsControls(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsPublisher publisher = client.describeStandardsControlsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsPublisher publisher = client.describeStandardsControlsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStandardsControls(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsRequest)operation.This is a convenience which creates an instance of the
DescribeStandardsControlsRequest.Builderavoiding the need to create one manually viaDescribeStandardsControlsRequest.builder()- Parameters:
describeStandardsControlsRequest- AConsumerthat will call methods onDescribeStandardsControlsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStandardsPaginator
default DescribeStandardsPublisher describeStandardsPaginator(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.
This is a variant of
describeStandards(software.amazon.awssdk.services.securityhub.model.DescribeStandardsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsPublisher publisher = client.describeStandardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.DescribeStandardsPublisher publisher = client.describeStandardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.DescribeStandardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.DescribeStandardsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStandards(software.amazon.awssdk.services.securityhub.model.DescribeStandardsRequest)operation.- Parameters:
describeStandardsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStandardsPaginator
default DescribeStandardsPublisher describeStandardsPaginator(Consumer<DescribeStandardsRequest.Builder> 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.
This is a variant of
describeStandards(software.amazon.awssdk.services.securityhub.model.DescribeStandardsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsPublisher publisher = client.describeStandardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.DescribeStandardsPublisher publisher = client.describeStandardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.DescribeStandardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.DescribeStandardsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStandards(software.amazon.awssdk.services.securityhub.model.DescribeStandardsRequest)operation.This is a convenience which creates an instance of the
DescribeStandardsRequest.Builderavoiding the need to create one manually viaDescribeStandardsRequest.builder()- Parameters:
describeStandardsRequest- AConsumerthat will call methods onDescribeStandardsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableImportFindingsForProduct
default CompletableFuture<DisableImportFindingsForProductResponse> 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.
- Parameters:
disableImportFindingsForProductRequest-- Returns:
- A Java Future containing the result of the DisableImportFindingsForProduct operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableImportFindingsForProduct
default CompletableFuture<DisableImportFindingsForProductResponse> disableImportFindingsForProduct(Consumer<DisableImportFindingsForProductRequest.Builder> 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.
This is a convenience which creates an instance of the
DisableImportFindingsForProductRequest.Builderavoiding the need to create one manually viaDisableImportFindingsForProductRequest.builder()- Parameters:
disableImportFindingsForProductRequest- AConsumerthat will call methods onDisableImportFindingsForProductRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisableImportFindingsForProduct operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableOrganizationAdminAccount
default CompletableFuture<DisableOrganizationAdminAccountResponse> disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest) Disables a Security Hub administrator account. Can only be called by the organization management account.
- Parameters:
disableOrganizationAdminAccountRequest-- Returns:
- A Java Future containing the result of the DisableOrganizationAdminAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableOrganizationAdminAccount
default CompletableFuture<DisableOrganizationAdminAccountResponse> disableOrganizationAdminAccount(Consumer<DisableOrganizationAdminAccountRequest.Builder> disableOrganizationAdminAccountRequest) Disables a Security Hub administrator account. Can only be called by the organization management account.
This is a convenience which creates an instance of the
DisableOrganizationAdminAccountRequest.Builderavoiding the need to create one manually viaDisableOrganizationAdminAccountRequest.builder()- Parameters:
disableOrganizationAdminAccountRequest- AConsumerthat will call methods onDisableOrganizationAdminAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisableOrganizationAdminAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableSecurityHub
default CompletableFuture<DisableSecurityHubResponse> disableSecurityHub(DisableSecurityHubRequest disableSecurityHubRequest) Disables Security Hub in your account only in the current Amazon Web Services Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.
You can't disable Security Hub in an account that is currently the Security Hub administrator.
When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed.
If you want to save your existing findings, you must export them before you disable Security Hub.
- Parameters:
disableSecurityHubRequest-- Returns:
- A Java Future containing the result of the DisableSecurityHub operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableSecurityHub
default CompletableFuture<DisableSecurityHubResponse> disableSecurityHub(Consumer<DisableSecurityHubRequest.Builder> disableSecurityHubRequest) Disables Security Hub in your account only in the current Amazon Web Services Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.
You can't disable Security Hub in an account that is currently the Security Hub administrator.
When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed.
If you want to save your existing findings, you must export them before you disable Security Hub.
This is a convenience which creates an instance of the
DisableSecurityHubRequest.Builderavoiding the need to create one manually viaDisableSecurityHubRequest.builder()- Parameters:
disableSecurityHubRequest- AConsumerthat will call methods onDisableSecurityHubRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisableSecurityHub operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableSecurityHub
Disables Security Hub in your account only in the current Amazon Web Services Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.
You can't disable Security Hub in an account that is currently the Security Hub administrator.
When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed.
If you want to save your existing findings, you must export them before you disable Security Hub.
- Returns:
- A Java Future containing the result of the DisableSecurityHub operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateFromAdministratorAccount
default CompletableFuture<DisassociateFromAdministratorAccountResponse> disassociateFromAdministratorAccount(DisassociateFromAdministratorAccountRequest disassociateFromAdministratorAccountRequest) Disassociates the current Security Hub member account from the associated administrator account.
This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
- Parameters:
disassociateFromAdministratorAccountRequest-- Returns:
- A Java Future containing the result of the DisassociateFromAdministratorAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateFromAdministratorAccount
default CompletableFuture<DisassociateFromAdministratorAccountResponse> disassociateFromAdministratorAccount(Consumer<DisassociateFromAdministratorAccountRequest.Builder> disassociateFromAdministratorAccountRequest) Disassociates the current Security Hub member account from the associated administrator account.
This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
This is a convenience which creates an instance of the
DisassociateFromAdministratorAccountRequest.Builderavoiding the need to create one manually viaDisassociateFromAdministratorAccountRequest.builder()- Parameters:
disassociateFromAdministratorAccountRequest- AConsumerthat will call methods onDisassociateFromAdministratorAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateFromAdministratorAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateFromMasterAccount
@Deprecated default CompletableFuture<DisassociateFromMasterAccountResponse> disassociateFromMasterAccount(DisassociateFromMasterAccountRequest disassociateFromMasterAccountRequest) Deprecated.This API has been deprecated, use DisassociateFromAdministratorAccount API instead.This method is deprecated. Instead, use
DisassociateFromAdministratorAccount.The Security Hub console continues to use
DisassociateFromMasterAccount. It will eventually change to useDisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to useDisassociateFromMasterAccount. You should also addDisassociateFromAdministratorAccountto your policies to ensure that the correct permissions are in place after the console begins to useDisassociateFromAdministratorAccount.Disassociates the current Security Hub member account from the associated administrator account.
This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
- Parameters:
disassociateFromMasterAccountRequest-- Returns:
- A Java Future containing the result of the DisassociateFromMasterAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateFromMasterAccount
@Deprecated default CompletableFuture<DisassociateFromMasterAccountResponse> disassociateFromMasterAccount(Consumer<DisassociateFromMasterAccountRequest.Builder> disassociateFromMasterAccountRequest) Deprecated.This API has been deprecated, use DisassociateFromAdministratorAccount API instead.This method is deprecated. Instead, use
DisassociateFromAdministratorAccount.The Security Hub console continues to use
DisassociateFromMasterAccount. It will eventually change to useDisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to useDisassociateFromMasterAccount. You should also addDisassociateFromAdministratorAccountto your policies to ensure that the correct permissions are in place after the console begins to useDisassociateFromAdministratorAccount.Disassociates the current Security Hub member account from the associated administrator account.
This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
This is a convenience which creates an instance of the
DisassociateFromMasterAccountRequest.Builderavoiding the need to create one manually viaDisassociateFromMasterAccountRequest.builder()- Parameters:
disassociateFromMasterAccountRequest- AConsumerthat will call methods onDisassociateFromMasterAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateFromMasterAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateMembers
default CompletableFuture<DisassociateMembersResponse> disassociateMembers(DisassociateMembersRequest disassociateMembersRequest) Disassociates the specified member accounts from the associated administrator account.
Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually.
- Parameters:
disassociateMembersRequest-- Returns:
- A Java Future containing the result of the DisassociateMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateMembers
default CompletableFuture<DisassociateMembersResponse> disassociateMembers(Consumer<DisassociateMembersRequest.Builder> disassociateMembersRequest) Disassociates the specified member accounts from the associated administrator account.
Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually.
This is a convenience which creates an instance of the
DisassociateMembersRequest.Builderavoiding the need to create one manually viaDisassociateMembersRequest.builder()- Parameters:
disassociateMembersRequest- AConsumerthat will call methods onDisassociateMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableImportFindingsForProduct
default CompletableFuture<EnableImportFindingsForProductResponse> 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.
- Parameters:
enableImportFindingsForProductRequest-- Returns:
- A Java Future containing the result of the EnableImportFindingsForProduct operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableImportFindingsForProduct
default CompletableFuture<EnableImportFindingsForProductResponse> enableImportFindingsForProduct(Consumer<EnableImportFindingsForProductRequest.Builder> 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.
This is a convenience which creates an instance of the
EnableImportFindingsForProductRequest.Builderavoiding the need to create one manually viaEnableImportFindingsForProductRequest.builder()- Parameters:
enableImportFindingsForProductRequest- AConsumerthat will call methods onEnableImportFindingsForProductRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the EnableImportFindingsForProduct operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableOrganizationAdminAccount
default CompletableFuture<EnableOrganizationAdminAccountResponse> enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest) Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.
- Parameters:
enableOrganizationAdminAccountRequest-- Returns:
- A Java Future containing the result of the EnableOrganizationAdminAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableOrganizationAdminAccount
default CompletableFuture<EnableOrganizationAdminAccountResponse> enableOrganizationAdminAccount(Consumer<EnableOrganizationAdminAccountRequest.Builder> enableOrganizationAdminAccountRequest) Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.
This is a convenience which creates an instance of the
EnableOrganizationAdminAccountRequest.Builderavoiding the need to create one manually viaEnableOrganizationAdminAccountRequest.builder()- Parameters:
enableOrganizationAdminAccountRequest- AConsumerthat will call methods onEnableOrganizationAdminAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the EnableOrganizationAdminAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableSecurityHub
default CompletableFuture<EnableSecurityHubResponse> 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
EnableSecurityHuboperation to enable Security Hub, you also automatically enable the following standards:-
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
-
Amazon Web Services Foundational Security Best Practices
Other standards are not automatically enabled.
To opt out of automatically enabled standards, set
EnableDefaultStandardstofalse.After you enable Security Hub, to enable a standard, use the
BatchEnableStandardsoperation. To disable a standard, use theBatchDisableStandardsoperation.To learn more, see the setup information in the Security Hub User Guide.
- Parameters:
enableSecurityHubRequest-- Returns:
- A Java Future containing the result of the EnableSecurityHub operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
enableSecurityHub
default CompletableFuture<EnableSecurityHubResponse> enableSecurityHub(Consumer<EnableSecurityHubRequest.Builder> 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
EnableSecurityHuboperation to enable Security Hub, you also automatically enable the following standards:-
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
-
Amazon Web Services Foundational Security Best Practices
Other standards are not automatically enabled.
To opt out of automatically enabled standards, set
EnableDefaultStandardstofalse.After you enable Security Hub, to enable a standard, use the
BatchEnableStandardsoperation. To disable a standard, use theBatchDisableStandardsoperation.To learn more, see the setup information in the Security Hub User Guide.
This is a convenience which creates an instance of the
EnableSecurityHubRequest.Builderavoiding the need to create one manually viaEnableSecurityHubRequest.builder()- Parameters:
enableSecurityHubRequest- AConsumerthat will call methods onEnableSecurityHubRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the EnableSecurityHub operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
enableSecurityHub
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
EnableSecurityHuboperation to enable Security Hub, you also automatically enable the following standards:-
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
-
Amazon Web Services Foundational Security Best Practices
Other standards are not automatically enabled.
To opt out of automatically enabled standards, set
EnableDefaultStandardstofalse.After you enable Security Hub, to enable a standard, use the
BatchEnableStandardsoperation. To disable a standard, use theBatchDisableStandardsoperation.To learn more, see the setup information in the Security Hub User Guide.
- Returns:
- A Java Future containing the result of the EnableSecurityHub operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getAdministratorAccount
default CompletableFuture<GetAdministratorAccountResponse> getAdministratorAccount(GetAdministratorAccountRequest getAdministratorAccountRequest) Provides the details for the Security Hub administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
- Parameters:
getAdministratorAccountRequest-- Returns:
- A Java Future containing the result of the GetAdministratorAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAdministratorAccount
default CompletableFuture<GetAdministratorAccountResponse> getAdministratorAccount(Consumer<GetAdministratorAccountRequest.Builder> getAdministratorAccountRequest) Provides the details for the Security Hub administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
This is a convenience which creates an instance of the
GetAdministratorAccountRequest.Builderavoiding the need to create one manually viaGetAdministratorAccountRequest.builder()- Parameters:
getAdministratorAccountRequest- AConsumerthat will call methods onGetAdministratorAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAdministratorAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnabledStandards
default CompletableFuture<GetEnabledStandardsResponse> getEnabledStandards(GetEnabledStandardsRequest getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.
- Parameters:
getEnabledStandardsRequest-- Returns:
- A Java Future containing the result of the GetEnabledStandards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnabledStandards
default CompletableFuture<GetEnabledStandardsResponse> getEnabledStandards(Consumer<GetEnabledStandardsRequest.Builder> getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.
This is a convenience which creates an instance of the
GetEnabledStandardsRequest.Builderavoiding the need to create one manually viaGetEnabledStandardsRequest.builder()- Parameters:
getEnabledStandardsRequest- AConsumerthat will call methods onGetEnabledStandardsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetEnabledStandards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnabledStandardsPaginator
default GetEnabledStandardsPublisher getEnabledStandardsPaginator(GetEnabledStandardsRequest getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.
This is a variant of
getEnabledStandards(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsPublisher publisher = client.getEnabledStandardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsPublisher publisher = client.getEnabledStandardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEnabledStandards(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsRequest)operation.- Parameters:
getEnabledStandardsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnabledStandardsPaginator
default GetEnabledStandardsPublisher getEnabledStandardsPaginator(Consumer<GetEnabledStandardsRequest.Builder> getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.
This is a variant of
getEnabledStandards(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsPublisher publisher = client.getEnabledStandardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsPublisher publisher = client.getEnabledStandardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEnabledStandards(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsRequest)operation.This is a convenience which creates an instance of the
GetEnabledStandardsRequest.Builderavoiding the need to create one manually viaGetEnabledStandardsRequest.builder()- Parameters:
getEnabledStandardsRequest- AConsumerthat will call methods onGetEnabledStandardsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindingAggregator
default CompletableFuture<GetFindingAggregatorResponse> getFindingAggregator(GetFindingAggregatorRequest getFindingAggregatorRequest) Returns the current finding aggregation configuration.
- Parameters:
getFindingAggregatorRequest-- Returns:
- A Java Future containing the result of the GetFindingAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindingAggregator
default CompletableFuture<GetFindingAggregatorResponse> getFindingAggregator(Consumer<GetFindingAggregatorRequest.Builder> getFindingAggregatorRequest) Returns the current finding aggregation configuration.
This is a convenience which creates an instance of the
GetFindingAggregatorRequest.Builderavoiding the need to create one manually viaGetFindingAggregatorRequest.builder()- Parameters:
getFindingAggregatorRequest- AConsumerthat will call methods onGetFindingAggregatorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetFindingAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindingHistory
default CompletableFuture<GetFindingHistoryResponse> getFindingHistory(GetFindingHistoryRequest getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).
- Parameters:
getFindingHistoryRequest-- Returns:
- A Java Future containing the result of the GetFindingHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindingHistory
default CompletableFuture<GetFindingHistoryResponse> getFindingHistory(Consumer<GetFindingHistoryRequest.Builder> getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).
This is a convenience which creates an instance of the
GetFindingHistoryRequest.Builderavoiding the need to create one manually viaGetFindingHistoryRequest.builder()- Parameters:
getFindingHistoryRequest- AConsumerthat will call methods onGetFindingHistoryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetFindingHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindingHistoryPaginator
default GetFindingHistoryPublisher getFindingHistoryPaginator(GetFindingHistoryRequest getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).
This is a variant of
getFindingHistory(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryPublisher publisher = client.getFindingHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryPublisher publisher = client.getFindingHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.GetFindingHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getFindingHistory(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryRequest)operation.- Parameters:
getFindingHistoryRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindingHistoryPaginator
default GetFindingHistoryPublisher getFindingHistoryPaginator(Consumer<GetFindingHistoryRequest.Builder> getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).
This is a variant of
getFindingHistory(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryPublisher publisher = client.getFindingHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryPublisher publisher = client.getFindingHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.GetFindingHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getFindingHistory(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryRequest)operation.This is a convenience which creates an instance of the
GetFindingHistoryRequest.Builderavoiding the need to create one manually viaGetFindingHistoryRequest.builder()- Parameters:
getFindingHistoryRequest- AConsumerthat will call methods onGetFindingHistoryRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindings
Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindingsfrom the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.- Parameters:
getFindingsRequest-- Returns:
- A Java Future containing the result of the GetFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindings
default CompletableFuture<GetFindingsResponse> getFindings(Consumer<GetFindingsRequest.Builder> getFindingsRequest) Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindingsfrom the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
This is a convenience which creates an instance of the
GetFindingsRequest.Builderavoiding the need to create one manually viaGetFindingsRequest.builder()- Parameters:
getFindingsRequest- AConsumerthat will call methods onGetFindingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindings
Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindingsfrom the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.- Returns:
- A Java Future containing the result of the GetFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindingsPaginator
Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindingsfrom the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
This is a variant of
getFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.GetFindingsPublisher publisher = client.getFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.GetFindingsPublisher publisher = client.getFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.GetFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.GetFindingsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindingsPaginator
Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindingsfrom the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
This is a variant of
getFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.GetFindingsPublisher publisher = client.getFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.GetFindingsPublisher publisher = client.getFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.GetFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.GetFindingsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)operation.- Parameters:
getFindingsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFindingsPaginator
default GetFindingsPublisher getFindingsPaginator(Consumer<GetFindingsRequest.Builder> getFindingsRequest) Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindingsfrom the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
This is a variant of
getFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.GetFindingsPublisher publisher = client.getFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.GetFindingsPublisher publisher = client.getFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.GetFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.GetFindingsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)operation.This is a convenience which creates an instance of the
GetFindingsRequest.Builderavoiding the need to create one manually viaGetFindingsRequest.builder()- Parameters:
getFindingsRequest- AConsumerthat will call methods onGetFindingsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightResults
default CompletableFuture<GetInsightResultsResponse> getInsightResults(GetInsightResultsRequest getInsightResultsRequest) Lists the results of the Security Hub insight specified by the insight ARN.
- Parameters:
getInsightResultsRequest-- Returns:
- A Java Future containing the result of the GetInsightResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightResults
default CompletableFuture<GetInsightResultsResponse> getInsightResults(Consumer<GetInsightResultsRequest.Builder> getInsightResultsRequest) Lists the results of the Security Hub insight specified by the insight ARN.
This is a convenience which creates an instance of the
GetInsightResultsRequest.Builderavoiding the need to create one manually viaGetInsightResultsRequest.builder()- Parameters:
getInsightResultsRequest- AConsumerthat will call methods onGetInsightResultsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetInsightResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsights
Lists and describes insights for the specified insight ARNs.
- Parameters:
getInsightsRequest-- Returns:
- A Java Future containing the result of the GetInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsights
default CompletableFuture<GetInsightsResponse> getInsights(Consumer<GetInsightsRequest.Builder> getInsightsRequest) Lists and describes insights for the specified insight ARNs.
This is a convenience which creates an instance of the
GetInsightsRequest.Builderavoiding the need to create one manually viaGetInsightsRequest.builder()- Parameters:
getInsightsRequest- AConsumerthat will call methods onGetInsightsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightsPaginator
Lists and describes insights for the specified insight ARNs.
This is a variant of
getInsights(software.amazon.awssdk.services.securityhub.model.GetInsightsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.GetInsightsPublisher publisher = client.getInsightsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.GetInsightsPublisher publisher = client.getInsightsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.GetInsightsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.GetInsightsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsights(software.amazon.awssdk.services.securityhub.model.GetInsightsRequest)operation.- Parameters:
getInsightsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightsPaginator
default GetInsightsPublisher getInsightsPaginator(Consumer<GetInsightsRequest.Builder> getInsightsRequest) Lists and describes insights for the specified insight ARNs.
This is a variant of
getInsights(software.amazon.awssdk.services.securityhub.model.GetInsightsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.GetInsightsPublisher publisher = client.getInsightsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.GetInsightsPublisher publisher = client.getInsightsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.GetInsightsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.GetInsightsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsights(software.amazon.awssdk.services.securityhub.model.GetInsightsRequest)operation.This is a convenience which creates an instance of the
GetInsightsRequest.Builderavoiding the need to create one manually viaGetInsightsRequest.builder()- Parameters:
getInsightsRequest- AConsumerthat will call methods onGetInsightsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInvitationsCount
default CompletableFuture<GetInvitationsCountResponse> 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.
- Parameters:
getInvitationsCountRequest-- Returns:
- A Java Future containing the result of the GetInvitationsCount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInvitationsCount
default CompletableFuture<GetInvitationsCountResponse> getInvitationsCount(Consumer<GetInvitationsCountRequest.Builder> getInvitationsCountRequest) Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
This is a convenience which creates an instance of the
GetInvitationsCountRequest.Builderavoiding the need to create one manually viaGetInvitationsCountRequest.builder()- Parameters:
getInvitationsCountRequest- AConsumerthat will call methods onGetInvitationsCountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetInvitationsCount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInvitationsCount
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
- Returns:
- A Java Future containing the result of the GetInvitationsCount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMasterAccount
@Deprecated default CompletableFuture<GetMasterAccountResponse> getMasterAccount(GetMasterAccountRequest getMasterAccountRequest) Deprecated.This API has been deprecated, use GetAdministratorAccount API instead.This method is deprecated. Instead, use
GetAdministratorAccount.The Security Hub console continues to use
GetMasterAccount. It will eventually change to useGetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to useGetMasterAccount. You should also addGetAdministratorAccountto your policies to ensure that the correct permissions are in place after the console begins to useGetAdministratorAccount.Provides the details for the Security Hub administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
- Parameters:
getMasterAccountRequest-- Returns:
- A Java Future containing the result of the GetMasterAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMasterAccount
@Deprecated default CompletableFuture<GetMasterAccountResponse> getMasterAccount(Consumer<GetMasterAccountRequest.Builder> getMasterAccountRequest) Deprecated.This API has been deprecated, use GetAdministratorAccount API instead.This method is deprecated. Instead, use
GetAdministratorAccount.The Security Hub console continues to use
GetMasterAccount. It will eventually change to useGetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to useGetMasterAccount. You should also addGetAdministratorAccountto your policies to ensure that the correct permissions are in place after the console begins to useGetAdministratorAccount.Provides the details for the Security Hub administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
This is a convenience which creates an instance of the
GetMasterAccountRequest.Builderavoiding the need to create one manually viaGetMasterAccountRequest.builder()- Parameters:
getMasterAccountRequest- AConsumerthat will call methods onGetMasterAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetMasterAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMasterAccount
Deprecated.This API has been deprecated, use GetAdministratorAccount API instead.This method is deprecated. Instead, use
GetAdministratorAccount.The Security Hub console continues to use
GetMasterAccount. It will eventually change to useGetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to useGetMasterAccount. You should also addGetAdministratorAccountto your policies to ensure that the correct permissions are in place after the console begins to useGetAdministratorAccount.Provides the details for the Security Hub administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
- Returns:
- A Java Future containing the result of the GetMasterAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMembers
Returns the details for the Security Hub member accounts for the specified account IDs.
An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually.
The results include both member accounts that are managed using Organizations and accounts that were invited manually.
- Parameters:
getMembersRequest-- Returns:
- A Java Future containing the result of the GetMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMembers
default CompletableFuture<GetMembersResponse> getMembers(Consumer<GetMembersRequest.Builder> getMembersRequest) Returns the details for the Security Hub member accounts for the specified account IDs.
An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually.
The results include both member accounts that are managed using Organizations and accounts that were invited manually.
This is a convenience which creates an instance of the
GetMembersRequest.Builderavoiding the need to create one manually viaGetMembersRequest.builder()- Parameters:
getMembersRequest- AConsumerthat will call methods onGetMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
inviteMembers
default CompletableFuture<InviteMembersResponse> inviteMembers(InviteMembersRequest inviteMembersRequest) Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.
Before you can use this action to invite a member, you must first use the
CreateMembersaction to create the member account in Security Hub.When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
- Parameters:
inviteMembersRequest-- Returns:
- A Java Future containing the result of the InviteMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
inviteMembers
default CompletableFuture<InviteMembersResponse> inviteMembers(Consumer<InviteMembersRequest.Builder> inviteMembersRequest) Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.
Before you can use this action to invite a member, you must first use the
CreateMembersaction to create the member account in Security Hub.When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
This is a convenience which creates an instance of the
InviteMembersRequest.Builderavoiding the need to create one manually viaInviteMembersRequest.builder()- Parameters:
inviteMembersRequest- AConsumerthat will call methods onInviteMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the InviteMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAutomationRules
default CompletableFuture<ListAutomationRulesResponse> listAutomationRules(ListAutomationRulesRequest listAutomationRulesRequest) A list of automation rules and their metadata for the calling account.
- Parameters:
listAutomationRulesRequest-- Returns:
- A Java Future containing the result of the ListAutomationRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You don't have permission to perform the action specified in the request.
- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAutomationRules
default CompletableFuture<ListAutomationRulesResponse> listAutomationRules(Consumer<ListAutomationRulesRequest.Builder> listAutomationRulesRequest) A list of automation rules and their metadata for the calling account.
This is a convenience which creates an instance of the
ListAutomationRulesRequest.Builderavoiding the need to create one manually viaListAutomationRulesRequest.builder()- Parameters:
listAutomationRulesRequest- AConsumerthat will call methods onListAutomationRulesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAutomationRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You don't have permission to perform the action specified in the request.
- InternalException Internal server error.
- InvalidAccessException The account doesn't 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.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnabledProductsForImport
default CompletableFuture<ListEnabledProductsForImportResponse> listEnabledProductsForImport(ListEnabledProductsForImportRequest listEnabledProductsForImportRequest) Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
- Parameters:
listEnabledProductsForImportRequest-- Returns:
- A Java Future containing the result of the ListEnabledProductsForImport operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnabledProductsForImport
default CompletableFuture<ListEnabledProductsForImportResponse> listEnabledProductsForImport(Consumer<ListEnabledProductsForImportRequest.Builder> listEnabledProductsForImportRequest) Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
This is a convenience which creates an instance of the
ListEnabledProductsForImportRequest.Builderavoiding the need to create one manually viaListEnabledProductsForImportRequest.builder()- Parameters:
listEnabledProductsForImportRequest- AConsumerthat will call methods onListEnabledProductsForImportRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListEnabledProductsForImport operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnabledProductsForImport
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
- Returns:
- A Java Future containing the result of the ListEnabledProductsForImport operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnabledProductsForImportPaginator
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
This is a variant of
listEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportPublisher publisher = client.listEnabledProductsForImportPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportPublisher publisher = client.listEnabledProductsForImportPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnabledProductsForImportPaginator
default ListEnabledProductsForImportPublisher listEnabledProductsForImportPaginator(ListEnabledProductsForImportRequest listEnabledProductsForImportRequest) Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
This is a variant of
listEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportPublisher publisher = client.listEnabledProductsForImportPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportPublisher publisher = client.listEnabledProductsForImportPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)operation.- Parameters:
listEnabledProductsForImportRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnabledProductsForImportPaginator
default ListEnabledProductsForImportPublisher listEnabledProductsForImportPaginator(Consumer<ListEnabledProductsForImportRequest.Builder> listEnabledProductsForImportRequest) Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
This is a variant of
listEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportPublisher publisher = client.listEnabledProductsForImportPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportPublisher publisher = client.listEnabledProductsForImportPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)operation.This is a convenience which creates an instance of the
ListEnabledProductsForImportRequest.Builderavoiding the need to create one manually viaListEnabledProductsForImportRequest.builder()- Parameters:
listEnabledProductsForImportRequest- AConsumerthat will call methods onListEnabledProductsForImportRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFindingAggregators
default CompletableFuture<ListFindingAggregatorsResponse> listFindingAggregators(ListFindingAggregatorsRequest listFindingAggregatorsRequest) If finding aggregation is enabled, then
ListFindingAggregatorsreturns the ARN of the finding aggregator. You can run this operation from any Region.- Parameters:
listFindingAggregatorsRequest-- Returns:
- A Java Future containing the result of the ListFindingAggregators operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the request.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFindingAggregators
default CompletableFuture<ListFindingAggregatorsResponse> listFindingAggregators(Consumer<ListFindingAggregatorsRequest.Builder> listFindingAggregatorsRequest) If finding aggregation is enabled, then
ListFindingAggregatorsreturns the ARN of the finding aggregator. You can run this operation from any Region.
This is a convenience which creates an instance of the
ListFindingAggregatorsRequest.Builderavoiding the need to create one manually viaListFindingAggregatorsRequest.builder()- Parameters:
listFindingAggregatorsRequest- AConsumerthat will call methods onListFindingAggregatorsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListFindingAggregators operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the request.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFindingAggregatorsPaginator
default ListFindingAggregatorsPublisher listFindingAggregatorsPaginator(ListFindingAggregatorsRequest listFindingAggregatorsRequest) If finding aggregation is enabled, then
ListFindingAggregatorsreturns the ARN of the finding aggregator. You can run this operation from any Region.
This is a variant of
listFindingAggregators(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsPublisher publisher = client.listFindingAggregatorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsPublisher publisher = client.listFindingAggregatorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFindingAggregators(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsRequest)operation.- Parameters:
listFindingAggregatorsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the request.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFindingAggregatorsPaginator
default ListFindingAggregatorsPublisher listFindingAggregatorsPaginator(Consumer<ListFindingAggregatorsRequest.Builder> listFindingAggregatorsRequest) If finding aggregation is enabled, then
ListFindingAggregatorsreturns the ARN of the finding aggregator. You can run this operation from any Region.
This is a variant of
listFindingAggregators(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsPublisher publisher = client.listFindingAggregatorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsPublisher publisher = client.listFindingAggregatorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFindingAggregators(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsRequest)operation.This is a convenience which creates an instance of the
ListFindingAggregatorsRequest.Builderavoiding the need to create one manually viaListFindingAggregatorsRequest.builder()- Parameters:
listFindingAggregatorsRequest- AConsumerthat will call methods onListFindingAggregatorsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the request.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvitations
default CompletableFuture<ListInvitationsResponse> listInvitations(ListInvitationsRequest listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
- Parameters:
listInvitationsRequest-- Returns:
- A Java Future containing the result of the ListInvitations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvitations
default CompletableFuture<ListInvitationsResponse> listInvitations(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
This is a convenience which creates an instance of the
ListInvitationsRequest.Builderavoiding the need to create one manually viaListInvitationsRequest.builder()- Parameters:
listInvitationsRequest- AConsumerthat will call methods onListInvitationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListInvitations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvitations
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
- Returns:
- A Java Future containing the result of the ListInvitations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvitationsPaginator
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
This is a variant of
listInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListInvitationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListInvitationsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvitationsPaginator
default ListInvitationsPublisher listInvitationsPaginator(ListInvitationsRequest listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
This is a variant of
listInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListInvitationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListInvitationsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)operation.- Parameters:
listInvitationsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvitationsPaginator
default ListInvitationsPublisher listInvitationsPaginator(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
This is a variant of
listInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListInvitationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListInvitationsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)operation.This is a convenience which creates an instance of the
ListInvitationsRequest.Builderavoiding the need to create one manually viaListInvitationsRequest.builder()- Parameters:
listInvitationsRequest- AConsumerthat will call methods onListInvitationsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembers
Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
- Parameters:
listMembersRequest-- Returns:
- A Java Future containing the result of the ListMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembers
default CompletableFuture<ListMembersResponse> listMembers(Consumer<ListMembersRequest.Builder> listMembersRequest) Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
This is a convenience which creates an instance of the
ListMembersRequest.Builderavoiding the need to create one manually viaListMembersRequest.builder()- Parameters:
listMembersRequest- AConsumerthat will call methods onListMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembers
Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
- Returns:
- A Java Future containing the result of the ListMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembersPaginator
Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
This is a variant of
listMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListMembersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembersPaginator
Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
This is a variant of
listMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListMembersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)operation.- Parameters:
listMembersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembersPaginator
default ListMembersPublisher listMembersPaginator(Consumer<ListMembersRequest.Builder> listMembersRequest) Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
This is a variant of
listMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListMembersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)operation.This is a convenience which creates an instance of the
ListMembersRequest.Builderavoiding the need to create one manually viaListMembersRequest.builder()- Parameters:
listMembersRequest- AConsumerthat will call methods onListMembersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizationAdminAccounts
default CompletableFuture<ListOrganizationAdminAccountsResponse> listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest) Lists the Security Hub administrator accounts. Can only be called by the organization management account.
- Parameters:
listOrganizationAdminAccountsRequest-- Returns:
- A Java Future containing the result of the ListOrganizationAdminAccounts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizationAdminAccounts
default CompletableFuture<ListOrganizationAdminAccountsResponse> listOrganizationAdminAccounts(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest) Lists the Security Hub administrator accounts. Can only be called by the organization management account.
This is a convenience which creates an instance of the
ListOrganizationAdminAccountsRequest.Builderavoiding the need to create one manually viaListOrganizationAdminAccountsRequest.builder()- Parameters:
listOrganizationAdminAccountsRequest- AConsumerthat will call methods onListOrganizationAdminAccountsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListOrganizationAdminAccounts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizationAdminAccountsPaginator
default ListOrganizationAdminAccountsPublisher listOrganizationAdminAccountsPaginator(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest) Lists the Security Hub administrator accounts. Can only be called by the organization management account.
This is a variant of
listOrganizationAdminAccounts(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsPublisher publisher = client.listOrganizationAdminAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsPublisher publisher = client.listOrganizationAdminAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOrganizationAdminAccounts(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsRequest)operation.- Parameters:
listOrganizationAdminAccountsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizationAdminAccountsPaginator
default ListOrganizationAdminAccountsPublisher listOrganizationAdminAccountsPaginator(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest) Lists the Security Hub administrator accounts. Can only be called by the organization management account.
This is a variant of
listOrganizationAdminAccounts(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsPublisher publisher = client.listOrganizationAdminAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsPublisher publisher = client.listOrganizationAdminAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOrganizationAdminAccounts(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsRequest)operation.This is a convenience which creates an instance of the
ListOrganizationAdminAccountsRequest.Builderavoiding the need to create one manually viaListOrganizationAdminAccountsRequest.builder()- Parameters:
listOrganizationAdminAccountsRequest- AConsumerthat will call methods onListOrganizationAdminAccountsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSecurityControlDefinitions
default CompletableFuture<ListSecurityControlDefinitionsResponse> listSecurityControlDefinitions(ListSecurityControlDefinitionsRequest listSecurityControlDefinitionsRequest) Lists all of the security controls that apply to a specified standard.
- Parameters:
listSecurityControlDefinitionsRequest-- Returns:
- A Java Future containing the result of the ListSecurityControlDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSecurityControlDefinitions
default CompletableFuture<ListSecurityControlDefinitionsResponse> listSecurityControlDefinitions(Consumer<ListSecurityControlDefinitionsRequest.Builder> listSecurityControlDefinitionsRequest) Lists all of the security controls that apply to a specified standard.
This is a convenience which creates an instance of the
ListSecurityControlDefinitionsRequest.Builderavoiding the need to create one manually viaListSecurityControlDefinitionsRequest.builder()- Parameters:
listSecurityControlDefinitionsRequest- AConsumerthat will call methods onListSecurityControlDefinitionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListSecurityControlDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSecurityControlDefinitionsPaginator
default ListSecurityControlDefinitionsPublisher listSecurityControlDefinitionsPaginator(ListSecurityControlDefinitionsRequest listSecurityControlDefinitionsRequest) Lists all of the security controls that apply to a specified standard.
This is a variant of
listSecurityControlDefinitions(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsPublisher publisher = client.listSecurityControlDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsPublisher publisher = client.listSecurityControlDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityControlDefinitions(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsRequest)operation.- Parameters:
listSecurityControlDefinitionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSecurityControlDefinitionsPaginator
default ListSecurityControlDefinitionsPublisher listSecurityControlDefinitionsPaginator(Consumer<ListSecurityControlDefinitionsRequest.Builder> listSecurityControlDefinitionsRequest) Lists all of the security controls that apply to a specified standard.
This is a variant of
listSecurityControlDefinitions(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsPublisher publisher = client.listSecurityControlDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsPublisher publisher = client.listSecurityControlDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityControlDefinitions(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsRequest)operation.This is a convenience which creates an instance of the
ListSecurityControlDefinitionsRequest.Builderavoiding the need to create one manually viaListSecurityControlDefinitionsRequest.builder()- Parameters:
listSecurityControlDefinitionsRequest- AConsumerthat will call methods onListSecurityControlDefinitionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStandardsControlAssociations
default CompletableFuture<ListStandardsControlAssociationsResponse> listStandardsControlAssociations(ListStandardsControlAssociationsRequest listStandardsControlAssociationsRequest) Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
- Parameters:
listStandardsControlAssociationsRequest-- Returns:
- A Java Future containing the result of the ListStandardsControlAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStandardsControlAssociations
default CompletableFuture<ListStandardsControlAssociationsResponse> listStandardsControlAssociations(Consumer<ListStandardsControlAssociationsRequest.Builder> listStandardsControlAssociationsRequest) Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
This is a convenience which creates an instance of the
ListStandardsControlAssociationsRequest.Builderavoiding the need to create one manually viaListStandardsControlAssociationsRequest.builder()- Parameters:
listStandardsControlAssociationsRequest- AConsumerthat will call methods onListStandardsControlAssociationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListStandardsControlAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStandardsControlAssociationsPaginator
default ListStandardsControlAssociationsPublisher listStandardsControlAssociationsPaginator(ListStandardsControlAssociationsRequest listStandardsControlAssociationsRequest) Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
This is a variant of
listStandardsControlAssociations(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsPublisher publisher = client.listStandardsControlAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsPublisher publisher = client.listStandardsControlAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStandardsControlAssociations(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsRequest)operation.- Parameters:
listStandardsControlAssociationsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStandardsControlAssociationsPaginator
default ListStandardsControlAssociationsPublisher listStandardsControlAssociationsPaginator(Consumer<ListStandardsControlAssociationsRequest.Builder> listStandardsControlAssociationsRequest) Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
This is a variant of
listStandardsControlAssociations(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsPublisher publisher = client.listStandardsControlAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsPublisher publisher = client.listStandardsControlAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStandardsControlAssociations(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsRequest)operation.This is a convenience which creates an instance of the
ListStandardsControlAssociationsRequest.Builderavoiding the need to create one manually viaListStandardsControlAssociationsRequest.builder()- Parameters:
listStandardsControlAssociationsRequest- AConsumerthat will call methods onListStandardsControlAssociationsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags associated with a resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags associated with a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds one or more tags to a resource.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from a resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateActionTarget
default CompletableFuture<UpdateActionTargetResponse> updateActionTarget(UpdateActionTargetRequest updateActionTargetRequest) Updates the name and description of a custom action target in Security Hub.
- Parameters:
updateActionTargetRequest-- Returns:
- A Java Future containing the result of the UpdateActionTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateActionTarget
default CompletableFuture<UpdateActionTargetResponse> updateActionTarget(Consumer<UpdateActionTargetRequest.Builder> updateActionTargetRequest) Updates the name and description of a custom action target in Security Hub.
This is a convenience which creates an instance of the
UpdateActionTargetRequest.Builderavoiding the need to create one manually viaUpdateActionTargetRequest.builder()- Parameters:
updateActionTargetRequest- AConsumerthat will call methods onUpdateActionTargetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateActionTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFindingAggregator
default CompletableFuture<UpdateFindingAggregatorResponse> updateFindingAggregator(UpdateFindingAggregatorRequest updateFindingAggregatorRequest) Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use
UpdateFindingAggregatorto change the aggregation Region.You must run
UpdateFindingAggregatorfrom the current aggregation Region.- Parameters:
updateFindingAggregatorRequest-- Returns:
- A Java Future containing the result of the UpdateFindingAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFindingAggregator
default CompletableFuture<UpdateFindingAggregatorResponse> updateFindingAggregator(Consumer<UpdateFindingAggregatorRequest.Builder> updateFindingAggregatorRequest) Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use
UpdateFindingAggregatorto change the aggregation Region.You must run
UpdateFindingAggregatorfrom the current aggregation Region.
This is a convenience which creates an instance of the
UpdateFindingAggregatorRequest.Builderavoiding the need to create one manually viaUpdateFindingAggregatorRequest.builder()- Parameters:
updateFindingAggregatorRequest- AConsumerthat will call methods onUpdateFindingAggregatorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateFindingAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- AccessDeniedException You don't have permission to perform the action specified in the 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFindings
default CompletableFuture<UpdateFindingsResponse> updateFindings(UpdateFindingsRequest updateFindingsRequest) UpdateFindingsis deprecated. Instead ofUpdateFindings, useBatchUpdateFindings.Updates the
NoteandRecordStateof 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.- Parameters:
updateFindingsRequest-- Returns:
- A Java Future containing the result of the UpdateFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFindings
default CompletableFuture<UpdateFindingsResponse> updateFindings(Consumer<UpdateFindingsRequest.Builder> updateFindingsRequest) UpdateFindingsis deprecated. Instead ofUpdateFindings, useBatchUpdateFindings.Updates the
NoteandRecordStateof 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.
This is a convenience which creates an instance of the
UpdateFindingsRequest.Builderavoiding the need to create one manually viaUpdateFindingsRequest.builder()- Parameters:
updateFindingsRequest- AConsumerthat will call methods onUpdateFindingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateInsight
default CompletableFuture<UpdateInsightResponse> updateInsight(UpdateInsightRequest updateInsightRequest) Updates the Security Hub insight identified by the specified insight ARN.
- Parameters:
updateInsightRequest-- Returns:
- A Java Future containing the result of the UpdateInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateInsight
default CompletableFuture<UpdateInsightResponse> updateInsight(Consumer<UpdateInsightRequest.Builder> updateInsightRequest) Updates the Security Hub insight identified by the specified insight ARN.
This is a convenience which creates an instance of the
UpdateInsightRequest.Builderavoiding the need to create one manually viaUpdateInsightRequest.builder()- Parameters:
updateInsightRequest- AConsumerthat will call methods onUpdateInsightRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateOrganizationConfiguration
default CompletableFuture<UpdateOrganizationConfigurationResponse> updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest) Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.
- Parameters:
updateOrganizationConfigurationRequest-- Returns:
- A Java Future containing the result of the UpdateOrganizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateOrganizationConfiguration
default CompletableFuture<UpdateOrganizationConfigurationResponse> updateOrganizationConfiguration(Consumer<UpdateOrganizationConfigurationRequest.Builder> updateOrganizationConfigurationRequest) Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.
This is a convenience which creates an instance of the
UpdateOrganizationConfigurationRequest.Builderavoiding the need to create one manually viaUpdateOrganizationConfigurationRequest.builder()- Parameters:
updateOrganizationConfigurationRequest- AConsumerthat will call methods onUpdateOrganizationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateOrganizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSecurityHubConfiguration
default CompletableFuture<UpdateSecurityHubConfigurationResponse> updateSecurityHubConfiguration(UpdateSecurityHubConfigurationRequest updateSecurityHubConfigurationRequest) Updates configuration options for Security Hub.
- Parameters:
updateSecurityHubConfigurationRequest-- Returns:
- A Java Future containing the result of the UpdateSecurityHubConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSecurityHubConfiguration
default CompletableFuture<UpdateSecurityHubConfigurationResponse> updateSecurityHubConfiguration(Consumer<UpdateSecurityHubConfigurationRequest.Builder> updateSecurityHubConfigurationRequest) Updates configuration options for Security Hub.
This is a convenience which creates an instance of the
UpdateSecurityHubConfigurationRequest.Builderavoiding the need to create one manually viaUpdateSecurityHubConfigurationRequest.builder()- Parameters:
updateSecurityHubConfigurationRequest- AConsumerthat will call methods onUpdateSecurityHubConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateSecurityHubConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStandardsControl
default CompletableFuture<UpdateStandardsControlResponse> updateStandardsControl(UpdateStandardsControlRequest updateStandardsControlRequest) Used to control whether an individual security standard control is enabled or disabled.
- Parameters:
updateStandardsControlRequest-- Returns:
- A Java Future containing the result of the UpdateStandardsControl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStandardsControl
default CompletableFuture<UpdateStandardsControlResponse> updateStandardsControl(Consumer<UpdateStandardsControlRequest.Builder> updateStandardsControlRequest) Used to control whether an individual security standard control is enabled or disabled.
This is a convenience which creates an instance of the
UpdateStandardsControlRequest.Builderavoiding the need to create one manually viaUpdateStandardsControlRequest.builder()- Parameters:
updateStandardsControlRequest- AConsumerthat will call methods onUpdateStandardsControlRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateStandardsControl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalException Internal server error.
- InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
- InvalidAccessException The account doesn't have permission to perform this action.
- ResourceNotFoundException The request was rejected because we can't find the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aSecurityHubAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aSecurityHubAsyncClient.
-