Interface SecurityHubClient
- 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
-RateLimit
of 1 request per second.BurstLimit
of 1 request per second. -
GetFindings
-RateLimit
of 3 requests per second.BurstLimit
of 6 requests per second. -
BatchImportFindings
-RateLimit
of 10 requests per second.BurstLimit
of 30 requests per second. -
BatchUpdateFindings
-RateLimit
of 10 requests per second.BurstLimit
of 30 requests per second. -
UpdateStandardsControl
-RateLimit
of 1 request per second.BurstLimit
of 5 requests per second. -
All other operations -
RateLimit
of 10 requests per second.BurstLimit
of 30 requests per second.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value 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.default AcceptInvitationResponse
acceptInvitation
(Consumer<AcceptInvitationRequest.Builder> acceptInvitationRequest) Deprecated.This API has been deprecated, use AcceptAdministratorInvitation API instead.default AcceptInvitationResponse
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.default BatchDisableStandardsResponse
batchDisableStandards
(Consumer<BatchDisableStandardsRequest.Builder> batchDisableStandardsRequest) Disables the standards specified by the providedStandardsSubscriptionArns
.default BatchDisableStandardsResponse
batchDisableStandards
(BatchDisableStandardsRequest batchDisableStandardsRequest) Disables the standards specified by the providedStandardsSubscriptionArns
.default BatchEnableStandardsResponse
batchEnableStandards
(Consumer<BatchEnableStandardsRequest.Builder> batchEnableStandardsRequest) Enables the standards specified by the providedStandardsArn
.default BatchEnableStandardsResponse
batchEnableStandards
(BatchEnableStandardsRequest batchEnableStandardsRequest) Enables the standards specified by the providedStandardsArn
.default BatchGetAutomationRulesResponse
batchGetAutomationRules
(Consumer<BatchGetAutomationRulesRequest.Builder> batchGetAutomationRulesRequest) Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).default BatchGetAutomationRulesResponse
batchGetAutomationRules
(BatchGetAutomationRulesRequest batchGetAutomationRulesRequest) Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).batchGetConfigurationPolicyAssociations
(Consumer<BatchGetConfigurationPolicyAssociationsRequest.Builder> batchGetConfigurationPolicyAssociationsRequest) Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root.batchGetConfigurationPolicyAssociations
(BatchGetConfigurationPolicyAssociationsRequest batchGetConfigurationPolicyAssociationsRequest) Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root.default 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.default BatchGetSecurityControlsResponse
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.default BatchImportFindingsResponse
batchImportFindings
(Consumer<BatchImportFindingsRequest.Builder> batchImportFindingsRequest) Imports security findings generated by a finding provider into Security Hub.default BatchImportFindingsResponse
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.default BatchUpdateFindingsResponse
batchUpdateFindings
(Consumer<BatchUpdateFindingsRequest.Builder> batchUpdateFindingsRequest) Used by Security Hub customers to update information about their investigation into a finding.default BatchUpdateFindingsResponse
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.static SecurityHubClientBuilder
builder()
Create a builder that can be used to configure and create aSecurityHubClient
.static SecurityHubClient
create()
Create aSecurityHubClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateActionTargetResponse
createActionTarget
(Consumer<CreateActionTargetRequest.Builder> createActionTargetRequest) Creates a custom action target in Security Hub.default CreateActionTargetResponse
createActionTarget
(CreateActionTargetRequest createActionTargetRequest) Creates a custom action target in Security Hub.default CreateAutomationRuleResponse
createAutomationRule
(Consumer<CreateAutomationRuleRequest.Builder> createAutomationRuleRequest) Creates an automation rule based on input parameters.default CreateAutomationRuleResponse
createAutomationRule
(CreateAutomationRuleRequest createAutomationRuleRequest) Creates an automation rule based on input parameters.createConfigurationPolicy
(Consumer<CreateConfigurationPolicyRequest.Builder> createConfigurationPolicyRequest) Creates a configuration policy with the defined configuration.createConfigurationPolicy
(CreateConfigurationPolicyRequest createConfigurationPolicyRequest) Creates a configuration policy with the defined configuration.default CreateFindingAggregatorResponse
createFindingAggregator
(Consumer<CreateFindingAggregatorRequest.Builder> createFindingAggregatorRequest) Used to enable finding aggregation.default CreateFindingAggregatorResponse
createFindingAggregator
(CreateFindingAggregatorRequest createFindingAggregatorRequest) Used to enable finding aggregation.default CreateInsightResponse
createInsight
(Consumer<CreateInsightRequest.Builder> createInsightRequest) Creates a custom insight in Security Hub.default CreateInsightResponse
createInsight
(CreateInsightRequest createInsightRequest) Creates a custom insight in Security Hub.default 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 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.default DeclineInvitationsResponse
declineInvitations
(Consumer<DeclineInvitationsRequest.Builder> declineInvitationsRequest) Declines invitations to become a member account.default DeclineInvitationsResponse
declineInvitations
(DeclineInvitationsRequest declineInvitationsRequest) Declines invitations to become a member account.default DeleteActionTargetResponse
deleteActionTarget
(Consumer<DeleteActionTargetRequest.Builder> deleteActionTargetRequest) Deletes a custom action target from Security Hub.default DeleteActionTargetResponse
deleteActionTarget
(DeleteActionTargetRequest deleteActionTargetRequest) Deletes a custom action target from Security Hub.deleteConfigurationPolicy
(Consumer<DeleteConfigurationPolicyRequest.Builder> deleteConfigurationPolicyRequest) Deletes a configuration policy.deleteConfigurationPolicy
(DeleteConfigurationPolicyRequest deleteConfigurationPolicyRequest) Deletes a configuration policy.default DeleteFindingAggregatorResponse
deleteFindingAggregator
(Consumer<DeleteFindingAggregatorRequest.Builder> deleteFindingAggregatorRequest) Deletes a finding aggregator.default DeleteFindingAggregatorResponse
deleteFindingAggregator
(DeleteFindingAggregatorRequest deleteFindingAggregatorRequest) Deletes a finding aggregator.default DeleteInsightResponse
deleteInsight
(Consumer<DeleteInsightRequest.Builder> deleteInsightRequest) Deletes the insight specified by theInsightArn
.default DeleteInsightResponse
deleteInsight
(DeleteInsightRequest deleteInsightRequest) Deletes the insight specified by theInsightArn
.default DeleteInvitationsResponse
deleteInvitations
(Consumer<DeleteInvitationsRequest.Builder> deleteInvitationsRequest) Deletes invitations received by the Amazon Web Services account to become a member account.default DeleteInvitationsResponse
deleteInvitations
(DeleteInvitationsRequest deleteInvitationsRequest) Deletes invitations received by the Amazon Web Services account to become a member account.default DeleteMembersResponse
deleteMembers
(Consumer<DeleteMembersRequest.Builder> deleteMembersRequest) Deletes the specified member accounts from Security Hub.default DeleteMembersResponse
deleteMembers
(DeleteMembersRequest deleteMembersRequest) Deletes the specified member accounts from Security Hub.default DescribeActionTargetsResponse
describeActionTargets
(Consumer<DescribeActionTargetsRequest.Builder> describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.default DescribeActionTargetsResponse
describeActionTargets
(DescribeActionTargetsRequest describeActionTargetsRequest) Returns a list of the custom action targets in Security Hub in your account.default DescribeActionTargetsIterable
describeActionTargetsPaginator
(Consumer<DescribeActionTargetsRequest.Builder> describeActionTargetsRequest) This is a variant ofdescribeActionTargets(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsRequest)
operation.default DescribeActionTargetsIterable
describeActionTargetsPaginator
(DescribeActionTargetsRequest describeActionTargetsRequest) This is a variant ofdescribeActionTargets(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsRequest)
operation.default DescribeHubResponse
describeHub
(Consumer<DescribeHubRequest.Builder> describeHubRequest) Returns details about the Hub resource in your account, including theHubArn
and the time when you enabled Security Hub.default DescribeHubResponse
describeHub
(DescribeHubRequest describeHubRequest) Returns details about the Hub resource in your account, including theHubArn
and the time when you enabled Security Hub.describeOrganizationConfiguration
(Consumer<DescribeOrganizationConfigurationRequest.Builder> describeOrganizationConfigurationRequest) Returns information about the way your organization is configured in Security Hub.describeOrganizationConfiguration
(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest) Returns information about the way your organization is configured in Security Hub.default DescribeProductsResponse
describeProducts
(Consumer<DescribeProductsRequest.Builder> describeProductsRequest) Returns information about product integrations in Security Hub.default DescribeProductsResponse
describeProducts
(DescribeProductsRequest describeProductsRequest) Returns information about product integrations in Security Hub.default DescribeProductsIterable
describeProductsPaginator
(Consumer<DescribeProductsRequest.Builder> describeProductsRequest) This is a variant ofdescribeProducts(software.amazon.awssdk.services.securityhub.model.DescribeProductsRequest)
operation.default DescribeProductsIterable
describeProductsPaginator
(DescribeProductsRequest describeProductsRequest) This is a variant ofdescribeProducts(software.amazon.awssdk.services.securityhub.model.DescribeProductsRequest)
operation.default DescribeStandardsResponse
describeStandards
(Consumer<DescribeStandardsRequest.Builder> describeStandardsRequest) Returns a list of the available standards in Security Hub.default DescribeStandardsResponse
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) This is a variant ofdescribeStandardsControls(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsRequest)
operation.describeStandardsControlsPaginator
(DescribeStandardsControlsRequest describeStandardsControlsRequest) This is a variant ofdescribeStandardsControls(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsRequest)
operation.default DescribeStandardsIterable
describeStandardsPaginator
(Consumer<DescribeStandardsRequest.Builder> describeStandardsRequest) This is a variant ofdescribeStandards(software.amazon.awssdk.services.securityhub.model.DescribeStandardsRequest)
operation.default DescribeStandardsIterable
describeStandardsPaginator
(DescribeStandardsRequest describeStandardsRequest) This is a variant ofdescribeStandards(software.amazon.awssdk.services.securityhub.model.DescribeStandardsRequest)
operation.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.default DisableSecurityHubResponse
Disables Security Hub in your account only in the current Amazon Web Services Region.default DisableSecurityHubResponse
disableSecurityHub
(Consumer<DisableSecurityHubRequest.Builder> disableSecurityHubRequest) Disables Security Hub in your account only in the current Amazon Web Services Region.default DisableSecurityHubResponse
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.default DisassociateMembersResponse
disassociateMembers
(Consumer<DisassociateMembersRequest.Builder> disassociateMembersRequest) Disassociates the specified member accounts from the associated administrator account.default DisassociateMembersResponse
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.default EnableSecurityHubResponse
Enables Security Hub for your account in the current Region or the Region you specify in the request.default EnableSecurityHubResponse
enableSecurityHub
(Consumer<EnableSecurityHubRequest.Builder> enableSecurityHubRequest) Enables Security Hub for your account in the current Region or the Region you specify in the request.default EnableSecurityHubResponse
enableSecurityHub
(EnableSecurityHubRequest enableSecurityHubRequest) Enables Security Hub for your account in the current Region or the Region you specify in the request.default GetAdministratorAccountResponse
getAdministratorAccount
(Consumer<GetAdministratorAccountRequest.Builder> getAdministratorAccountRequest) Provides the details for the Security Hub administrator account for the current member account.default GetAdministratorAccountResponse
getAdministratorAccount
(GetAdministratorAccountRequest getAdministratorAccountRequest) Provides the details for the Security Hub administrator account for the current member account.default GetConfigurationPolicyResponse
getConfigurationPolicy
(Consumer<GetConfigurationPolicyRequest.Builder> getConfigurationPolicyRequest) Provides information about a configuration policy.default GetConfigurationPolicyResponse
getConfigurationPolicy
(GetConfigurationPolicyRequest getConfigurationPolicyRequest) Provides information about a configuration policy.getConfigurationPolicyAssociation
(Consumer<GetConfigurationPolicyAssociationRequest.Builder> getConfigurationPolicyAssociationRequest) Returns the association between a configuration and a target account, organizational unit, or the root.getConfigurationPolicyAssociation
(GetConfigurationPolicyAssociationRequest getConfigurationPolicyAssociationRequest) Returns the association between a configuration and a target account, organizational unit, or the root.default GetEnabledStandardsResponse
getEnabledStandards
(Consumer<GetEnabledStandardsRequest.Builder> getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.default GetEnabledStandardsResponse
getEnabledStandards
(GetEnabledStandardsRequest getEnabledStandardsRequest) Returns a list of the standards that are currently enabled.default GetEnabledStandardsIterable
getEnabledStandardsPaginator
(Consumer<GetEnabledStandardsRequest.Builder> getEnabledStandardsRequest) This is a variant ofgetEnabledStandards(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsRequest)
operation.default GetEnabledStandardsIterable
getEnabledStandardsPaginator
(GetEnabledStandardsRequest getEnabledStandardsRequest) This is a variant ofgetEnabledStandards(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsRequest)
operation.default GetFindingAggregatorResponse
getFindingAggregator
(Consumer<GetFindingAggregatorRequest.Builder> getFindingAggregatorRequest) Returns the current finding aggregation configuration.default GetFindingAggregatorResponse
getFindingAggregator
(GetFindingAggregatorRequest getFindingAggregatorRequest) Returns the current finding aggregation configuration.default GetFindingHistoryResponse
getFindingHistory
(Consumer<GetFindingHistoryRequest.Builder> getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days.default GetFindingHistoryResponse
getFindingHistory
(GetFindingHistoryRequest getFindingHistoryRequest) Returns history for a Security Hub finding in the last 90 days.default GetFindingHistoryIterable
getFindingHistoryPaginator
(Consumer<GetFindingHistoryRequest.Builder> getFindingHistoryRequest) This is a variant ofgetFindingHistory(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryRequest)
operation.default GetFindingHistoryIterable
getFindingHistoryPaginator
(GetFindingHistoryRequest getFindingHistoryRequest) This is a variant ofgetFindingHistory(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryRequest)
operation.default GetFindingsResponse
Returns a list of findings that match the specified criteria.default GetFindingsResponse
getFindings
(Consumer<GetFindingsRequest.Builder> getFindingsRequest) Returns a list of findings that match the specified criteria.default GetFindingsResponse
getFindings
(GetFindingsRequest getFindingsRequest) Returns a list of findings that match the specified criteria.default GetFindingsIterable
This is a variant ofgetFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)
operation.default GetFindingsIterable
getFindingsPaginator
(Consumer<GetFindingsRequest.Builder> getFindingsRequest) This is a variant ofgetFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)
operation.default GetFindingsIterable
getFindingsPaginator
(GetFindingsRequest getFindingsRequest) This is a variant ofgetFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)
operation.default GetInsightResultsResponse
getInsightResults
(Consumer<GetInsightResultsRequest.Builder> getInsightResultsRequest) Lists the results of the Security Hub insight specified by the insight ARN.default GetInsightResultsResponse
getInsightResults
(GetInsightResultsRequest getInsightResultsRequest) Lists the results of the Security Hub insight specified by the insight ARN.default GetInsightsResponse
getInsights
(Consumer<GetInsightsRequest.Builder> getInsightsRequest) Lists and describes insights for the specified insight ARNs.default GetInsightsResponse
getInsights
(GetInsightsRequest getInsightsRequest) Lists and describes insights for the specified insight ARNs.default GetInsightsIterable
getInsightsPaginator
(Consumer<GetInsightsRequest.Builder> getInsightsRequest) This is a variant ofgetInsights(software.amazon.awssdk.services.securityhub.model.GetInsightsRequest)
operation.default GetInsightsIterable
getInsightsPaginator
(GetInsightsRequest getInsightsRequest) This is a variant ofgetInsights(software.amazon.awssdk.services.securityhub.model.GetInsightsRequest)
operation.default GetInvitationsCountResponse
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.default 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.default 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.default GetMasterAccountResponse
Deprecated.This API has been deprecated, use GetAdministratorAccount API instead.default GetMasterAccountResponse
getMasterAccount
(Consumer<GetMasterAccountRequest.Builder> getMasterAccountRequest) Deprecated.This API has been deprecated, use GetAdministratorAccount API instead.default GetMasterAccountResponse
getMasterAccount
(GetMasterAccountRequest getMasterAccountRequest) Deprecated.This API has been deprecated, use GetAdministratorAccount API instead.default GetMembersResponse
getMembers
(Consumer<GetMembersRequest.Builder> getMembersRequest) Returns the details for the Security Hub member accounts for the specified account IDs.default GetMembersResponse
getMembers
(GetMembersRequest getMembersRequest) Returns the details for the Security Hub member accounts for the specified account IDs.getSecurityControlDefinition
(Consumer<GetSecurityControlDefinitionRequest.Builder> getSecurityControlDefinitionRequest) Retrieves the definition of a security control.getSecurityControlDefinition
(GetSecurityControlDefinitionRequest getSecurityControlDefinitionRequest) Retrieves the definition of a security control.default 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 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.default ListAutomationRulesResponse
listAutomationRules
(Consumer<ListAutomationRulesRequest.Builder> listAutomationRulesRequest) A list of automation rules and their metadata for the calling account.default ListAutomationRulesResponse
listAutomationRules
(ListAutomationRulesRequest listAutomationRulesRequest) A list of automation rules and their metadata for the calling account.listConfigurationPolicies
(Consumer<ListConfigurationPoliciesRequest.Builder> listConfigurationPoliciesRequest) Lists the configuration policies that the Security Hub delegated administrator has created for your organization.listConfigurationPolicies
(ListConfigurationPoliciesRequest listConfigurationPoliciesRequest) Lists the configuration policies that the Security Hub delegated administrator has created for your organization.listConfigurationPoliciesPaginator
(Consumer<ListConfigurationPoliciesRequest.Builder> listConfigurationPoliciesRequest) This is a variant oflistConfigurationPolicies(software.amazon.awssdk.services.securityhub.model.ListConfigurationPoliciesRequest)
operation.listConfigurationPoliciesPaginator
(ListConfigurationPoliciesRequest listConfigurationPoliciesRequest) This is a variant oflistConfigurationPolicies(software.amazon.awssdk.services.securityhub.model.ListConfigurationPoliciesRequest)
operation.listConfigurationPolicyAssociations
(Consumer<ListConfigurationPolicyAssociationsRequest.Builder> listConfigurationPolicyAssociationsRequest) Provides information about the associations for your configuration policies and self-managed behavior.listConfigurationPolicyAssociations
(ListConfigurationPolicyAssociationsRequest listConfigurationPolicyAssociationsRequest) Provides information about the associations for your configuration policies and self-managed behavior.listConfigurationPolicyAssociationsPaginator
(Consumer<ListConfigurationPolicyAssociationsRequest.Builder> listConfigurationPolicyAssociationsRequest) listConfigurationPolicyAssociationsPaginator
(ListConfigurationPolicyAssociationsRequest listConfigurationPolicyAssociationsRequest) 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.This is a variant oflistEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)
operation.listEnabledProductsForImportPaginator
(Consumer<ListEnabledProductsForImportRequest.Builder> listEnabledProductsForImportRequest) This is a variant oflistEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)
operation.listEnabledProductsForImportPaginator
(ListEnabledProductsForImportRequest listEnabledProductsForImportRequest) This is a variant oflistEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)
operation.default ListFindingAggregatorsResponse
listFindingAggregators
(Consumer<ListFindingAggregatorsRequest.Builder> listFindingAggregatorsRequest) If finding aggregation is enabled, thenListFindingAggregators
returns the ARN of the finding aggregator.default ListFindingAggregatorsResponse
listFindingAggregators
(ListFindingAggregatorsRequest listFindingAggregatorsRequest) If finding aggregation is enabled, thenListFindingAggregators
returns the ARN of the finding aggregator.default ListFindingAggregatorsIterable
listFindingAggregatorsPaginator
(Consumer<ListFindingAggregatorsRequest.Builder> listFindingAggregatorsRequest) This is a variant oflistFindingAggregators(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsRequest)
operation.default ListFindingAggregatorsIterable
listFindingAggregatorsPaginator
(ListFindingAggregatorsRequest listFindingAggregatorsRequest) This is a variant oflistFindingAggregators(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsRequest)
operation.default ListInvitationsResponse
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.default ListInvitationsResponse
listInvitations
(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.default ListInvitationsResponse
listInvitations
(ListInvitationsRequest listInvitationsRequest) Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.default ListInvitationsIterable
This is a variant oflistInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)
operation.default ListInvitationsIterable
listInvitationsPaginator
(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) This is a variant oflistInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)
operation.default ListInvitationsIterable
listInvitationsPaginator
(ListInvitationsRequest listInvitationsRequest) This is a variant oflistInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)
operation.default ListMembersResponse
Lists details about all member accounts for the current Security Hub administrator account.default ListMembersResponse
listMembers
(Consumer<ListMembersRequest.Builder> listMembersRequest) Lists details about all member accounts for the current Security Hub administrator account.default ListMembersResponse
listMembers
(ListMembersRequest listMembersRequest) Lists details about all member accounts for the current Security Hub administrator account.default ListMembersIterable
This is a variant oflistMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)
operation.default ListMembersIterable
listMembersPaginator
(Consumer<ListMembersRequest.Builder> listMembersRequest) This is a variant oflistMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)
operation.default ListMembersIterable
listMembersPaginator
(ListMembersRequest listMembersRequest) This is a variant oflistMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)
operation.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) This is a variant oflistOrganizationAdminAccounts(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsRequest)
operation.listOrganizationAdminAccountsPaginator
(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest) This is a variant oflistOrganizationAdminAccounts(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsRequest)
operation.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) This is a variant oflistSecurityControlDefinitions(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsRequest)
operation.listSecurityControlDefinitionsPaginator
(ListSecurityControlDefinitionsRequest listSecurityControlDefinitionsRequest) This is a variant oflistSecurityControlDefinitions(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsRequest)
operation.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) This is a variant oflistStandardsControlAssociations(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsRequest)
operation.listStandardsControlAssociationsPaginator
(ListStandardsControlAssociationsRequest listStandardsControlAssociationsRequest) This is a variant oflistStandardsControlAssociations(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags associated with a resource.default ListTagsForResourceResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
startConfigurationPolicyAssociation
(Consumer<StartConfigurationPolicyAssociationRequest.Builder> startConfigurationPolicyAssociationRequest) Associates a target account, organizational unit, or the root with a specified configuration.startConfigurationPolicyAssociation
(StartConfigurationPolicyAssociationRequest startConfigurationPolicyAssociationRequest) Associates a target account, organizational unit, or the root with a specified configuration.startConfigurationPolicyDisassociation
(Consumer<StartConfigurationPolicyDisassociationRequest.Builder> startConfigurationPolicyDisassociationRequest) Disassociates a target account, organizational unit, or the root from a specified configuration.startConfigurationPolicyDisassociation
(StartConfigurationPolicyDisassociationRequest startConfigurationPolicyDisassociationRequest) Disassociates a target account, organizational unit, or the root from a specified configuration.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to a resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags to a resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from a resource.default UpdateActionTargetResponse
updateActionTarget
(Consumer<UpdateActionTargetRequest.Builder> updateActionTargetRequest) Updates the name and description of a custom action target in Security Hub.default UpdateActionTargetResponse
updateActionTarget
(UpdateActionTargetRequest updateActionTargetRequest) Updates the name and description of a custom action target in Security Hub.updateConfigurationPolicy
(Consumer<UpdateConfigurationPolicyRequest.Builder> updateConfigurationPolicyRequest) Updates a configuration policy.updateConfigurationPolicy
(UpdateConfigurationPolicyRequest updateConfigurationPolicyRequest) Updates a configuration policy.default UpdateFindingAggregatorResponse
updateFindingAggregator
(Consumer<UpdateFindingAggregatorRequest.Builder> updateFindingAggregatorRequest) Updates the finding aggregation configuration.default UpdateFindingAggregatorResponse
updateFindingAggregator
(UpdateFindingAggregatorRequest updateFindingAggregatorRequest) Updates the finding aggregation configuration.default UpdateFindingsResponse
updateFindings
(Consumer<UpdateFindingsRequest.Builder> updateFindingsRequest) UpdateFindings
is deprecated.default UpdateFindingsResponse
updateFindings
(UpdateFindingsRequest updateFindingsRequest) UpdateFindings
is deprecated.default UpdateInsightResponse
updateInsight
(Consumer<UpdateInsightRequest.Builder> updateInsightRequest) Updates the Security Hub insight identified by the specified insight ARN.default UpdateInsightResponse
updateInsight
(UpdateInsightRequest updateInsightRequest) Updates the Security Hub insight identified by the specified insight ARN.updateOrganizationConfiguration
(Consumer<UpdateOrganizationConfigurationRequest.Builder> updateOrganizationConfigurationRequest) Updates the configuration of your organization in Security Hub.updateOrganizationConfiguration
(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest) Updates the configuration of your organization in Security Hub.default UpdateSecurityControlResponse
updateSecurityControl
(Consumer<UpdateSecurityControlRequest.Builder> updateSecurityControlRequest) Updates the properties of a security control.default UpdateSecurityControlResponse
updateSecurityControl
(UpdateSecurityControlRequest updateSecurityControlRequest) Updates the properties of a security control.updateSecurityHubConfiguration
(Consumer<UpdateSecurityHubConfigurationRequest.Builder> updateSecurityHubConfigurationRequest) Updates configuration options for Security Hub.updateSecurityHubConfiguration
(UpdateSecurityHubConfigurationRequest updateSecurityHubConfigurationRequest) Updates configuration options for Security Hub.default UpdateStandardsControlResponse
updateStandardsControl
(Consumer<UpdateStandardsControlRequest.Builder> updateStandardsControlRequest) Used to control whether an individual security standard control is enabled or disabled.default UpdateStandardsControlResponse
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
close
Methods 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 AcceptAdministratorInvitationResponse acceptAdministratorInvitation(AcceptAdministratorInvitationRequest acceptAdministratorInvitationRequest) throws InternalException, InvalidInputException, LimitExceededException, ResourceNotFoundException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the AcceptAdministratorInvitation operation returned by the service.
- See Also:
-
acceptAdministratorInvitation
default AcceptAdministratorInvitationResponse acceptAdministratorInvitation(Consumer<AcceptAdministratorInvitationRequest.Builder> acceptAdministratorInvitationRequest) throws InternalException, InvalidInputException, LimitExceededException, ResourceNotFoundException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaAcceptAdministratorInvitationRequest.builder()
- Parameters:
acceptAdministratorInvitationRequest
- AConsumer
that will call methods onAcceptAdministratorInvitationRequest.Builder
to create a request.- Returns:
- Result of the AcceptAdministratorInvitation operation returned by the service.
- See Also:
-
acceptInvitation
@Deprecated default AcceptInvitationResponse acceptInvitation(AcceptInvitationRequest acceptInvitationRequest) throws InternalException, InvalidInputException, LimitExceededException, ResourceNotFoundException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException 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 addAcceptAdministratorInvitation
to 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:
- Result of the AcceptInvitation operation returned by the service.
- See Also:
-
acceptInvitation
@Deprecated default AcceptInvitationResponse acceptInvitation(Consumer<AcceptInvitationRequest.Builder> acceptInvitationRequest) throws InternalException, InvalidInputException, LimitExceededException, ResourceNotFoundException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException 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 addAcceptAdministratorInvitation
to 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.Builder
avoiding the need to create one manually viaAcceptInvitationRequest.builder()
- Parameters:
acceptInvitationRequest
- AConsumer
that will call methods onAcceptInvitationRequest.Builder
to create a request.- Returns:
- Result of the AcceptInvitation operation returned by the service.
- See Also:
-
batchDeleteAutomationRules
default BatchDeleteAutomationRulesResponse batchDeleteAutomationRules(BatchDeleteAutomationRulesRequest batchDeleteAutomationRulesRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Deletes one or more automation rules.
- Parameters:
batchDeleteAutomationRulesRequest
-- Returns:
- Result of the BatchDeleteAutomationRules operation returned by the service.
- See Also:
-
batchDeleteAutomationRules
default BatchDeleteAutomationRulesResponse batchDeleteAutomationRules(Consumer<BatchDeleteAutomationRulesRequest.Builder> batchDeleteAutomationRulesRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Deletes one or more automation rules.
This is a convenience which creates an instance of the
BatchDeleteAutomationRulesRequest.Builder
avoiding the need to create one manually viaBatchDeleteAutomationRulesRequest.builder()
- Parameters:
batchDeleteAutomationRulesRequest
- AConsumer
that will call methods onBatchDeleteAutomationRulesRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteAutomationRules operation returned by the service.
- See Also:
-
batchDisableStandards
default BatchDisableStandardsResponse batchDisableStandards(BatchDisableStandardsRequest batchDisableStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Disables the standards specified by the provided
StandardsSubscriptionArns
.For more information, see Security Standards section of the Security Hub User Guide.
- Parameters:
batchDisableStandardsRequest
-- Returns:
- Result of the BatchDisableStandards operation returned by the service.
- See Also:
-
batchDisableStandards
default BatchDisableStandardsResponse batchDisableStandards(Consumer<BatchDisableStandardsRequest.Builder> batchDisableStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaBatchDisableStandardsRequest.builder()
- Parameters:
batchDisableStandardsRequest
- AConsumer
that will call methods onBatchDisableStandardsRequest.Builder
to create a request.- Returns:
- Result of the BatchDisableStandards operation returned by the service.
- See Also:
-
batchEnableStandards
default BatchEnableStandardsResponse batchEnableStandards(BatchEnableStandardsRequest batchEnableStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Enables the standards specified by the provided
StandardsArn
. To obtain the ARN for a standard, use theDescribeStandards
operation.For more information, see the Security Standards section of the Security Hub User Guide.
- Parameters:
batchEnableStandardsRequest
-- Returns:
- Result of the BatchEnableStandards operation returned by the service.
- See Also:
-
batchEnableStandards
default BatchEnableStandardsResponse batchEnableStandards(Consumer<BatchEnableStandardsRequest.Builder> batchEnableStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Enables the standards specified by the provided
StandardsArn
. To obtain the ARN for a standard, use theDescribeStandards
operation.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.Builder
avoiding the need to create one manually viaBatchEnableStandardsRequest.builder()
- Parameters:
batchEnableStandardsRequest
- AConsumer
that will call methods onBatchEnableStandardsRequest.Builder
to create a request.- Returns:
- Result of the BatchEnableStandards operation returned by the service.
- See Also:
-
batchGetAutomationRules
default BatchGetAutomationRulesResponse batchGetAutomationRules(BatchGetAutomationRulesRequest batchGetAutomationRulesRequest) throws AccessDeniedException, InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
- Parameters:
batchGetAutomationRulesRequest
-- Returns:
- Result of the BatchGetAutomationRules operation returned by the service.
- See Also:
-
batchGetAutomationRules
default BatchGetAutomationRulesResponse batchGetAutomationRules(Consumer<BatchGetAutomationRulesRequest.Builder> batchGetAutomationRulesRequest) throws AccessDeniedException, InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaBatchGetAutomationRulesRequest.builder()
- Parameters:
batchGetAutomationRulesRequest
- AConsumer
that will call methods onBatchGetAutomationRulesRequest.Builder
to create a request.- Returns:
- Result of the BatchGetAutomationRules operation returned by the service.
- See Also:
-
batchGetConfigurationPolicyAssociations
default BatchGetConfigurationPolicyAssociationsResponse batchGetConfigurationPolicyAssociations(BatchGetConfigurationPolicyAssociationsRequest batchGetConfigurationPolicyAssociationsRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed configuration.
- Parameters:
batchGetConfigurationPolicyAssociationsRequest
-- Returns:
- Result of the BatchGetConfigurationPolicyAssociations operation returned by the service.
- See Also:
-
batchGetConfigurationPolicyAssociations
default BatchGetConfigurationPolicyAssociationsResponse batchGetConfigurationPolicyAssociations(Consumer<BatchGetConfigurationPolicyAssociationsRequest.Builder> batchGetConfigurationPolicyAssociationsRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed configuration.
This is a convenience which creates an instance of the
BatchGetConfigurationPolicyAssociationsRequest.Builder
avoiding the need to create one manually viaBatchGetConfigurationPolicyAssociationsRequest.builder()
- Parameters:
batchGetConfigurationPolicyAssociationsRequest
- AConsumer
that will call methods onBatchGetConfigurationPolicyAssociationsRequest.Builder
to create a request.- Returns:
- Result of the BatchGetConfigurationPolicyAssociations operation returned by the service.
- See Also:
-
batchGetSecurityControls
default BatchGetSecurityControlsResponse batchGetSecurityControls(BatchGetSecurityControlsRequest batchGetSecurityControlsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
- Parameters:
batchGetSecurityControlsRequest
-- Returns:
- Result of the BatchGetSecurityControls operation returned by the service.
- See Also:
-
batchGetSecurityControls
default BatchGetSecurityControlsResponse batchGetSecurityControls(Consumer<BatchGetSecurityControlsRequest.Builder> batchGetSecurityControlsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaBatchGetSecurityControlsRequest.builder()
- Parameters:
batchGetSecurityControlsRequest
- AConsumer
that will call methods onBatchGetSecurityControlsRequest.Builder
to create a request.- Returns:
- Result of the BatchGetSecurityControls operation returned by the service.
- See Also:
-
batchGetStandardsControlAssociations
default BatchGetStandardsControlAssociationsResponse batchGetStandardsControlAssociations(BatchGetStandardsControlAssociationsRequest batchGetStandardsControlAssociationsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
- Parameters:
batchGetStandardsControlAssociationsRequest
-- Returns:
- Result of the BatchGetStandardsControlAssociations operation returned by the service.
- See Also:
-
batchGetStandardsControlAssociations
default BatchGetStandardsControlAssociationsResponse batchGetStandardsControlAssociations(Consumer<BatchGetStandardsControlAssociationsRequest.Builder> batchGetStandardsControlAssociationsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaBatchGetStandardsControlAssociationsRequest.builder()
- Parameters:
batchGetStandardsControlAssociationsRequest
- AConsumer
that will call methods onBatchGetStandardsControlAssociationsRequest.Builder
to create a request.- Returns:
- Result of the BatchGetStandardsControlAssociations operation returned by the service.
- See Also:
-
batchImportFindings
default BatchImportFindingsResponse batchImportFindings(BatchImportFindingsRequest batchImportFindingsRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.
BatchImportFindings
must be called by one of the following:-
The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling
BatchImportFindings
from needs to be the same as theAwsAccountId
attribute for the finding. -
An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call
BatchImportFindings
from the allow-listed account and send findings from different customer accounts in the same batch.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created,
BatchImportFindings
cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.-
Note
-
UserDefinedFields
-
VerificationState
-
Workflow
Finding providers also should not use
BatchImportFindings
to update the following attributes.-
Confidence
-
Criticality
-
RelatedFindings
-
Severity
-
Types
Instead, finding providers use
FindingProviderFields
to provide values for these attributes.- Parameters:
batchImportFindingsRequest
-- Returns:
- Result of the BatchImportFindings operation returned by the service.
- See Also:
-
-
batchImportFindings
default BatchImportFindingsResponse batchImportFindings(Consumer<BatchImportFindingsRequest.Builder> batchImportFindingsRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.
BatchImportFindings
must be called by one of the following:-
The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling
BatchImportFindings
from needs to be the same as theAwsAccountId
attribute for the finding. -
An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call
BatchImportFindings
from the allow-listed account and send findings from different customer accounts in the same batch.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created,
BatchImportFindings
cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.-
Note
-
UserDefinedFields
-
VerificationState
-
Workflow
Finding providers also should not use
BatchImportFindings
to update the following attributes.-
Confidence
-
Criticality
-
RelatedFindings
-
Severity
-
Types
Instead, finding providers use
FindingProviderFields
to provide values for these attributes.
This is a convenience which creates an instance of the
BatchImportFindingsRequest.Builder
avoiding the need to create one manually viaBatchImportFindingsRequest.builder()
- Parameters:
batchImportFindingsRequest
- AConsumer
that will call methods onBatchImportFindingsRequest.Builder
to create a request.- Returns:
- Result of the BatchImportFindings operation returned by the service.
- See Also:
-
-
batchUpdateAutomationRules
default BatchUpdateAutomationRulesResponse batchUpdateAutomationRules(BatchUpdateAutomationRulesRequest batchUpdateAutomationRulesRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
- Parameters:
batchUpdateAutomationRulesRequest
-- Returns:
- Result of the BatchUpdateAutomationRules operation returned by the service.
- See Also:
-
batchUpdateAutomationRules
default BatchUpdateAutomationRulesResponse batchUpdateAutomationRules(Consumer<BatchUpdateAutomationRulesRequest.Builder> batchUpdateAutomationRulesRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaBatchUpdateAutomationRulesRequest.builder()
- Parameters:
batchUpdateAutomationRulesRequest
- AConsumer
that will call methods onBatchUpdateAutomationRulesRequest.Builder
to create a request.- Returns:
- Result of the BatchUpdateAutomationRules operation returned by the service.
- See Also:
-
batchUpdateFindings
default BatchUpdateFindingsResponse batchUpdateFindings(BatchUpdateFindingsRequest batchUpdateFindingsRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from
BatchUpdateFindings
do not affect the value ofUpdatedAt
for a finding.Administrator and member accounts can use
BatchUpdateFindings
to update the following finding fields and objects.-
Confidence
-
Criticality
-
Note
-
RelatedFindings
-
Severity
-
Types
-
UserDefinedFields
-
VerificationState
-
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
- Parameters:
batchUpdateFindingsRequest
-- Returns:
- Result of the BatchUpdateFindings operation returned by the service.
- See Also:
-
-
batchUpdateFindings
default BatchUpdateFindingsResponse batchUpdateFindings(Consumer<BatchUpdateFindingsRequest.Builder> batchUpdateFindingsRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from
BatchUpdateFindings
do not affect the value ofUpdatedAt
for a finding.Administrator and member accounts can use
BatchUpdateFindings
to update the following finding fields and objects.-
Confidence
-
Criticality
-
Note
-
RelatedFindings
-
Severity
-
Types
-
UserDefinedFields
-
VerificationState
-
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
This is a convenience which creates an instance of the
BatchUpdateFindingsRequest.Builder
avoiding the need to create one manually viaBatchUpdateFindingsRequest.builder()
- Parameters:
batchUpdateFindingsRequest
- AConsumer
that will call methods onBatchUpdateFindingsRequest.Builder
to create a request.- Returns:
- Result of the BatchUpdateFindings operation returned by the service.
- See Also:
-
-
batchUpdateStandardsControlAssociations
default BatchUpdateStandardsControlAssociationsResponse batchUpdateStandardsControlAssociations(BatchUpdateStandardsControlAssociationsRequest batchUpdateStandardsControlAssociationsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
- Parameters:
batchUpdateStandardsControlAssociationsRequest
-- Returns:
- Result of the BatchUpdateStandardsControlAssociations operation returned by the service.
- See Also:
-
batchUpdateStandardsControlAssociations
default BatchUpdateStandardsControlAssociationsResponse batchUpdateStandardsControlAssociations(Consumer<BatchUpdateStandardsControlAssociationsRequest.Builder> batchUpdateStandardsControlAssociationsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaBatchUpdateStandardsControlAssociationsRequest.builder()
- Parameters:
batchUpdateStandardsControlAssociationsRequest
- AConsumer
that will call methods onBatchUpdateStandardsControlAssociationsRequest.Builder
to create a request.- Returns:
- Result of the BatchUpdateStandardsControlAssociations operation returned by the service.
- See Also:
-
createActionTarget
default CreateActionTargetResponse createActionTarget(CreateActionTargetRequest createActionTargetRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the CreateActionTarget operation returned by the service.
- See Also:
-
createActionTarget
default CreateActionTargetResponse createActionTarget(Consumer<CreateActionTargetRequest.Builder> createActionTargetRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaCreateActionTargetRequest.builder()
- Parameters:
createActionTargetRequest
- AConsumer
that will call methods onCreateActionTargetRequest.Builder
to create a request.- Returns:
- Result of the CreateActionTarget operation returned by the service.
- See Also:
-
createAutomationRule
default CreateAutomationRuleResponse createAutomationRule(CreateAutomationRuleRequest createAutomationRuleRequest) throws AccessDeniedException, InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Creates an automation rule based on input parameters.
- Parameters:
createAutomationRuleRequest
-- Returns:
- Result of the CreateAutomationRule operation returned by the service.
- See Also:
-
createAutomationRule
default CreateAutomationRuleResponse createAutomationRule(Consumer<CreateAutomationRuleRequest.Builder> createAutomationRuleRequest) throws AccessDeniedException, InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Creates an automation rule based on input parameters.
This is a convenience which creates an instance of the
CreateAutomationRuleRequest.Builder
avoiding the need to create one manually viaCreateAutomationRuleRequest.builder()
- Parameters:
createAutomationRuleRequest
- AConsumer
that will call methods onCreateAutomationRuleRequest.Builder
to create a request.- Returns:
- Result of the CreateAutomationRule operation returned by the service.
- See Also:
-
createConfigurationPolicy
default CreateConfigurationPolicyResponse createConfigurationPolicy(CreateConfigurationPolicyRequest createConfigurationPolicyRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- Parameters:
createConfigurationPolicyRequest
-- Returns:
- Result of the CreateConfigurationPolicy operation returned by the service.
- See Also:
-
createConfigurationPolicy
default CreateConfigurationPolicyResponse createConfigurationPolicy(Consumer<CreateConfigurationPolicyRequest.Builder> createConfigurationPolicyRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region.
This is a convenience which creates an instance of the
CreateConfigurationPolicyRequest.Builder
avoiding the need to create one manually viaCreateConfigurationPolicyRequest.builder()
- Parameters:
createConfigurationPolicyRequest
- AConsumer
that will call methods onCreateConfigurationPolicyRequest.Builder
to create a request.- Returns:
- Result of the CreateConfigurationPolicy operation returned by the service.
- See Also:
-
createFindingAggregator
default CreateFindingAggregatorResponse createFindingAggregator(CreateFindingAggregatorRequest createFindingAggregatorRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the CreateFindingAggregator operation returned by the service.
- See Also:
-
createFindingAggregator
default CreateFindingAggregatorResponse createFindingAggregator(Consumer<CreateFindingAggregatorRequest.Builder> createFindingAggregatorRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaCreateFindingAggregatorRequest.builder()
- Parameters:
createFindingAggregatorRequest
- AConsumer
that will call methods onCreateFindingAggregatorRequest.Builder
to create a request.- Returns:
- Result of the CreateFindingAggregator operation returned by the service.
- See Also:
-
createInsight
default CreateInsightResponse createInsight(CreateInsightRequest createInsightRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the CreateInsight operation returned by the service.
- See Also:
-
createInsight
default CreateInsightResponse createInsight(Consumer<CreateInsightRequest.Builder> createInsightRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaCreateInsightRequest.builder()
- Parameters:
createInsightRequest
- AConsumer
that will call methods onCreateInsightRequest.Builder
to create a request.- Returns:
- Result of the CreateInsight operation returned by the service.
- See Also:
-
createMembers
default CreateMembersResponse createMembers(CreateMembersRequest createMembersRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, ResourceConflictException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.
CreateMembers
is always used to add accounts that are not organization members.For accounts that are managed using Organizations,
CreateMembers
is only used in the following cases:-
Security Hub is not configured to automatically add new organization accounts.
-
The account was disassociated or deleted in Security Hub.
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the
EnableSecurityHub
operation.For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the
InviteMembers
operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.
-
If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
-
For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
A permissions policy is added that permits the administrator account to view the findings generated in the member account.
To remove the association between the administrator and member accounts, use the
DisassociateFromMasterAccount
orDisassociateMembers
operation.- Parameters:
createMembersRequest
-- Returns:
- Result of the CreateMembers operation returned by the service.
- See Also:
-
-
createMembers
default CreateMembersResponse createMembers(Consumer<CreateMembersRequest.Builder> createMembersRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, ResourceConflictException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.
CreateMembers
is always used to add accounts that are not organization members.For accounts that are managed using Organizations,
CreateMembers
is only used in the following cases:-
Security Hub is not configured to automatically add new organization accounts.
-
The account was disassociated or deleted in Security Hub.
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the
EnableSecurityHub
operation.For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the
InviteMembers
operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.
-
If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
-
For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
A permissions policy is added that permits the administrator account to view the findings generated in the member account.
To remove the association between the administrator and member accounts, use the
DisassociateFromMasterAccount
orDisassociateMembers
operation.
This is a convenience which creates an instance of the
CreateMembersRequest.Builder
avoiding the need to create one manually viaCreateMembersRequest.builder()
- Parameters:
createMembersRequest
- AConsumer
that will call methods onCreateMembersRequest.Builder
to create a request.- Returns:
- Result of the CreateMembers operation returned by the service.
- See Also:
-
-
declineInvitations
default DeclineInvitationsResponse declineInvitations(DeclineInvitationsRequest declineInvitationsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DeclineInvitations operation returned by the service.
- See Also:
-
declineInvitations
default DeclineInvitationsResponse declineInvitations(Consumer<DeclineInvitationsRequest.Builder> declineInvitationsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDeclineInvitationsRequest.builder()
- Parameters:
declineInvitationsRequest
- AConsumer
that will call methods onDeclineInvitationsRequest.Builder
to create a request.- Returns:
- Result of the DeclineInvitations operation returned by the service.
- See Also:
-
deleteActionTarget
default DeleteActionTargetResponse deleteActionTarget(DeleteActionTargetRequest deleteActionTargetRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DeleteActionTarget operation returned by the service.
- See Also:
-
deleteActionTarget
default DeleteActionTargetResponse deleteActionTarget(Consumer<DeleteActionTargetRequest.Builder> deleteActionTargetRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDeleteActionTargetRequest.builder()
- Parameters:
deleteActionTargetRequest
- AConsumer
that will call methods onDeleteActionTargetRequest.Builder
to create a request.- Returns:
- Result of the DeleteActionTarget operation returned by the service.
- See Also:
-
deleteConfigurationPolicy
default DeleteConfigurationPolicyResponse deleteConfigurationPolicy(DeleteConfigurationPolicyRequest deleteConfigurationPolicyRequest) throws AccessDeniedException, InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException Deletes a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts, organizational units, or the root by invoking the
StartConfigurationPolicyDisassociation
operation.- Parameters:
deleteConfigurationPolicyRequest
-- Returns:
- Result of the DeleteConfigurationPolicy operation returned by the service.
- See Also:
-
deleteConfigurationPolicy
default DeleteConfigurationPolicyResponse deleteConfigurationPolicy(Consumer<DeleteConfigurationPolicyRequest.Builder> deleteConfigurationPolicyRequest) throws AccessDeniedException, InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException Deletes a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts, organizational units, or the root by invoking the
StartConfigurationPolicyDisassociation
operation.
This is a convenience which creates an instance of the
DeleteConfigurationPolicyRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationPolicyRequest.builder()
- Parameters:
deleteConfigurationPolicyRequest
- AConsumer
that will call methods onDeleteConfigurationPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteConfigurationPolicy operation returned by the service.
- See Also:
-
deleteFindingAggregator
default DeleteFindingAggregatorResponse deleteFindingAggregator(DeleteFindingAggregatorRequest deleteFindingAggregatorRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DeleteFindingAggregator operation returned by the service.
- See Also:
-
deleteFindingAggregator
default DeleteFindingAggregatorResponse deleteFindingAggregator(Consumer<DeleteFindingAggregatorRequest.Builder> deleteFindingAggregatorRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDeleteFindingAggregatorRequest.builder()
- Parameters:
deleteFindingAggregatorRequest
- AConsumer
that will call methods onDeleteFindingAggregatorRequest.Builder
to create a request.- Returns:
- Result of the DeleteFindingAggregator operation returned by the service.
- See Also:
-
deleteInsight
default DeleteInsightResponse deleteInsight(DeleteInsightRequest deleteInsightRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Deletes the insight specified by the
InsightArn
.- Parameters:
deleteInsightRequest
-- Returns:
- Result of the DeleteInsight operation returned by the service.
- See Also:
-
deleteInsight
default DeleteInsightResponse deleteInsight(Consumer<DeleteInsightRequest.Builder> deleteInsightRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Deletes the insight specified by the
InsightArn
.
This is a convenience which creates an instance of the
DeleteInsightRequest.Builder
avoiding the need to create one manually viaDeleteInsightRequest.builder()
- Parameters:
deleteInsightRequest
- AConsumer
that will call methods onDeleteInsightRequest.Builder
to create a request.- Returns:
- Result of the DeleteInsight operation returned by the service.
- See Also:
-
deleteInvitations
default DeleteInvitationsResponse deleteInvitations(DeleteInvitationsRequest deleteInvitationsRequest) throws InternalException, InvalidInputException, LimitExceededException, ResourceNotFoundException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DeleteInvitations operation returned by the service.
- See Also:
-
deleteInvitations
default DeleteInvitationsResponse deleteInvitations(Consumer<DeleteInvitationsRequest.Builder> deleteInvitationsRequest) throws InternalException, InvalidInputException, LimitExceededException, ResourceNotFoundException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDeleteInvitationsRequest.builder()
- Parameters:
deleteInvitationsRequest
- AConsumer
that will call methods onDeleteInvitationsRequest.Builder
to create a request.- Returns:
- Result of the DeleteInvitations operation returned by the service.
- See Also:
-
deleteMembers
default DeleteMembersResponse deleteMembers(DeleteMembersRequest deleteMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DeleteMembers operation returned by the service.
- See Also:
-
deleteMembers
default DeleteMembersResponse deleteMembers(Consumer<DeleteMembersRequest.Builder> deleteMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDeleteMembersRequest.builder()
- Parameters:
deleteMembersRequest
- AConsumer
that will call methods onDeleteMembersRequest.Builder
to create a request.- Returns:
- Result of the DeleteMembers operation returned by the service.
- See Also:
-
describeActionTargets
default DescribeActionTargetsResponse describeActionTargets(DescribeActionTargetsRequest describeActionTargetsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Returns a list of the custom action targets in Security Hub in your account.
- Parameters:
describeActionTargetsRequest
-- Returns:
- Result of the DescribeActionTargets operation returned by the service.
- See Also:
-
describeActionTargets
default DescribeActionTargetsResponse describeActionTargets(Consumer<DescribeActionTargetsRequest.Builder> describeActionTargetsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDescribeActionTargetsRequest.builder()
- Parameters:
describeActionTargetsRequest
- AConsumer
that will call methods onDescribeActionTargetsRequest.Builder
to create a request.- Returns:
- Result of the DescribeActionTargets operation returned by the service.
- See Also:
-
describeActionTargetsPaginator
default DescribeActionTargetsIterable describeActionTargetsPaginator(DescribeActionTargetsRequest describeActionTargetsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
describeActionTargets(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsIterable responses = client.describeActionTargetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsIterable responses = client .describeActionTargetsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsIterable responses = client.describeActionTargetsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeActionTargetsPaginator
default DescribeActionTargetsIterable describeActionTargetsPaginator(Consumer<DescribeActionTargetsRequest.Builder> describeActionTargetsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
describeActionTargets(software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsIterable responses = client.describeActionTargetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsIterable responses = client .describeActionTargetsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.DescribeActionTargetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.DescribeActionTargetsIterable responses = client.describeActionTargetsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaDescribeActionTargetsRequest.builder()
- Parameters:
describeActionTargetsRequest
- AConsumer
that will call methods onDescribeActionTargetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeHub
default DescribeHubResponse describeHub(DescribeHubRequest describeHubRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Returns details about the Hub resource in your account, including the
HubArn
and the time when you enabled Security Hub.- Parameters:
describeHubRequest
-- Returns:
- Result of the DescribeHub operation returned by the service.
- See Also:
-
describeHub
default DescribeHubResponse describeHub(Consumer<DescribeHubRequest.Builder> describeHubRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Returns details about the Hub resource in your account, including the
HubArn
and the time when you enabled Security Hub.
This is a convenience which creates an instance of the
DescribeHubRequest.Builder
avoiding the need to create one manually viaDescribeHubRequest.builder()
- Parameters:
describeHubRequest
- AConsumer
that will call methods onDescribeHubRequest.Builder
to create a request.- Returns:
- Result of the DescribeHub operation returned by the service.
- See Also:
-
describeOrganizationConfiguration
default DescribeOrganizationConfigurationResponse describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation.
- Parameters:
describeOrganizationConfigurationRequest
-- Returns:
- Result of the DescribeOrganizationConfiguration operation returned by the service.
- See Also:
-
describeOrganizationConfiguration
default DescribeOrganizationConfigurationResponse describeOrganizationConfiguration(Consumer<DescribeOrganizationConfigurationRequest.Builder> describeOrganizationConfigurationRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation.
This is a convenience which creates an instance of the
DescribeOrganizationConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationConfigurationRequest.builder()
- Parameters:
describeOrganizationConfigurationRequest
- AConsumer
that will call methods onDescribeOrganizationConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DescribeOrganizationConfiguration operation returned by the service.
- See Also:
-
describeProducts
default DescribeProductsResponse describeProducts(DescribeProductsRequest describeProductsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DescribeProducts operation returned by the service.
- See Also:
-
describeProducts
default DescribeProductsResponse describeProducts(Consumer<DescribeProductsRequest.Builder> describeProductsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDescribeProductsRequest.builder()
- Parameters:
describeProductsRequest
- AConsumer
that will call methods onDescribeProductsRequest.Builder
to create a request.- Returns:
- Result of the DescribeProducts operation returned by the service.
- See Also:
-
describeProductsPaginator
default DescribeProductsIterable describeProductsPaginator(DescribeProductsRequest describeProductsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
describeProducts(software.amazon.awssdk.services.securityhub.model.DescribeProductsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.DescribeProductsIterable responses = client.describeProductsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.DescribeProductsIterable responses = client .describeProductsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.DescribeProductsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.DescribeProductsIterable responses = client.describeProductsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeProductsPaginator
default DescribeProductsIterable describeProductsPaginator(Consumer<DescribeProductsRequest.Builder> describeProductsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
describeProducts(software.amazon.awssdk.services.securityhub.model.DescribeProductsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.DescribeProductsIterable responses = client.describeProductsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.DescribeProductsIterable responses = client .describeProductsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.DescribeProductsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.DescribeProductsIterable responses = client.describeProductsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaDescribeProductsRequest.builder()
- Parameters:
describeProductsRequest
- AConsumer
that will call methods onDescribeProductsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStandards
default DescribeStandardsResponse describeStandards(DescribeStandardsRequest describeStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DescribeStandards operation returned by the service.
- See Also:
-
describeStandards
default DescribeStandardsResponse describeStandards(Consumer<DescribeStandardsRequest.Builder> describeStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDescribeStandardsRequest.builder()
- Parameters:
describeStandardsRequest
- AConsumer
that will call methods onDescribeStandardsRequest.Builder
to create a request.- Returns:
- Result of the DescribeStandards operation returned by the service.
- See Also:
-
describeStandardsPaginator
default DescribeStandardsIterable describeStandardsPaginator(DescribeStandardsRequest describeStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
describeStandards(software.amazon.awssdk.services.securityhub.model.DescribeStandardsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsIterable responses = client.describeStandardsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.DescribeStandardsIterable responses = client .describeStandardsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.DescribeStandardsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsIterable responses = client.describeStandardsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStandardsPaginator
default DescribeStandardsIterable describeStandardsPaginator(Consumer<DescribeStandardsRequest.Builder> describeStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
describeStandards(software.amazon.awssdk.services.securityhub.model.DescribeStandardsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsIterable responses = client.describeStandardsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.DescribeStandardsIterable responses = client .describeStandardsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.DescribeStandardsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsIterable responses = client.describeStandardsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaDescribeStandardsRequest.builder()
- Parameters:
describeStandardsRequest
- AConsumer
that will call methods onDescribeStandardsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStandardsControls
default DescribeStandardsControlsResponse describeStandardsControls(DescribeStandardsControlsRequest describeStandardsControlsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DescribeStandardsControls operation returned by the service.
- See Also:
-
describeStandardsControls
default DescribeStandardsControlsResponse describeStandardsControls(Consumer<DescribeStandardsControlsRequest.Builder> describeStandardsControlsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDescribeStandardsControlsRequest.builder()
- Parameters:
describeStandardsControlsRequest
- AConsumer
that will call methods onDescribeStandardsControlsRequest.Builder
to create a request.- Returns:
- Result of the DescribeStandardsControls operation returned by the service.
- See Also:
-
describeStandardsControlsPaginator
default DescribeStandardsControlsIterable describeStandardsControlsPaginator(DescribeStandardsControlsRequest describeStandardsControlsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
describeStandardsControls(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsIterable responses = client.describeStandardsControlsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsIterable responses = client .describeStandardsControlsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsIterable responses = client.describeStandardsControlsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStandardsControlsPaginator
default DescribeStandardsControlsIterable describeStandardsControlsPaginator(Consumer<DescribeStandardsControlsRequest.Builder> describeStandardsControlsRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
describeStandardsControls(software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsIterable responses = client.describeStandardsControlsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsIterable responses = client .describeStandardsControlsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.DescribeStandardsControlsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.DescribeStandardsControlsIterable responses = client.describeStandardsControlsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaDescribeStandardsControlsRequest.builder()
- Parameters:
describeStandardsControlsRequest
- AConsumer
that will call methods onDescribeStandardsControlsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
disableImportFindingsForProduct
default DisableImportFindingsForProductResponse disableImportFindingsForProduct(DisableImportFindingsForProductRequest disableImportFindingsForProductRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DisableImportFindingsForProduct operation returned by the service.
- See Also:
-
disableImportFindingsForProduct
default DisableImportFindingsForProductResponse disableImportFindingsForProduct(Consumer<DisableImportFindingsForProductRequest.Builder> disableImportFindingsForProductRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDisableImportFindingsForProductRequest.builder()
- Parameters:
disableImportFindingsForProductRequest
- AConsumer
that will call methods onDisableImportFindingsForProductRequest.Builder
to create a request.- Returns:
- Result of the DisableImportFindingsForProduct operation returned by the service.
- See Also:
-
disableOrganizationAdminAccount
default DisableOrganizationAdminAccountResponse disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Disables a Security Hub administrator account. Can only be called by the organization management account.
- Parameters:
disableOrganizationAdminAccountRequest
-- Returns:
- Result of the DisableOrganizationAdminAccount operation returned by the service.
- See Also:
-
disableOrganizationAdminAccount
default DisableOrganizationAdminAccountResponse disableOrganizationAdminAccount(Consumer<DisableOrganizationAdminAccountRequest.Builder> disableOrganizationAdminAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDisableOrganizationAdminAccountRequest.builder()
- Parameters:
disableOrganizationAdminAccountRequest
- AConsumer
that will call methods onDisableOrganizationAdminAccountRequest.Builder
to create a request.- Returns:
- Result of the DisableOrganizationAdminAccount operation returned by the service.
- See Also:
-
disableSecurityHub
default DisableSecurityHubResponse disableSecurityHub(DisableSecurityHubRequest disableSecurityHubRequest) throws InternalException, LimitExceededException, InvalidAccessException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DisableSecurityHub operation returned by the service.
- See Also:
-
disableSecurityHub
default DisableSecurityHubResponse disableSecurityHub(Consumer<DisableSecurityHubRequest.Builder> disableSecurityHubRequest) throws InternalException, LimitExceededException, InvalidAccessException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDisableSecurityHubRequest.builder()
- Parameters:
disableSecurityHubRequest
- AConsumer
that will call methods onDisableSecurityHubRequest.Builder
to create a request.- Returns:
- Result of the DisableSecurityHub operation returned by the service.
- See Also:
-
disableSecurityHub
default DisableSecurityHubResponse disableSecurityHub() throws InternalException, LimitExceededException, InvalidAccessException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubExceptionDisables 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:
- Result of the DisableSecurityHub operation returned by the service.
- See Also:
-
disassociateFromAdministratorAccount
default DisassociateFromAdministratorAccountResponse disassociateFromAdministratorAccount(DisassociateFromAdministratorAccountRequest disassociateFromAdministratorAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DisassociateFromAdministratorAccount operation returned by the service.
- See Also:
-
disassociateFromAdministratorAccount
default DisassociateFromAdministratorAccountResponse disassociateFromAdministratorAccount(Consumer<DisassociateFromAdministratorAccountRequest.Builder> disassociateFromAdministratorAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDisassociateFromAdministratorAccountRequest.builder()
- Parameters:
disassociateFromAdministratorAccountRequest
- AConsumer
that will call methods onDisassociateFromAdministratorAccountRequest.Builder
to create a request.- Returns:
- Result of the DisassociateFromAdministratorAccount operation returned by the service.
- See Also:
-
disassociateFromMasterAccount
@Deprecated default DisassociateFromMasterAccountResponse disassociateFromMasterAccount(DisassociateFromMasterAccountRequest disassociateFromMasterAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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 addDisassociateFromAdministratorAccount
to 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:
- Result of the DisassociateFromMasterAccount operation returned by the service.
- See Also:
-
disassociateFromMasterAccount
@Deprecated default DisassociateFromMasterAccountResponse disassociateFromMasterAccount(Consumer<DisassociateFromMasterAccountRequest.Builder> disassociateFromMasterAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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 addDisassociateFromAdministratorAccount
to 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.Builder
avoiding the need to create one manually viaDisassociateFromMasterAccountRequest.builder()
- Parameters:
disassociateFromMasterAccountRequest
- AConsumer
that will call methods onDisassociateFromMasterAccountRequest.Builder
to create a request.- Returns:
- Result of the DisassociateFromMasterAccount operation returned by the service.
- See Also:
-
disassociateMembers
default DisassociateMembersResponse disassociateMembers(DisassociateMembersRequest disassociateMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the DisassociateMembers operation returned by the service.
- See Also:
-
disassociateMembers
default DisassociateMembersResponse disassociateMembers(Consumer<DisassociateMembersRequest.Builder> disassociateMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaDisassociateMembersRequest.builder()
- Parameters:
disassociateMembersRequest
- AConsumer
that will call methods onDisassociateMembersRequest.Builder
to create a request.- Returns:
- Result of the DisassociateMembers operation returned by the service.
- See Also:
-
enableImportFindingsForProduct
default EnableImportFindingsForProductResponse enableImportFindingsForProduct(EnableImportFindingsForProductRequest enableImportFindingsForProductRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceConflictException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the EnableImportFindingsForProduct operation returned by the service.
- See Also:
-
enableImportFindingsForProduct
default EnableImportFindingsForProductResponse enableImportFindingsForProduct(Consumer<EnableImportFindingsForProductRequest.Builder> enableImportFindingsForProductRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceConflictException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaEnableImportFindingsForProductRequest.builder()
- Parameters:
enableImportFindingsForProductRequest
- AConsumer
that will call methods onEnableImportFindingsForProductRequest.Builder
to create a request.- Returns:
- Result of the EnableImportFindingsForProduct operation returned by the service.
- See Also:
-
enableOrganizationAdminAccount
default EnableOrganizationAdminAccountResponse enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.
- Parameters:
enableOrganizationAdminAccountRequest
-- Returns:
- Result of the EnableOrganizationAdminAccount operation returned by the service.
- See Also:
-
enableOrganizationAdminAccount
default EnableOrganizationAdminAccountResponse enableOrganizationAdminAccount(Consumer<EnableOrganizationAdminAccountRequest.Builder> enableOrganizationAdminAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaEnableOrganizationAdminAccountRequest.builder()
- Parameters:
enableOrganizationAdminAccountRequest
- AConsumer
that will call methods onEnableOrganizationAdminAccountRequest.Builder
to create a request.- Returns:
- Result of the EnableOrganizationAdminAccount operation returned by the service.
- See Also:
-
enableSecurityHub
default EnableSecurityHubResponse enableSecurityHub(EnableSecurityHubRequest enableSecurityHubRequest) throws InternalException, LimitExceededException, InvalidAccessException, ResourceConflictException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Enables Security Hub for your account in the current Region or the Region you specify in the request.
When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.
When you use the
EnableSecurityHub
operation to enable Security Hub, you also automatically enable the following standards:-
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
-
Amazon Web Services Foundational Security Best Practices
Other standards are not automatically enabled.
To opt out of automatically enabled standards, set
EnableDefaultStandards
tofalse
.After you enable Security Hub, to enable a standard, use the
BatchEnableStandards
operation. To disable a standard, use theBatchDisableStandards
operation.To learn more, see the setup information in the Security Hub User Guide.
- Parameters:
enableSecurityHubRequest
-- Returns:
- Result of the EnableSecurityHub operation returned by the service.
- See Also:
-
-
enableSecurityHub
default EnableSecurityHubResponse enableSecurityHub(Consumer<EnableSecurityHubRequest.Builder> enableSecurityHubRequest) throws InternalException, LimitExceededException, InvalidAccessException, ResourceConflictException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Enables Security Hub for your account in the current Region or the Region you specify in the request.
When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.
When you use the
EnableSecurityHub
operation to enable Security Hub, you also automatically enable the following standards:-
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
-
Amazon Web Services Foundational Security Best Practices
Other standards are not automatically enabled.
To opt out of automatically enabled standards, set
EnableDefaultStandards
tofalse
.After you enable Security Hub, to enable a standard, use the
BatchEnableStandards
operation. To disable a standard, use theBatchDisableStandards
operation.To learn more, see the setup information in the Security Hub User Guide.
This is a convenience which creates an instance of the
EnableSecurityHubRequest.Builder
avoiding the need to create one manually viaEnableSecurityHubRequest.builder()
- Parameters:
enableSecurityHubRequest
- AConsumer
that will call methods onEnableSecurityHubRequest.Builder
to create a request.- Returns:
- Result of the EnableSecurityHub operation returned by the service.
- See Also:
-
-
enableSecurityHub
default EnableSecurityHubResponse enableSecurityHub() throws InternalException, LimitExceededException, InvalidAccessException, ResourceConflictException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubExceptionEnables Security Hub for your account in the current Region or the Region you specify in the request.
When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.
When you use the
EnableSecurityHub
operation to enable Security Hub, you also automatically enable the following standards:-
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
-
Amazon Web Services Foundational Security Best Practices
Other standards are not automatically enabled.
To opt out of automatically enabled standards, set
EnableDefaultStandards
tofalse
.After you enable Security Hub, to enable a standard, use the
BatchEnableStandards
operation. To disable a standard, use theBatchDisableStandards
operation.To learn more, see the setup information in the Security Hub User Guide.
- Returns:
- Result of the EnableSecurityHub operation returned by the service.
- See Also:
-
-
getAdministratorAccount
default GetAdministratorAccountResponse getAdministratorAccount(GetAdministratorAccountRequest getAdministratorAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the GetAdministratorAccount operation returned by the service.
- See Also:
-
getAdministratorAccount
default GetAdministratorAccountResponse getAdministratorAccount(Consumer<GetAdministratorAccountRequest.Builder> getAdministratorAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaGetAdministratorAccountRequest.builder()
- Parameters:
getAdministratorAccountRequest
- AConsumer
that will call methods onGetAdministratorAccountRequest.Builder
to create a request.- Returns:
- Result of the GetAdministratorAccount operation returned by the service.
- See Also:
-
getConfigurationPolicy
default GetConfigurationPolicyResponse getConfigurationPolicy(GetConfigurationPolicyRequest getConfigurationPolicyRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- Parameters:
getConfigurationPolicyRequest
-- Returns:
- Result of the GetConfigurationPolicy operation returned by the service.
- See Also:
-
getConfigurationPolicy
default GetConfigurationPolicyResponse getConfigurationPolicy(Consumer<GetConfigurationPolicyRequest.Builder> getConfigurationPolicyRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
This is a convenience which creates an instance of the
GetConfigurationPolicyRequest.Builder
avoiding the need to create one manually viaGetConfigurationPolicyRequest.builder()
- Parameters:
getConfigurationPolicyRequest
- AConsumer
that will call methods onGetConfigurationPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetConfigurationPolicy operation returned by the service.
- See Also:
-
getConfigurationPolicyAssociation
default GetConfigurationPolicyAssociationResponse getConfigurationPolicyAssociation(GetConfigurationPolicyAssociationRequest getConfigurationPolicyAssociationRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Returns the association between a configuration and a target account, organizational unit, or the root. The configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- Parameters:
getConfigurationPolicyAssociationRequest
-- Returns:
- Result of the GetConfigurationPolicyAssociation operation returned by the service.
- See Also:
-
getConfigurationPolicyAssociation
default GetConfigurationPolicyAssociationResponse getConfigurationPolicyAssociation(Consumer<GetConfigurationPolicyAssociationRequest.Builder> getConfigurationPolicyAssociationRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Returns the association between a configuration and a target account, organizational unit, or the root. The configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
This is a convenience which creates an instance of the
GetConfigurationPolicyAssociationRequest.Builder
avoiding the need to create one manually viaGetConfigurationPolicyAssociationRequest.builder()
- Parameters:
getConfigurationPolicyAssociationRequest
- AConsumer
that will call methods onGetConfigurationPolicyAssociationRequest.Builder
to create a request.- Returns:
- Result of the GetConfigurationPolicyAssociation operation returned by the service.
- See Also:
-
getEnabledStandards
default GetEnabledStandardsResponse getEnabledStandards(GetEnabledStandardsRequest getEnabledStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Returns a list of the standards that are currently enabled.
- Parameters:
getEnabledStandardsRequest
-- Returns:
- Result of the GetEnabledStandards operation returned by the service.
- See Also:
-
getEnabledStandards
default GetEnabledStandardsResponse getEnabledStandards(Consumer<GetEnabledStandardsRequest.Builder> getEnabledStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Returns a list of the standards that are currently enabled.
This is a convenience which creates an instance of the
GetEnabledStandardsRequest.Builder
avoiding the need to create one manually viaGetEnabledStandardsRequest.builder()
- Parameters:
getEnabledStandardsRequest
- AConsumer
that will call methods onGetEnabledStandardsRequest.Builder
to create a request.- Returns:
- Result of the GetEnabledStandards operation returned by the service.
- See Also:
-
getEnabledStandardsPaginator
default GetEnabledStandardsIterable getEnabledStandardsPaginator(GetEnabledStandardsRequest getEnabledStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
getEnabledStandards(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsIterable responses = client.getEnabledStandardsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsIterable responses = client .getEnabledStandardsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsIterable responses = client.getEnabledStandardsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
getEnabledStandardsPaginator
default GetEnabledStandardsIterable getEnabledStandardsPaginator(Consumer<GetEnabledStandardsRequest.Builder> getEnabledStandardsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
getEnabledStandards(software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsIterable responses = client.getEnabledStandardsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsIterable responses = client .getEnabledStandardsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.GetEnabledStandardsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.GetEnabledStandardsIterable responses = client.getEnabledStandardsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaGetEnabledStandardsRequest.builder()
- Parameters:
getEnabledStandardsRequest
- AConsumer
that will call methods onGetEnabledStandardsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getFindingAggregator
default GetFindingAggregatorResponse getFindingAggregator(GetFindingAggregatorRequest getFindingAggregatorRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Returns the current finding aggregation configuration.
- Parameters:
getFindingAggregatorRequest
-- Returns:
- Result of the GetFindingAggregator operation returned by the service.
- See Also:
-
getFindingAggregator
default GetFindingAggregatorResponse getFindingAggregator(Consumer<GetFindingAggregatorRequest.Builder> getFindingAggregatorRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Returns the current finding aggregation configuration.
This is a convenience which creates an instance of the
GetFindingAggregatorRequest.Builder
avoiding the need to create one manually viaGetFindingAggregatorRequest.builder()
- Parameters:
getFindingAggregatorRequest
- AConsumer
that will call methods onGetFindingAggregatorRequest.Builder
to create a request.- Returns:
- Result of the GetFindingAggregator operation returned by the service.
- See Also:
-
getFindingHistory
default GetFindingHistoryResponse getFindingHistory(GetFindingHistoryRequest getFindingHistoryRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the GetFindingHistory operation returned by the service.
- See Also:
-
getFindingHistory
default GetFindingHistoryResponse getFindingHistory(Consumer<GetFindingHistoryRequest.Builder> getFindingHistoryRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaGetFindingHistoryRequest.builder()
- Parameters:
getFindingHistoryRequest
- AConsumer
that will call methods onGetFindingHistoryRequest.Builder
to create a request.- Returns:
- Result of the GetFindingHistory operation returned by the service.
- See Also:
-
getFindingHistoryPaginator
default GetFindingHistoryIterable getFindingHistoryPaginator(GetFindingHistoryRequest getFindingHistoryRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
getFindingHistory(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryIterable responses = client.getFindingHistoryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryIterable responses = client .getFindingHistoryPaginator(request); for (software.amazon.awssdk.services.securityhub.model.GetFindingHistoryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryIterable responses = client.getFindingHistoryPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
getFindingHistoryPaginator
default GetFindingHistoryIterable getFindingHistoryPaginator(Consumer<GetFindingHistoryRequest.Builder> getFindingHistoryRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
getFindingHistory(software.amazon.awssdk.services.securityhub.model.GetFindingHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryIterable responses = client.getFindingHistoryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryIterable responses = client .getFindingHistoryPaginator(request); for (software.amazon.awssdk.services.securityhub.model.GetFindingHistoryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.GetFindingHistoryIterable responses = client.getFindingHistoryPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaGetFindingHistoryRequest.builder()
- Parameters:
getFindingHistoryRequest
- AConsumer
that will call methods onGetFindingHistoryRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getFindings
default GetFindingsResponse getFindings(GetFindingsRequest getFindingsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindings
from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.- Parameters:
getFindingsRequest
-- Returns:
- Result of the GetFindings operation returned by the service.
- See Also:
-
getFindings
default GetFindingsResponse getFindings(Consumer<GetFindingsRequest.Builder> getFindingsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindings
from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
This is a convenience which creates an instance of the
GetFindingsRequest.Builder
avoiding the need to create one manually viaGetFindingsRequest.builder()
- Parameters:
getFindingsRequest
- AConsumer
that will call methods onGetFindingsRequest.Builder
to create a request.- Returns:
- Result of the GetFindings operation returned by the service.
- See Also:
-
getFindings
default GetFindingsResponse getFindings() throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubExceptionReturns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call
GetFindings
from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.- Returns:
- Result of the GetFindings operation returned by the service.
- See Also:
-
getFindingsPaginator
default GetFindingsIterable getFindingsPaginator() throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubExceptionThis is a variant of
getFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.GetFindingsIterable responses = client.getFindingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.GetFindingsIterable responses = client.getFindingsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.GetFindingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.GetFindingsIterable responses = client.getFindingsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
getFindingsPaginator
default GetFindingsIterable getFindingsPaginator(GetFindingsRequest getFindingsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
getFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.GetFindingsIterable responses = client.getFindingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.GetFindingsIterable responses = client.getFindingsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.GetFindingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.GetFindingsIterable responses = client.getFindingsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
getFindingsPaginator
default GetFindingsIterable getFindingsPaginator(Consumer<GetFindingsRequest.Builder> getFindingsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
getFindings(software.amazon.awssdk.services.securityhub.model.GetFindingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.GetFindingsIterable responses = client.getFindingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.GetFindingsIterable responses = client.getFindingsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.GetFindingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.GetFindingsIterable responses = client.getFindingsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaGetFindingsRequest.builder()
- Parameters:
getFindingsRequest
- AConsumer
that will call methods onGetFindingsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getInsightResults
default GetInsightResultsResponse getInsightResults(GetInsightResultsRequest getInsightResultsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Lists the results of the Security Hub insight specified by the insight ARN.
- Parameters:
getInsightResultsRequest
-- Returns:
- Result of the GetInsightResults operation returned by the service.
- See Also:
-
getInsightResults
default GetInsightResultsResponse getInsightResults(Consumer<GetInsightResultsRequest.Builder> getInsightResultsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Lists the results of the Security Hub insight specified by the insight ARN.
This is a convenience which creates an instance of the
GetInsightResultsRequest.Builder
avoiding the need to create one manually viaGetInsightResultsRequest.builder()
- Parameters:
getInsightResultsRequest
- AConsumer
that will call methods onGetInsightResultsRequest.Builder
to create a request.- Returns:
- Result of the GetInsightResults operation returned by the service.
- See Also:
-
getInsights
default GetInsightsResponse getInsights(GetInsightsRequest getInsightsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Lists and describes insights for the specified insight ARNs.
- Parameters:
getInsightsRequest
-- Returns:
- Result of the GetInsights operation returned by the service.
- See Also:
-
getInsights
default GetInsightsResponse getInsights(Consumer<GetInsightsRequest.Builder> getInsightsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Lists and describes insights for the specified insight ARNs.
This is a convenience which creates an instance of the
GetInsightsRequest.Builder
avoiding the need to create one manually viaGetInsightsRequest.builder()
- Parameters:
getInsightsRequest
- AConsumer
that will call methods onGetInsightsRequest.Builder
to create a request.- Returns:
- Result of the GetInsights operation returned by the service.
- See Also:
-
getInsightsPaginator
default GetInsightsIterable getInsightsPaginator(GetInsightsRequest getInsightsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
getInsights(software.amazon.awssdk.services.securityhub.model.GetInsightsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.GetInsightsIterable responses = client.getInsightsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.GetInsightsIterable responses = client.getInsightsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.GetInsightsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.GetInsightsIterable responses = client.getInsightsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
getInsightsPaginator
default GetInsightsIterable getInsightsPaginator(Consumer<GetInsightsRequest.Builder> getInsightsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
getInsights(software.amazon.awssdk.services.securityhub.model.GetInsightsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.GetInsightsIterable responses = client.getInsightsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.GetInsightsIterable responses = client.getInsightsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.GetInsightsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.GetInsightsIterable responses = client.getInsightsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaGetInsightsRequest.builder()
- Parameters:
getInsightsRequest
- AConsumer
that will call methods onGetInsightsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getInvitationsCount
default GetInvitationsCountResponse getInvitationsCount(GetInvitationsCountRequest getInvitationsCountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the GetInvitationsCount operation returned by the service.
- See Also:
-
getInvitationsCount
default GetInvitationsCountResponse getInvitationsCount(Consumer<GetInvitationsCountRequest.Builder> getInvitationsCountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaGetInvitationsCountRequest.builder()
- Parameters:
getInvitationsCountRequest
- AConsumer
that will call methods onGetInvitationsCountRequest.Builder
to create a request.- Returns:
- Result of the GetInvitationsCount operation returned by the service.
- See Also:
-
getInvitationsCount
default GetInvitationsCountResponse getInvitationsCount() throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubExceptionReturns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
- Returns:
- Result of the GetInvitationsCount operation returned by the service.
- See Also:
-
getMasterAccount
@Deprecated default GetMasterAccountResponse getMasterAccount(GetMasterAccountRequest getMasterAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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 addGetAdministratorAccount
to 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:
- Result of the GetMasterAccount operation returned by the service.
- See Also:
-
getMasterAccount
@Deprecated default GetMasterAccountResponse getMasterAccount(Consumer<GetMasterAccountRequest.Builder> getMasterAccountRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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 addGetAdministratorAccount
to 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.Builder
avoiding the need to create one manually viaGetMasterAccountRequest.builder()
- Parameters:
getMasterAccountRequest
- AConsumer
that will call methods onGetMasterAccountRequest.Builder
to create a request.- Returns:
- Result of the GetMasterAccount operation returned by the service.
- See Also:
-
getMasterAccount
@Deprecated default GetMasterAccountResponse getMasterAccount() throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubExceptionDeprecated.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 addGetAdministratorAccount
to 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:
- Result of the GetMasterAccount operation returned by the service.
- See Also:
-
getMembers
default GetMembersResponse getMembers(GetMembersRequest getMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the GetMembers operation returned by the service.
- See Also:
-
getMembers
default GetMembersResponse getMembers(Consumer<GetMembersRequest.Builder> getMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaGetMembersRequest.builder()
- Parameters:
getMembersRequest
- AConsumer
that will call methods onGetMembersRequest.Builder
to create a request.- Returns:
- Result of the GetMembers operation returned by the service.
- See Also:
-
getSecurityControlDefinition
default GetSecurityControlDefinitionResponse getSecurityControlDefinition(GetSecurityControlDefinitionRequest getSecurityControlDefinitionRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.
- Parameters:
getSecurityControlDefinitionRequest
-- Returns:
- Result of the GetSecurityControlDefinition operation returned by the service.
- See Also:
-
getSecurityControlDefinition
default GetSecurityControlDefinitionResponse getSecurityControlDefinition(Consumer<GetSecurityControlDefinitionRequest.Builder> getSecurityControlDefinitionRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.
This is a convenience which creates an instance of the
GetSecurityControlDefinitionRequest.Builder
avoiding the need to create one manually viaGetSecurityControlDefinitionRequest.builder()
- Parameters:
getSecurityControlDefinitionRequest
- AConsumer
that will call methods onGetSecurityControlDefinitionRequest.Builder
to create a request.- Returns:
- Result of the GetSecurityControlDefinition operation returned by the service.
- See Also:
-
inviteMembers
default InviteMembersResponse inviteMembers(InviteMembersRequest inviteMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.
Before you can use this action to invite a member, you must first use the
CreateMembers
action to create the member account in Security Hub.When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
- Parameters:
inviteMembersRequest
-- Returns:
- Result of the InviteMembers operation returned by the service.
- See Also:
-
inviteMembers
default InviteMembersResponse inviteMembers(Consumer<InviteMembersRequest.Builder> inviteMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.
Before you can use this action to invite a member, you must first use the
CreateMembers
action to create the member account in Security Hub.When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
This is a convenience which creates an instance of the
InviteMembersRequest.Builder
avoiding the need to create one manually viaInviteMembersRequest.builder()
- Parameters:
inviteMembersRequest
- AConsumer
that will call methods onInviteMembersRequest.Builder
to create a request.- Returns:
- Result of the InviteMembers operation returned by the service.
- See Also:
-
listAutomationRules
default ListAutomationRulesResponse listAutomationRules(ListAutomationRulesRequest listAutomationRulesRequest) throws AccessDeniedException, InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException A list of automation rules and their metadata for the calling account.
- Parameters:
listAutomationRulesRequest
-- Returns:
- Result of the ListAutomationRules operation returned by the service.
- See Also:
-
listAutomationRules
default ListAutomationRulesResponse listAutomationRules(Consumer<ListAutomationRulesRequest.Builder> listAutomationRulesRequest) throws AccessDeniedException, InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException A list of automation rules and their metadata for the calling account.
This is a convenience which creates an instance of the
ListAutomationRulesRequest.Builder
avoiding the need to create one manually viaListAutomationRulesRequest.builder()
- Parameters:
listAutomationRulesRequest
- AConsumer
that will call methods onListAutomationRulesRequest.Builder
to create a request.- Returns:
- Result of the ListAutomationRules operation returned by the service.
- See Also:
-
listConfigurationPolicies
default ListConfigurationPoliciesResponse listConfigurationPolicies(ListConfigurationPoliciesRequest listConfigurationPoliciesRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Lists the configuration policies that the Security Hub delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region.
- Parameters:
listConfigurationPoliciesRequest
-- Returns:
- Result of the ListConfigurationPolicies operation returned by the service.
- See Also:
-
listConfigurationPolicies
default ListConfigurationPoliciesResponse listConfigurationPolicies(Consumer<ListConfigurationPoliciesRequest.Builder> listConfigurationPoliciesRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Lists the configuration policies that the Security Hub delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region.
This is a convenience which creates an instance of the
ListConfigurationPoliciesRequest.Builder
avoiding the need to create one manually viaListConfigurationPoliciesRequest.builder()
- Parameters:
listConfigurationPoliciesRequest
- AConsumer
that will call methods onListConfigurationPoliciesRequest.Builder
to create a request.- Returns:
- Result of the ListConfigurationPolicies operation returned by the service.
- See Also:
-
listConfigurationPoliciesPaginator
default ListConfigurationPoliciesIterable listConfigurationPoliciesPaginator(ListConfigurationPoliciesRequest listConfigurationPoliciesRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listConfigurationPolicies(software.amazon.awssdk.services.securityhub.model.ListConfigurationPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListConfigurationPoliciesIterable responses = client.listConfigurationPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListConfigurationPoliciesIterable responses = client .listConfigurationPoliciesPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListConfigurationPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListConfigurationPoliciesIterable responses = client.listConfigurationPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
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
listConfigurationPolicies(software.amazon.awssdk.services.securityhub.model.ListConfigurationPoliciesRequest)
operation.- Parameters:
listConfigurationPoliciesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listConfigurationPoliciesPaginator
default ListConfigurationPoliciesIterable listConfigurationPoliciesPaginator(Consumer<ListConfigurationPoliciesRequest.Builder> listConfigurationPoliciesRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listConfigurationPolicies(software.amazon.awssdk.services.securityhub.model.ListConfigurationPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListConfigurationPoliciesIterable responses = client.listConfigurationPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListConfigurationPoliciesIterable responses = client .listConfigurationPoliciesPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListConfigurationPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListConfigurationPoliciesIterable responses = client.listConfigurationPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
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
listConfigurationPolicies(software.amazon.awssdk.services.securityhub.model.ListConfigurationPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListConfigurationPoliciesRequest.Builder
avoiding the need to create one manually viaListConfigurationPoliciesRequest.builder()
- Parameters:
listConfigurationPoliciesRequest
- AConsumer
that will call methods onListConfigurationPoliciesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listConfigurationPolicyAssociations
default ListConfigurationPolicyAssociationsResponse listConfigurationPolicyAssociations(ListConfigurationPolicyAssociationsRequest listConfigurationPolicyAssociationsRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Provides information about the associations for your configuration policies and self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- Parameters:
listConfigurationPolicyAssociationsRequest
-- Returns:
- Result of the ListConfigurationPolicyAssociations operation returned by the service.
- See Also:
-
listConfigurationPolicyAssociations
default ListConfigurationPolicyAssociationsResponse listConfigurationPolicyAssociations(Consumer<ListConfigurationPolicyAssociationsRequest.Builder> listConfigurationPolicyAssociationsRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Provides information about the associations for your configuration policies and self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
This is a convenience which creates an instance of the
ListConfigurationPolicyAssociationsRequest.Builder
avoiding the need to create one manually viaListConfigurationPolicyAssociationsRequest.builder()
- Parameters:
listConfigurationPolicyAssociationsRequest
- AConsumer
that will call methods onListConfigurationPolicyAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListConfigurationPolicyAssociations operation returned by the service.
- See Also:
-
listConfigurationPolicyAssociationsPaginator
default ListConfigurationPolicyAssociationsIterable listConfigurationPolicyAssociationsPaginator(ListConfigurationPolicyAssociationsRequest listConfigurationPolicyAssociationsRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listConfigurationPolicyAssociations(software.amazon.awssdk.services.securityhub.model.ListConfigurationPolicyAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListConfigurationPolicyAssociationsIterable responses = client.listConfigurationPolicyAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListConfigurationPolicyAssociationsIterable responses = client .listConfigurationPolicyAssociationsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListConfigurationPolicyAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListConfigurationPolicyAssociationsIterable responses = client.listConfigurationPolicyAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
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
listConfigurationPolicyAssociations(software.amazon.awssdk.services.securityhub.model.ListConfigurationPolicyAssociationsRequest)
operation.- Parameters:
listConfigurationPolicyAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listConfigurationPolicyAssociationsPaginator
default ListConfigurationPolicyAssociationsIterable listConfigurationPolicyAssociationsPaginator(Consumer<ListConfigurationPolicyAssociationsRequest.Builder> listConfigurationPolicyAssociationsRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listConfigurationPolicyAssociations(software.amazon.awssdk.services.securityhub.model.ListConfigurationPolicyAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListConfigurationPolicyAssociationsIterable responses = client.listConfigurationPolicyAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListConfigurationPolicyAssociationsIterable responses = client .listConfigurationPolicyAssociationsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListConfigurationPolicyAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListConfigurationPolicyAssociationsIterable responses = client.listConfigurationPolicyAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
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
listConfigurationPolicyAssociations(software.amazon.awssdk.services.securityhub.model.ListConfigurationPolicyAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListConfigurationPolicyAssociationsRequest.Builder
avoiding the need to create one manually viaListConfigurationPolicyAssociationsRequest.builder()
- Parameters:
listConfigurationPolicyAssociationsRequest
- AConsumer
that will call methods onListConfigurationPolicyAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnabledProductsForImport
default ListEnabledProductsForImportResponse listEnabledProductsForImport(ListEnabledProductsForImportRequest listEnabledProductsForImportRequest) throws InternalException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
- Parameters:
listEnabledProductsForImportRequest
-- Returns:
- Result of the ListEnabledProductsForImport operation returned by the service.
- See Also:
-
listEnabledProductsForImport
default ListEnabledProductsForImportResponse listEnabledProductsForImport(Consumer<ListEnabledProductsForImportRequest.Builder> listEnabledProductsForImportRequest) throws InternalException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaListEnabledProductsForImportRequest.builder()
- Parameters:
listEnabledProductsForImportRequest
- AConsumer
that will call methods onListEnabledProductsForImportRequest.Builder
to create a request.- Returns:
- Result of the ListEnabledProductsForImport operation returned by the service.
- See Also:
-
listEnabledProductsForImport
default ListEnabledProductsForImportResponse listEnabledProductsForImport() throws InternalException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubExceptionLists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
- Returns:
- Result of the ListEnabledProductsForImport operation returned by the service.
- See Also:
-
listEnabledProductsForImportPaginator
default ListEnabledProductsForImportIterable listEnabledProductsForImportPaginator() throws InternalException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubExceptionThis is a variant of
listEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportIterable responses = client.listEnabledProductsForImportPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportIterable responses = client .listEnabledProductsForImportPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportIterable responses = client.listEnabledProductsForImportPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnabledProductsForImportPaginator
default ListEnabledProductsForImportIterable listEnabledProductsForImportPaginator(ListEnabledProductsForImportRequest listEnabledProductsForImportRequest) throws InternalException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportIterable responses = client.listEnabledProductsForImportPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportIterable responses = client .listEnabledProductsForImportPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportIterable responses = client.listEnabledProductsForImportPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnabledProductsForImportPaginator
default ListEnabledProductsForImportIterable listEnabledProductsForImportPaginator(Consumer<ListEnabledProductsForImportRequest.Builder> listEnabledProductsForImportRequest) throws InternalException, LimitExceededException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listEnabledProductsForImport(software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportIterable responses = client.listEnabledProductsForImportPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportIterable responses = client .listEnabledProductsForImportPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListEnabledProductsForImportResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListEnabledProductsForImportIterable responses = client.listEnabledProductsForImportPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaListEnabledProductsForImportRequest.builder()
- Parameters:
listEnabledProductsForImportRequest
- AConsumer
that will call methods onListEnabledProductsForImportRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFindingAggregators
default ListFindingAggregatorsResponse listFindingAggregators(ListFindingAggregatorsRequest listFindingAggregatorsRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException If finding aggregation is enabled, then
ListFindingAggregators
returns the ARN of the finding aggregator. You can run this operation from any Region.- Parameters:
listFindingAggregatorsRequest
-- Returns:
- Result of the ListFindingAggregators operation returned by the service.
- See Also:
-
listFindingAggregators
default ListFindingAggregatorsResponse listFindingAggregators(Consumer<ListFindingAggregatorsRequest.Builder> listFindingAggregatorsRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException If finding aggregation is enabled, then
ListFindingAggregators
returns 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.Builder
avoiding the need to create one manually viaListFindingAggregatorsRequest.builder()
- Parameters:
listFindingAggregatorsRequest
- AConsumer
that will call methods onListFindingAggregatorsRequest.Builder
to create a request.- Returns:
- Result of the ListFindingAggregators operation returned by the service.
- See Also:
-
listFindingAggregatorsPaginator
default ListFindingAggregatorsIterable listFindingAggregatorsPaginator(ListFindingAggregatorsRequest listFindingAggregatorsRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listFindingAggregators(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsIterable responses = client.listFindingAggregatorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsIterable responses = client .listFindingAggregatorsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsIterable responses = client.listFindingAggregatorsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listFindingAggregatorsPaginator
default ListFindingAggregatorsIterable listFindingAggregatorsPaginator(Consumer<ListFindingAggregatorsRequest.Builder> listFindingAggregatorsRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listFindingAggregators(software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsIterable responses = client.listFindingAggregatorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsIterable responses = client .listFindingAggregatorsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListFindingAggregatorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListFindingAggregatorsIterable responses = client.listFindingAggregatorsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaListFindingAggregatorsRequest.builder()
- Parameters:
listFindingAggregatorsRequest
- AConsumer
that will call methods onListFindingAggregatorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listInvitations
default ListInvitationsResponse listInvitations(ListInvitationsRequest listInvitationsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the ListInvitations operation returned by the service.
- See Also:
-
listInvitations
default ListInvitationsResponse listInvitations(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaListInvitationsRequest.builder()
- Parameters:
listInvitationsRequest
- AConsumer
that will call methods onListInvitationsRequest.Builder
to create a request.- Returns:
- Result of the ListInvitations operation returned by the service.
- See Also:
-
listInvitations
default ListInvitationsResponse listInvitations() throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubExceptionLists 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:
- Result of the ListInvitations operation returned by the service.
- See Also:
-
listInvitationsPaginator
default ListInvitationsIterable listInvitationsPaginator() throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubExceptionThis is a variant of
listInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListInvitationsIterable responses = client .listInvitationsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListInvitationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listInvitationsPaginator
default ListInvitationsIterable listInvitationsPaginator(ListInvitationsRequest listInvitationsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListInvitationsIterable responses = client .listInvitationsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListInvitationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listInvitationsPaginator
default ListInvitationsIterable listInvitationsPaginator(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listInvitations(software.amazon.awssdk.services.securityhub.model.ListInvitationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListInvitationsIterable responses = client .listInvitationsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListInvitationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaListInvitationsRequest.builder()
- Parameters:
listInvitationsRequest
- AConsumer
that will call methods onListInvitationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMembers
default ListMembersResponse listMembers(ListMembersRequest listMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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:
- Result of the ListMembers operation returned by the service.
- See Also:
-
listMembers
default ListMembersResponse listMembers(Consumer<ListMembersRequest.Builder> listMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaListMembersRequest.builder()
- Parameters:
listMembersRequest
- AConsumer
that will call methods onListMembersRequest.Builder
to create a request.- Returns:
- Result of the ListMembers operation returned by the service.
- See Also:
-
listMembers
default ListMembersResponse listMembers() throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubExceptionLists 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:
- Result of the ListMembers operation returned by the service.
- See Also:
-
listMembersPaginator
default ListMembersIterable listMembersPaginator() throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubExceptionThis is a variant of
listMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListMembersIterable responses = client.listMembersPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListMembersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listMembersPaginator
default ListMembersIterable listMembersPaginator(ListMembersRequest listMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListMembersIterable responses = client.listMembersPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListMembersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listMembersPaginator
default ListMembersIterable listMembersPaginator(Consumer<ListMembersRequest.Builder> listMembersRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listMembers(software.amazon.awssdk.services.securityhub.model.ListMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListMembersIterable responses = client.listMembersPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListMembersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaListMembersRequest.builder()
- Parameters:
listMembersRequest
- AConsumer
that will call methods onListMembersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listOrganizationAdminAccounts
default ListOrganizationAdminAccountsResponse listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Lists the Security Hub administrator accounts. Can only be called by the organization management account.
- Parameters:
listOrganizationAdminAccountsRequest
-- Returns:
- Result of the ListOrganizationAdminAccounts operation returned by the service.
- See Also:
-
listOrganizationAdminAccounts
default ListOrganizationAdminAccountsResponse listOrganizationAdminAccounts(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaListOrganizationAdminAccountsRequest.builder()
- Parameters:
listOrganizationAdminAccountsRequest
- AConsumer
that will call methods onListOrganizationAdminAccountsRequest.Builder
to create a request.- Returns:
- Result of the ListOrganizationAdminAccounts operation returned by the service.
- See Also:
-
listOrganizationAdminAccountsPaginator
default ListOrganizationAdminAccountsIterable listOrganizationAdminAccountsPaginator(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listOrganizationAdminAccounts(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsIterable responses = client.listOrganizationAdminAccountsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsIterable responses = client .listOrganizationAdminAccountsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsIterable responses = client.listOrganizationAdminAccountsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listOrganizationAdminAccountsPaginator
default ListOrganizationAdminAccountsIterable listOrganizationAdminAccountsPaginator(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listOrganizationAdminAccounts(software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsIterable responses = client.listOrganizationAdminAccountsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsIterable responses = client .listOrganizationAdminAccountsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListOrganizationAdminAccountsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListOrganizationAdminAccountsIterable responses = client.listOrganizationAdminAccountsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaListOrganizationAdminAccountsRequest.builder()
- Parameters:
listOrganizationAdminAccountsRequest
- AConsumer
that will call methods onListOrganizationAdminAccountsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSecurityControlDefinitions
default ListSecurityControlDefinitionsResponse listSecurityControlDefinitions(ListSecurityControlDefinitionsRequest listSecurityControlDefinitionsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Lists all of the security controls that apply to a specified standard.
- Parameters:
listSecurityControlDefinitionsRequest
-- Returns:
- Result of the ListSecurityControlDefinitions operation returned by the service.
- See Also:
-
listSecurityControlDefinitions
default ListSecurityControlDefinitionsResponse listSecurityControlDefinitions(Consumer<ListSecurityControlDefinitionsRequest.Builder> listSecurityControlDefinitionsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException Lists all of the security controls that apply to a specified standard.
This is a convenience which creates an instance of the
ListSecurityControlDefinitionsRequest.Builder
avoiding the need to create one manually viaListSecurityControlDefinitionsRequest.builder()
- Parameters:
listSecurityControlDefinitionsRequest
- AConsumer
that will call methods onListSecurityControlDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListSecurityControlDefinitions operation returned by the service.
- See Also:
-
listSecurityControlDefinitionsPaginator
default ListSecurityControlDefinitionsIterable listSecurityControlDefinitionsPaginator(ListSecurityControlDefinitionsRequest listSecurityControlDefinitionsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listSecurityControlDefinitions(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsIterable responses = client.listSecurityControlDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsIterable responses = client .listSecurityControlDefinitionsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsIterable responses = client.listSecurityControlDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listSecurityControlDefinitionsPaginator
default ListSecurityControlDefinitionsIterable listSecurityControlDefinitionsPaginator(Consumer<ListSecurityControlDefinitionsRequest.Builder> listSecurityControlDefinitionsRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listSecurityControlDefinitions(software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsIterable responses = client.listSecurityControlDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsIterable responses = client .listSecurityControlDefinitionsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListSecurityControlDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListSecurityControlDefinitionsIterable responses = client.listSecurityControlDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaListSecurityControlDefinitionsRequest.builder()
- Parameters:
listSecurityControlDefinitionsRequest
- AConsumer
that will call methods onListSecurityControlDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStandardsControlAssociations
default ListStandardsControlAssociationsResponse listStandardsControlAssociations(ListStandardsControlAssociationsRequest listStandardsControlAssociationsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
- Parameters:
listStandardsControlAssociationsRequest
-- Returns:
- Result of the ListStandardsControlAssociations operation returned by the service.
- See Also:
-
listStandardsControlAssociations
default ListStandardsControlAssociationsResponse listStandardsControlAssociations(Consumer<ListStandardsControlAssociationsRequest.Builder> listStandardsControlAssociationsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException 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.Builder
avoiding the need to create one manually viaListStandardsControlAssociationsRequest.builder()
- Parameters:
listStandardsControlAssociationsRequest
- AConsumer
that will call methods onListStandardsControlAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListStandardsControlAssociations operation returned by the service.
- See Also:
-
listStandardsControlAssociationsPaginator
default ListStandardsControlAssociationsIterable listStandardsControlAssociationsPaginator(ListStandardsControlAssociationsRequest listStandardsControlAssociationsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listStandardsControlAssociations(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsIterable responses = client.listStandardsControlAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsIterable responses = client .listStandardsControlAssociationsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsIterable responses = client.listStandardsControlAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listStandardsControlAssociationsPaginator
default ListStandardsControlAssociationsIterable listStandardsControlAssociationsPaginator(Consumer<ListStandardsControlAssociationsRequest.Builder> listStandardsControlAssociationsRequest) throws InternalException, LimitExceededException, InvalidAccessException, InvalidInputException, AwsServiceException, SdkClientException, SecurityHubException This is a variant of
listStandardsControlAssociations(software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsIterable responses = client.listStandardsControlAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsIterable responses = client .listStandardsControlAssociationsPaginator(request); for (software.amazon.awssdk.services.securityhub.model.ListStandardsControlAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.securityhub.paginators.ListStandardsControlAssociationsIterable responses = client.listStandardsControlAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually viaListStandardsControlAssociationsRequest.builder()
- Parameters:
listStandardsControlAssociationsRequest
- AConsumer
that will call methods onListStandardsControlAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Returns a list of tags associated with a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Returns a list of tags associated with a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startConfigurationPolicyAssociation
default StartConfigurationPolicyAssociationResponse startConfigurationPolicyAssociation(StartConfigurationPolicyAssociationRequest startConfigurationPolicyAssociationRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Associates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- Parameters:
startConfigurationPolicyAssociationRequest
-- Returns:
- Result of the StartConfigurationPolicyAssociation operation returned by the service.
- See Also:
-
startConfigurationPolicyAssociation
default StartConfigurationPolicyAssociationResponse startConfigurationPolicyAssociation(Consumer<StartConfigurationPolicyAssociationRequest.Builder> startConfigurationPolicyAssociationRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Associates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
This is a convenience which creates an instance of the
StartConfigurationPolicyAssociationRequest.Builder
avoiding the need to create one manually viaStartConfigurationPolicyAssociationRequest.builder()
- Parameters:
startConfigurationPolicyAssociationRequest
- AConsumer
that will call methods onStartConfigurationPolicyAssociationRequest.Builder
to create a request.- Returns:
- Result of the StartConfigurationPolicyAssociation operation returned by the service.
- See Also:
-
startConfigurationPolicyDisassociation
default StartConfigurationPolicyDisassociationResponse startConfigurationPolicyDisassociation(StartConfigurationPolicyDisassociationRequest startConfigurationPolicyDisassociationRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Disassociates a target account, organizational unit, or the root from a specified configuration. When you disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- Parameters:
startConfigurationPolicyDisassociationRequest
-- Returns:
- Result of the StartConfigurationPolicyDisassociation operation returned by the service.
- See Also:
-
startConfigurationPolicyDisassociation
default StartConfigurationPolicyDisassociationResponse startConfigurationPolicyDisassociation(Consumer<StartConfigurationPolicyDisassociationRequest.Builder> startConfigurationPolicyDisassociationRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Disassociates a target account, organizational unit, or the root from a specified configuration. When you disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
This is a convenience which creates an instance of the
StartConfigurationPolicyDisassociationRequest.Builder
avoiding the need to create one manually viaStartConfigurationPolicyDisassociationRequest.builder()
- Parameters:
startConfigurationPolicyDisassociationRequest
- AConsumer
that will call methods onStartConfigurationPolicyDisassociationRequest.Builder
to create a request.- Returns:
- Result of the StartConfigurationPolicyDisassociation operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Adds one or more tags to a resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Adds one or more tags to a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Removes one or more tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Removes one or more tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateActionTarget
default UpdateActionTargetResponse updateActionTarget(UpdateActionTargetRequest updateActionTargetRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException Updates the name and description of a custom action target in Security Hub.
- Parameters:
updateActionTargetRequest
-- Returns:
- Result of the UpdateActionTarget operation returned by the service.
- See Also:
-
updateActionTarget
default UpdateActionTargetResponse updateActionTarget(Consumer<UpdateActionTargetRequest.Builder> updateActionTargetRequest) throws InternalException, InvalidInputException, ResourceNotFoundException, InvalidAccessException, AwsServiceException, SdkClientException, SecurityHubException Updates the name and description of a custom action target in Security Hub.
This is a convenience which creates an instance of the
UpdateActionTargetRequest.Builder
avoiding the need to create one manually viaUpdateActionTargetRequest.builder()
- Parameters:
updateActionTargetRequest
- AConsumer
that will call methods onUpdateActionTargetRequest.Builder
to create a request.- Returns:
- Result of the UpdateActionTarget operation returned by the service.
- See Also:
-
updateConfigurationPolicy
default UpdateConfigurationPolicyResponse updateConfigurationPolicy(UpdateConfigurationPolicyRequest updateConfigurationPolicyRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException Updates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- Parameters:
updateConfigurationPolicyRequest
-- Returns:
- Result of the UpdateConfigurationPolicy operation returned by the service.
- See Also:
-
updateConfigurationPolicy
default UpdateConfigurationPolicyResponse updateConfigurationPolicy(Consumer<UpdateConfigurationPolicyRequest.Builder> updateConfigurationPolicyRequest) throws InternalException, InvalidAccessException, InvalidInputException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException Updates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
This is a convenience which creates an instance of the
UpdateConfigurationPolicyRequest.Builder
avoiding the need to create one manually viaUpdateConfigurationPolicyRequest.builder()
- Parameters:
updateConfigurationPolicyRequest
- AConsumer
that will call methods onUpdateConfigurationPolicyRequest.Builder
to create a request.- Returns:
- Result of the UpdateConfigurationPolicy operation returned by the service.
- See Also:
-
updateFindingAggregator
default UpdateFindingAggregatorResponse updateFindingAggregator(UpdateFindingAggregatorRequest updateFindingAggregatorRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use
UpdateFindingAggregator
to change the aggregation Region.You must run
UpdateFindingAggregator
from the current aggregation Region.- Parameters:
updateFindingAggregatorRequest
-- Returns:
- Result of the UpdateFindingAggregator operation returned by the service.
- See Also:
-
updateFindingAggregator
default UpdateFindingAggregatorResponse updateFindingAggregator(Consumer<UpdateFindingAggregatorRequest.Builder> updateFindingAggregatorRequest) throws InternalException, LimitExceededException, InvalidAccessException, AccessDeniedException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use
UpdateFindingAggregator
to change the aggregation Region.You must run
UpdateFindingAggregator
from the current aggregation Region.
This is a convenience which creates an instance of the
UpdateFindingAggregatorRequest.Builder
avoiding the need to create one manually viaUpdateFindingAggregatorRequest.builder()
- Parameters:
updateFindingAggregatorRequest
- AConsumer
that will call methods onUpdateFindingAggregatorRequest.Builder
to create a request.- Returns:
- Result of the UpdateFindingAggregator operation returned by the service.
- See Also:
-
updateFindings
default UpdateFindingsResponse updateFindings(UpdateFindingsRequest updateFindingsRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException UpdateFindings
is deprecated. Instead ofUpdateFindings
, useBatchUpdateFindings
.Updates the
Note
andRecordState
of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.- Parameters:
updateFindingsRequest
-- Returns:
- Result of the UpdateFindings operation returned by the service.
- See Also:
-
updateFindings
default UpdateFindingsResponse updateFindings(Consumer<UpdateFindingsRequest.Builder> updateFindingsRequest) throws InternalException, InvalidInputException, LimitExceededException, InvalidAccessException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException UpdateFindings
is deprecated. Instead ofUpdateFindings
, useBatchUpdateFindings
.Updates the
Note
andRecordState
of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.
This is a convenience which creates an instance of the
UpdateFindingsRequest.Builder
avoiding the need to create one manually viaUpdateFindingsRequest.builder()
- Parameters:
updateFindingsRequest
- AConsumer
that will call methods onUpdateFindingsRequest.Builder
to create a request.- Returns:
- Result of the UpdateFindings operation returned by the service.
- See Also:
-
updateInsight
default UpdateInsightResponse updateInsight(UpdateInsightRequest updateInsightRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Updates the Security Hub insight identified by the specified insight ARN.
- Parameters:
updateInsightRequest
-- Returns:
- Result of the UpdateInsight operation returned by the service.
- See Also:
-
updateInsight
default UpdateInsightResponse updateInsight(Consumer<UpdateInsightRequest.Builder> updateInsightRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SecurityHubException Updates the Security Hub insight identified by the specified insight ARN.
This is a convenience which creates an instance of the
UpdateInsightRequest.Builder
avoiding the need to create one manually viaUpdateInsightRequest.builder()
- Parameters:
updateInsightRequest
- AConsumer
that will call methods onUpdateInsightRequest.Builder
to create a request.- Returns:
- Result of the UpdateInsight operation returned by the service.
- See Also:
-
updateOrganizationConfiguration
default UpdateOrganizationConfigurationResponse updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation.
- Parameters:
updateOrganizationConfigurationRequest
-- Returns:
- Result of the UpdateOrganizationConfiguration operation returned by the service.
- See Also:
-
updateOrganizationConfiguration
default UpdateOrganizationConfigurationResponse updateOrganizationConfiguration(Consumer<UpdateOrganizationConfigurationRequest.Builder> updateOrganizationConfigurationRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, ResourceConflictException, AwsServiceException, SdkClientException, SecurityHubException Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation.
This is a convenience which creates an instance of the
UpdateOrganizationConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateOrganizationConfigurationRequest.builder()
- Parameters:
updateOrganizationConfigurationRequest
- AConsumer
that will call methods onUpdateOrganizationConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateOrganizationConfiguration operation returned by the service.
- See Also:
-
updateSecurityControl
default UpdateSecurityControlResponse updateSecurityControl(UpdateSecurityControlRequest updateSecurityControlRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Updates the properties of a security control.
- Parameters:
updateSecurityControlRequest
-- Returns:
- Result of the UpdateSecurityControl operation returned by the service.
- See Also:
-
updateSecurityControl
default UpdateSecurityControlResponse updateSecurityControl(Consumer<UpdateSecurityControlRequest.Builder> updateSecurityControlRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Updates the properties of a security control.
This is a convenience which creates an instance of the
UpdateSecurityControlRequest.Builder
avoiding the need to create one manually viaUpdateSecurityControlRequest.builder()
- Parameters:
updateSecurityControlRequest
- AConsumer
that will call methods onUpdateSecurityControlRequest.Builder
to create a request.- Returns:
- Result of the UpdateSecurityControl operation returned by the service.
- See Also:
-
updateSecurityHubConfiguration
default UpdateSecurityHubConfigurationResponse updateSecurityHubConfiguration(UpdateSecurityHubConfigurationRequest updateSecurityHubConfigurationRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Updates configuration options for Security Hub.
- Parameters:
updateSecurityHubConfigurationRequest
-- Returns:
- Result of the UpdateSecurityHubConfiguration operation returned by the service.
- See Also:
-
updateSecurityHubConfiguration
default UpdateSecurityHubConfigurationResponse updateSecurityHubConfiguration(Consumer<UpdateSecurityHubConfigurationRequest.Builder> updateSecurityHubConfigurationRequest) throws InternalException, InvalidInputException, InvalidAccessException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Updates configuration options for Security Hub.
This is a convenience which creates an instance of the
UpdateSecurityHubConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateSecurityHubConfigurationRequest.builder()
- Parameters:
updateSecurityHubConfigurationRequest
- AConsumer
that will call methods onUpdateSecurityHubConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateSecurityHubConfiguration operation returned by the service.
- See Also:
-
updateStandardsControl
default UpdateStandardsControlResponse updateStandardsControl(UpdateStandardsControlRequest updateStandardsControlRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Used to control whether an individual security standard control is enabled or disabled.
- Parameters:
updateStandardsControlRequest
-- Returns:
- Result of the UpdateStandardsControl operation returned by the service.
- See Also:
-
updateStandardsControl
default UpdateStandardsControlResponse updateStandardsControl(Consumer<UpdateStandardsControlRequest.Builder> updateStandardsControlRequest) throws InternalException, InvalidInputException, InvalidAccessException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, SecurityHubException Used to control whether an individual security standard control is enabled or disabled.
This is a convenience which creates an instance of the
UpdateStandardsControlRequest.Builder
avoiding the need to create one manually viaUpdateStandardsControlRequest.builder()
- Parameters:
updateStandardsControlRequest
- AConsumer
that will call methods onUpdateStandardsControlRequest.Builder
to create a request.- Returns:
- Result of the UpdateStandardsControl operation returned by the service.
- See Also:
-
create
Create aSecurityHubClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSecurityHubClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-