SecurityHub

import { SecurityHub } from "https://aws-api.deno.dev/v0.2/services/securityhub.ts?docs=full";

class SecurityHub {

constructor(apiFactory: client.ApiFactory);

async acceptAdministratorInvitation(params: AcceptAdministratorInvitationRequest, opts?: client.RequestOptions): Promise<void>;

async acceptInvitation(params: AcceptInvitationRequest, opts?: client.RequestOptions): Promise<void>;

async batchDisableStandards(params: BatchDisableStandardsRequest, opts?: client.RequestOptions): Promise<BatchDisableStandardsResponse>;

async batchEnableStandards(params: BatchEnableStandardsRequest, opts?: client.RequestOptions): Promise<BatchEnableStandardsResponse>;

async batchImportFindings(params: BatchImportFindingsRequest, opts?: client.RequestOptions): Promise<BatchImportFindingsResponse>;

async batchUpdateFindings(params: BatchUpdateFindingsRequest, opts?: client.RequestOptions): Promise<BatchUpdateFindingsResponse>;

async createActionTarget(params: CreateActionTargetRequest, opts?: client.RequestOptions): Promise<CreateActionTargetResponse>;

async createInsight(params: CreateInsightRequest, opts?: client.RequestOptions): Promise<CreateInsightResponse>;

async createMembers(params: CreateMembersRequest, opts?: client.RequestOptions): Promise<CreateMembersResponse>;

async declineInvitations(params: DeclineInvitationsRequest, opts?: client.RequestOptions): Promise<DeclineInvitationsResponse>;

async deleteActionTarget(params: DeleteActionTargetRequest, opts?: client.RequestOptions): Promise<DeleteActionTargetResponse>;

async deleteInsight(params: DeleteInsightRequest, opts?: client.RequestOptions): Promise<DeleteInsightResponse>;

async deleteInvitations(params: DeleteInvitationsRequest, opts?: client.RequestOptions): Promise<DeleteInvitationsResponse>;

async deleteMembers(params: DeleteMembersRequest, opts?: client.RequestOptions): Promise<DeleteMembersResponse>;

async describeActionTargets(params?: DescribeActionTargetsRequest, opts?: client.RequestOptions): Promise<DescribeActionTargetsResponse>;

async describeHub(params?: DescribeHubRequest, opts?: client.RequestOptions): Promise<DescribeHubResponse>;

async describeOrganizationConfiguration(opts?: client.RequestOptions): Promise<DescribeOrganizationConfigurationResponse>;

async describeProducts(params?: DescribeProductsRequest, opts?: client.RequestOptions): Promise<DescribeProductsResponse>;

async describeStandards(params?: DescribeStandardsRequest, opts?: client.RequestOptions): Promise<DescribeStandardsResponse>;

async describeStandardsControls(params: DescribeStandardsControlsRequest, opts?: client.RequestOptions): Promise<DescribeStandardsControlsResponse>;

async disableImportFindingsForProduct(params: DisableImportFindingsForProductRequest, opts?: client.RequestOptions): Promise<void>;

async disableOrganizationAdminAccount(params: DisableOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>;

async disableSecurityHub(opts?: client.RequestOptions): Promise<void>;

async disassociateFromAdministratorAccount(opts?: client.RequestOptions): Promise<void>;

async disassociateFromMasterAccount(opts?: client.RequestOptions): Promise<void>;

async disassociateMembers(params: DisassociateMembersRequest, opts?: client.RequestOptions): Promise<void>;

async enableImportFindingsForProduct(params: EnableImportFindingsForProductRequest, opts?: client.RequestOptions): Promise<EnableImportFindingsForProductResponse>;

async enableOrganizationAdminAccount(params: EnableOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>;

async enableSecurityHub(params?: EnableSecurityHubRequest, opts?: client.RequestOptions): Promise<void>;

async getAdministratorAccount(opts?: client.RequestOptions): Promise<GetAdministratorAccountResponse>;

async getEnabledStandards(params?: GetEnabledStandardsRequest, opts?: client.RequestOptions): Promise<GetEnabledStandardsResponse>;

async getFindings(params?: GetFindingsRequest, opts?: client.RequestOptions): Promise<GetFindingsResponse>;

async getInsightResults(params: GetInsightResultsRequest, opts?: client.RequestOptions): Promise<GetInsightResultsResponse>;

async getInsights(params?: GetInsightsRequest, opts?: client.RequestOptions): Promise<GetInsightsResponse>;

async getInvitationsCount(opts?: client.RequestOptions): Promise<GetInvitationsCountResponse>;

async getMasterAccount(opts?: client.RequestOptions): Promise<GetMasterAccountResponse>;

async getMembers(params: GetMembersRequest, opts?: client.RequestOptions): Promise<GetMembersResponse>;

async inviteMembers(params: InviteMembersRequest, opts?: client.RequestOptions): Promise<InviteMembersResponse>;

async listEnabledProductsForImport(params?: ListEnabledProductsForImportRequest, opts?: client.RequestOptions): Promise<ListEnabledProductsForImportResponse>;

async listInvitations(params?: ListInvitationsRequest, opts?: client.RequestOptions): Promise<ListInvitationsResponse>;

async listMembers(params?: ListMembersRequest, opts?: client.RequestOptions): Promise<ListMembersResponse>;

async listOrganizationAdminAccounts(params?: ListOrganizationAdminAccountsRequest, opts?: client.RequestOptions): Promise<ListOrganizationAdminAccountsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateActionTarget(params: UpdateActionTargetRequest, opts?: client.RequestOptions): Promise<void>;

async updateFindings(params: UpdateFindingsRequest, opts?: client.RequestOptions): Promise<void>;

async updateInsight(params: UpdateInsightRequest, opts?: client.RequestOptions): Promise<void>;

async updateOrganizationConfiguration(params: UpdateOrganizationConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async updateSecurityHubConfiguration(params?: UpdateSecurityHubConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async updateStandardsControl(params: UpdateStandardsControlRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new SecurityHub(apiFactory: client.ApiFactory)

[src]

§Methods

acceptAdministratorInvitation(params: AcceptAdministratorInvitationRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

acceptInvitation(params: AcceptInvitationRequest, opts?: client.RequestOptions): Promise<void>

[src]

This method is deprecated. Instead, use AcceptAdministratorInvitation.

The Security Hub console continues to use AcceptInvitation. It will eventually change to use AcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to use AcceptInvitation. You should also add AcceptAdministratorInvitation to your policies to ensure that the correct permissions are in place after the console begins to use AcceptAdministratorInvitation.

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.

batchDisableStandards(params: BatchDisableStandardsRequest, opts?: client.RequestOptions): Promise<BatchDisableStandardsResponse>

[src]

Disables the standards specified by the provided StandardsSubscriptionArns.

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

batchEnableStandards(params: BatchEnableStandardsRequest, opts?: client.RequestOptions): Promise<BatchEnableStandardsResponse>

[src]

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 Security Hub User Guide.

batchImportFindings(params: BatchImportFindingsRequest, opts?: client.RequestOptions): Promise<BatchImportFindingsResponse>

[src]

Imports security findings generated from an integrated product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.

```
Note
```
```
UserDefinedFields
```
```
VerificationState
```
```
Workflow
```

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.

batchUpdateFindings(params: BatchUpdateFindingsRequest, opts?: client.RequestOptions): Promise<BatchUpdateFindingsResponse>

[src]

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 of UpdatedAt 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.

createActionTarget(params: CreateActionTargetRequest, opts?: client.RequestOptions): Promise<CreateActionTargetResponse>

[src]

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.

createInsight(params: CreateInsightRequest, opts?: client.RequestOptions): Promise<CreateInsightResponse>

[src]

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.

createMembers(params: CreateMembersRequest, opts?: client.RequestOptions): Promise<CreateMembersResponse>

[src]

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, and Security Hub is automatically enabled for those accounts. 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.

A permissions policy is added that permits the administrator account to view the findings generated in the member account. When Security Hub is enabled in a member account, the member account findings are also visible to the administrator account.

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

declineInvitations(params: DeclineInvitationsRequest, opts?: client.RequestOptions): Promise<DeclineInvitationsResponse>

[src]

Declines invitations to become a member account.

This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.

deleteActionTarget(params: DeleteActionTargetRequest, opts?: client.RequestOptions): Promise<DeleteActionTargetResponse>

[src]

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.

deleteInsight(params: DeleteInsightRequest, opts?: client.RequestOptions): Promise<DeleteInsightResponse>

[src]

Deletes the insight specified by the InsightArn.

deleteInvitations(params: DeleteInvitationsRequest, opts?: client.RequestOptions): Promise<DeleteInvitationsResponse>

[src]

Deletes invitations received by the Amazon Web Services account to become a member account.

This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.

deleteMembers(params: DeleteMembersRequest, opts?: client.RequestOptions): Promise<DeleteMembersResponse>

[src]

Deletes the specified member accounts from Security Hub.

Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.

describeActionTargets(params?: DescribeActionTargetsRequest, opts?: client.RequestOptions): Promise<DescribeActionTargetsResponse>

[src]

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

describeHub(params?: DescribeHubRequest, opts?: client.RequestOptions): Promise<DescribeHubResponse>

[src]

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

describeOrganizationConfiguration(opts?: client.RequestOptions): Promise<DescribeOrganizationConfigurationResponse>

[src]

Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.

describeProducts(params?: DescribeProductsRequest, opts?: client.RequestOptions): Promise<DescribeProductsResponse>

[src]

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.

describeStandards(params?: DescribeStandardsRequest, opts?: client.RequestOptions): Promise<DescribeStandardsResponse>

[src]

Returns a list of the available standards in Security Hub.

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

describeStandardsControls(params: DescribeStandardsControlsRequest, opts?: client.RequestOptions): Promise<DescribeStandardsControlsResponse>

[src]

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.

disableImportFindingsForProduct(params: DisableImportFindingsForProductRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

disableOrganizationAdminAccount(params: DisableOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disables a Security Hub administrator account. Can only be called by the organization management account.

disableSecurityHub(opts?: client.RequestOptions): Promise<void>

[src]

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 an administrator 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 administrator and member account associations are removed.

If you want to save your existing findings, you must export them before you disable Security Hub.

disassociateFromAdministratorAccount(opts?: client.RequestOptions): Promise<void>

[src]

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.

disassociateFromMasterAccount(opts?: client.RequestOptions): Promise<void>

[src]

This method is deprecated. Instead, use DisassociateFromAdministratorAccount.

The Security Hub console continues to use DisassociateFromMasterAccount. It will eventually change to use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use DisassociateFromMasterAccount. You should also add DisassociateFromAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use DisassociateFromAdministratorAccount.

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.

disassociateMembers(params: DisassociateMembersRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

enableImportFindingsForProduct(params: EnableImportFindingsForProductRequest, opts?: client.RequestOptions): Promise<EnableImportFindingsForProductResponse>

[src]

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.

enableOrganizationAdminAccount(params: EnableOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>

[src]

Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.

enableSecurityHub(params?: EnableSecurityHubRequest, opts?: client.RequestOptions): Promise<void>

[src]

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 Amazon Web Services Foundations
Amazon Web Services 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 the setup information in the Security Hub User Guide.

getAdministratorAccount(opts?: client.RequestOptions): Promise<GetAdministratorAccountResponse>

[src]

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.

getEnabledStandards(params?: GetEnabledStandardsRequest, opts?: client.RequestOptions): Promise<GetEnabledStandardsResponse>

[src]

Returns a list of the standards that are currently enabled.

getFindings(params?: GetFindingsRequest, opts?: client.RequestOptions): Promise<GetFindingsResponse>

[src]

Returns a list of findings that match the specified criteria.

getInsightResults(params: GetInsightResultsRequest, opts?: client.RequestOptions): Promise<GetInsightResultsResponse>

[src]

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

getInsights(params?: GetInsightsRequest, opts?: client.RequestOptions): Promise<GetInsightsResponse>

[src]

Lists and describes insights for the specified insight ARNs.

getInvitationsCount(opts?: client.RequestOptions): Promise<GetInvitationsCountResponse>

[src]

Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.

getMasterAccount(opts?: client.RequestOptions): Promise<GetMasterAccountResponse>

[src]

This method is deprecated. Instead, use GetAdministratorAccount.

The Security Hub console continues to use GetMasterAccount. It will eventually change to use GetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use GetAdministratorAccount.

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.

getMembers(params: GetMembersRequest, opts?: client.RequestOptions): Promise<GetMembersResponse>

[src]

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.

inviteMembers(params: InviteMembersRequest, opts?: client.RequestOptions): Promise<InviteMembersResponse>

[src]

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.

listEnabledProductsForImport(params?: ListEnabledProductsForImportRequest, opts?: client.RequestOptions): Promise<ListEnabledProductsForImportResponse>

[src]

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

listInvitations(params?: ListInvitationsRequest, opts?: client.RequestOptions): Promise<ListInvitationsResponse>

[src]

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.

listMembers(params?: ListMembersRequest, opts?: client.RequestOptions): Promise<ListMembersResponse>

[src]

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.

listOrganizationAdminAccounts(params?: ListOrganizationAdminAccountsRequest, opts?: client.RequestOptions): Promise<ListOrganizationAdminAccountsResponse>

[src]

Lists the Security Hub administrator accounts. Can only be called by the organization management account.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Returns a list of tags associated with a resource.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds one or more tags to a resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes one or more tags from a resource.

updateActionTarget(params: UpdateActionTargetRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

updateFindings(params: UpdateFindingsRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

updateInsight(params: UpdateInsightRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

updateOrganizationConfiguration(params: UpdateOrganizationConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.

updateSecurityHubConfiguration(params?: UpdateSecurityHubConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates configuration options for Security Hub.

updateStandardsControl(params: UpdateStandardsControlRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]