View on GitHub
SecurityHub Structure Reference
SecurityHub
public struct SecurityHubClient object for interacting with AWS SecurityHub service.
Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the AWS Security Hub User Guide . When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to. For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of the member account with the master account is created only in the us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from. The following throttling limits apply to using Security Hub API operations. GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests per second. UpdateFindings - RateLimit of 1 request per second. BurstLimit of 5 requests per second. All other operations - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the SecurityHub client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from. When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.
Declaration
Swift
public func acceptInvitation(_ input: AcceptInvitationRequest) -> EventLoopFuture<AcceptInvitationResponse> -
Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Security Standards section of the AWS Security Hub User Guide.
Declaration
Swift
public func batchDisableStandards(_ input: BatchDisableStandardsRequest) -> EventLoopFuture<BatchDisableStandardsResponse> -
Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation. For more information, see the Security Standards section of the AWS Security Hub User Guide.
Declaration
Swift
public func batchEnableStandards(_ input: BatchEnableStandardsRequest) -> EventLoopFuture<BatchEnableStandardsResponse> -
Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb. After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow. Confidence Criticality Note RelatedFindings Severity Types UserDefinedFields VerificationState Workflow
Declaration
Swift
public func batchImportFindings(_ input: BatchImportFindingsRequest) -> EventLoopFuture<BatchImportFindingsResponse> -
Used by Security Hub customers to update information about their investigation into a finding. Requested by master accounts or member accounts. Master accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding. Master accounts can use BatchUpdateFindings to update the following finding fields and objects. Confidence Criticality Note RelatedFindings Severity Types UserDefinedFields VerificationState Workflow Member accounts can only use BatchUpdateFindings to update the Note object.
Declaration
Swift
public func batchUpdateFindings(_ input: BatchUpdateFindingsRequest) -> EventLoopFuture<BatchUpdateFindingsResponse> -
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.
Declaration
Swift
public func createActionTarget(_ input: CreateActionTargetRequest) -> EventLoopFuture<CreateActionTargetResponse> -
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.
Declaration
Swift
public func createInsight(_ input: CreateInsightRequest) -> EventLoopFuture<CreateInsightResponse> -
Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation. After you use CreateMembers to create member account associations in Security Hub, you must use the InviteMembers operation to invite the accounts to enable Security Hub and become member accounts in Security Hub. If the account owner accepts the invitation, the account becomes a member account in Security Hub. A permissions policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start to be sent to both the member and master accounts. To remove the association between the master and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
Declaration
Swift
public func createMembers(_ input: CreateMembersRequest) -> EventLoopFuture<CreateMembersResponse> -
Declines invitations to become a member account.
Declaration
Swift
public func declineInvitations(_ input: DeclineInvitationsRequest) -> EventLoopFuture<DeclineInvitationsResponse> -
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.
Declaration
Swift
public func deleteActionTarget(_ input: DeleteActionTargetRequest) -> EventLoopFuture<DeleteActionTargetResponse> -
Deletes the insight specified by the InsightArn.
Declaration
Swift
public func deleteInsight(_ input: DeleteInsightRequest) -> EventLoopFuture<DeleteInsightResponse> -
Deletes invitations received by the AWS account to become a member account.
Declaration
Swift
public func deleteInvitations(_ input: DeleteInvitationsRequest) -> EventLoopFuture<DeleteInvitationsResponse> -
Deletes the specified member accounts from Security Hub.
Declaration
Swift
public func deleteMembers(_ input: DeleteMembersRequest) -> EventLoopFuture<DeleteMembersResponse> -
Returns a list of the custom action targets in Security Hub in your account.
Declaration
Swift
public func describeActionTargets(_ input: DescribeActionTargetsRequest) -> EventLoopFuture<DescribeActionTargetsResponse> -
Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.
Declaration
Swift
public func describeHub(_ input: DescribeHubRequest) -> EventLoopFuture<DescribeHubResponse> -
Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.
Declaration
Swift
public func describeProducts(_ input: DescribeProductsRequest) -> EventLoopFuture<DescribeProductsResponse> -
Returns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description.
Declaration
Swift
public func describeStandards(_ input: DescribeStandardsRequest) -> EventLoopFuture<DescribeStandardsResponse> -
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.
Declaration
Swift
public func describeStandardsControls(_ input: DescribeStandardsControlsRequest) -> EventLoopFuture<DescribeStandardsControlsResponse> -
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.
Declaration
Swift
public func disableImportFindingsForProduct(_ input: DisableImportFindingsForProductRequest) -> EventLoopFuture<DisableImportFindingsForProductResponse> -
Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. When you disable Security Hub for a master account, it doesn’t disable Security Hub for any associated member accounts. When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.
Declaration
Swift
public func disableSecurityHub(_ input: DisableSecurityHubRequest) -> EventLoopFuture<DisableSecurityHubResponse> -
Disassociates the current Security Hub member account from the associated master account.
Declaration
Swift
public func disassociateFromMasterAccount(_ input: DisassociateFromMasterAccountRequest) -> EventLoopFuture<DisassociateFromMasterAccountResponse> -
Disassociates the specified member accounts from the associated master account.
Declaration
Swift
public func disassociateMembers(_ input: DisassociateMembersRequest) -> EventLoopFuture<DisassociateMembersResponse> -
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.
Declaration
Swift
public func enableImportFindingsForProduct(_ input: EnableImportFindingsForProductRequest) -> EventLoopFuture<EnableImportFindingsForProductResponse> -
Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub. When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards. CIS AWS Foundations AWS Foundational Security Best Practices You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. To not enable the automatically enabled standards, set EnableDefaultStandards to false. After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation. To learn more, see Setting Up AWS Security Hub in the AWS Security Hub User Guide.
Declaration
Swift
public func enableSecurityHub(_ input: EnableSecurityHubRequest) -> EventLoopFuture<EnableSecurityHubResponse> -
Returns a list of the standards that are currently enabled.
Declaration
Swift
public func getEnabledStandards(_ input: GetEnabledStandardsRequest) -> EventLoopFuture<GetEnabledStandardsResponse> -
Returns a list of findings that match the specified criteria.
Declaration
Swift
public func getFindings(_ input: GetFindingsRequest) -> EventLoopFuture<GetFindingsResponse> -
Lists the results of the Security Hub insight specified by the insight ARN.
Declaration
Swift
public func getInsightResults(_ input: GetInsightResultsRequest) -> EventLoopFuture<GetInsightResultsResponse> -
Lists and describes insights for the specified insight ARNs.
Declaration
Swift
public func getInsights(_ input: GetInsightsRequest) -> EventLoopFuture<GetInsightsResponse> -
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
Declaration
Swift
public func getInvitationsCount(_ input: GetInvitationsCountRequest) -> EventLoopFuture<GetInvitationsCountResponse> -
Provides the details for the Security Hub master account for the current member account.
Declaration
Swift
public func getMasterAccount(_ input: GetMasterAccountRequest) -> EventLoopFuture<GetMasterAccountResponse> -
Returns the details for the Security Hub member accounts for the specified account IDs.
Declaration
Swift
public func getMembers(_ input: GetMembersRequest) -> EventLoopFuture<GetMembersResponse> -
Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from. Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub. When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from the member account.
Declaration
Swift
public func inviteMembers(_ input: InviteMembersRequest) -> EventLoopFuture<InviteMembersResponse> -
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
Declaration
Swift
public func listEnabledProductsForImport(_ input: ListEnabledProductsForImportRequest) -> EventLoopFuture<ListEnabledProductsForImportResponse> -
Lists all Security Hub membership invitations that were sent to the current AWS account.
Declaration
Swift
public func listInvitations(_ input: ListInvitationsRequest) -> EventLoopFuture<ListInvitationsResponse> -
Lists details about all member accounts for the current Security Hub master account.
Declaration
Swift
public func listMembers(_ input: ListMembersRequest) -> EventLoopFuture<ListMembersResponse> -
Returns a list of tags associated with a resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Adds one or more tags to a resource.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse> -
Removes one or more tags from a resource.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse> -
Updates the name and description of a custom action target in Security Hub.
Declaration
Swift
public func updateActionTarget(_ input: UpdateActionTargetRequest) -> EventLoopFuture<UpdateActionTargetResponse> -
UpdateFindings is deprecated. Instead of UpdateFindings, use BatchUpdateFindings. Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.
Declaration
Swift
public func updateFindings(_ input: UpdateFindingsRequest) -> EventLoopFuture<UpdateFindingsResponse> -
Updates the Security Hub insight identified by the specified insight ARN.
Declaration
Swift
public func updateInsight(_ input: UpdateInsightRequest) -> EventLoopFuture<UpdateInsightResponse> -
Updates configuration options for Security Hub.
Declaration
Swift
public func updateSecurityHubConfiguration(_ input: UpdateSecurityHubConfigurationRequest) -> EventLoopFuture<UpdateSecurityHubConfigurationResponse> -
Used to control whether an individual security standard control is enabled or disabled.
Declaration
Swift
public func updateStandardsControl(_ input: UpdateStandardsControlRequest) -> EventLoopFuture<UpdateStandardsControlResponse>
-
Returns a list of the custom action targets in Security Hub in your account.
Declaration
Swift
public func describeActionTargetsPaginator(_ input: DescribeActionTargetsRequest, onPage: @escaping (DescribeActionTargetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.
Declaration
Swift
public func describeProductsPaginator(_ input: DescribeProductsRequest, onPage: @escaping (DescribeProductsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Returns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description.
Declaration
Swift
public func describeStandardsPaginator(_ input: DescribeStandardsRequest, onPage: @escaping (DescribeStandardsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
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.
Declaration
Swift
public func describeStandardsControlsPaginator(_ input: DescribeStandardsControlsRequest, onPage: @escaping (DescribeStandardsControlsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Returns a list of the standards that are currently enabled.
Declaration
Swift
public func getEnabledStandardsPaginator(_ input: GetEnabledStandardsRequest, onPage: @escaping (GetEnabledStandardsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Returns a list of findings that match the specified criteria.
Declaration
Swift
public func getFindingsPaginator(_ input: GetFindingsRequest, onPage: @escaping (GetFindingsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists and describes insights for the specified insight ARNs.
Declaration
Swift
public func getInsightsPaginator(_ input: GetInsightsRequest, onPage: @escaping (GetInsightsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
Declaration
Swift
public func listEnabledProductsForImportPaginator(_ input: ListEnabledProductsForImportRequest, onPage: @escaping (ListEnabledProductsForImportResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists all Security Hub membership invitations that were sent to the current AWS account.
Declaration
Swift
public func listInvitationsPaginator(_ input: ListInvitationsRequest, onPage: @escaping (ListInvitationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists details about all member accounts for the current Security Hub master account.
Declaration
Swift
public func listMembersPaginator(_ input: ListMembersRequest, onPage: @escaping (ListMembersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct DescribeActionTargetsRequest : AWSShapeextension SecurityHub.DescribeActionTargetsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct DescribeProductsRequest : AWSShapeextension SecurityHub.DescribeProductsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct DescribeStandardsRequest : AWSShapeextension SecurityHub.DescribeStandardsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct DescribeStandardsControlsRequest : AWSShapeextension SecurityHub.DescribeStandardsControlsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct GetEnabledStandardsRequest : AWSShapeextension SecurityHub.GetEnabledStandardsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct GetFindingsRequest : AWSShapeextension SecurityHub.GetFindingsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct GetInsightsRequest : AWSShapeextension SecurityHub.GetInsightsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListEnabledProductsForImportRequest : AWSShapeextension SecurityHub.ListEnabledProductsForImportRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListInvitationsRequest : AWSShapeextension SecurityHub.ListInvitationsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListMembersRequest : AWSShapeextension SecurityHub.ListMembersRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AwsIamAccessKeyStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ComplianceStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ControlStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DateRangeUnit : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum IntegrationType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum MalwareState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum MalwareType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum MapFilterComparison : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum NetworkDirection : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum Partition : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RecordState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum SeverityLabel : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum SeverityRating : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum SortOrder : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum StandardsStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum StringFilterComparison : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ThreatIntelIndicatorCategory : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ThreatIntelIndicatorType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum VerificationState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum WorkflowState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum WorkflowStatus : String, CustomStringConvertible, Codable