GuardDuty

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

class GuardDuty {

constructor(apiFactory: client.ApiFactory);

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

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

async createDetector(params: CreateDetectorRequest, opts?: client.RequestOptions): Promise<CreateDetectorResponse>;

async createFilter(params: CreateFilterRequest, opts?: client.RequestOptions): Promise<CreateFilterResponse>;

async createIPSet(params: CreateIPSetRequest, opts?: client.RequestOptions): Promise<CreateIPSetResponse>;

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

async createPublishingDestination(params: CreatePublishingDestinationRequest, opts?: client.RequestOptions): Promise<CreatePublishingDestinationResponse>;

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

async createThreatIntelSet(params: CreateThreatIntelSetRequest, opts?: client.RequestOptions): Promise<CreateThreatIntelSetResponse>;

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

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

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

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

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

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

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

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

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

async describePublishingDestination(params: DescribePublishingDestinationRequest, opts?: client.RequestOptions): Promise<DescribePublishingDestinationResponse>;

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

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

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

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

async getDetector(params: GetDetectorRequest, opts?: client.RequestOptions): Promise<GetDetectorResponse>;

async getFilter(params: GetFilterRequest, opts?: client.RequestOptions): Promise<GetFilterResponse>;

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

async getFindingsStatistics(params: GetFindingsStatisticsRequest, opts?: client.RequestOptions): Promise<GetFindingsStatisticsResponse>;

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

async getIPSet(params: GetIPSetRequest, opts?: client.RequestOptions): Promise<GetIPSetResponse>;

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

async getMemberDetectors(params: GetMemberDetectorsRequest, opts?: client.RequestOptions): Promise<GetMemberDetectorsResponse>;

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

async getThreatIntelSet(params: GetThreatIntelSetRequest, opts?: client.RequestOptions): Promise<GetThreatIntelSetResponse>;

async getUsageStatistics(params: GetUsageStatisticsRequest, opts?: client.RequestOptions): Promise<GetUsageStatisticsResponse>;

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

async listDetectors(params?: ListDetectorsRequest, opts?: client.RequestOptions): Promise<ListDetectorsResponse>;

async listFilters(params: ListFiltersRequest, opts?: client.RequestOptions): Promise<ListFiltersResponse>;

async listFindings(params: ListFindingsRequest, opts?: client.RequestOptions): Promise<ListFindingsResponse>;

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

async listIPSets(params: ListIPSetsRequest, opts?: client.RequestOptions): Promise<ListIPSetsResponse>;

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

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

async listPublishingDestinations(params: ListPublishingDestinationsRequest, opts?: client.RequestOptions): Promise<ListPublishingDestinationsResponse>;

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

async listThreatIntelSets(params: ListThreatIntelSetsRequest, opts?: client.RequestOptions): Promise<ListThreatIntelSetsResponse>;

async startMonitoringMembers(params: StartMonitoringMembersRequest, opts?: client.RequestOptions): Promise<StartMonitoringMembersResponse>;

async stopMonitoringMembers(params: StopMonitoringMembersRequest, opts?: client.RequestOptions): Promise<StopMonitoringMembersResponse>;

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

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

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

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

async updateFilter(params: UpdateFilterRequest, opts?: client.RequestOptions): Promise<UpdateFilterResponse>;

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

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

async updateMemberDetectors(params: UpdateMemberDetectorsRequest, opts?: client.RequestOptions): Promise<UpdateMemberDetectorsResponse>;

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

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

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

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new GuardDuty(apiFactory: client.ApiFactory)

[src]

§Methods

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

[src]

Accepts the invitation to be monitored by a GuardDuty administrator account.

archiveFindings(params: ArchiveFindingsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Archives GuardDuty findings that are specified by the list of finding IDs.

Note: Only the administrator account can archive findings. Member accounts don't have permission to archive findings from their accounts.

createDetector(params: CreateDetectorRequest, opts?: client.RequestOptions): Promise<CreateDetectorResponse>

[src]

Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each Region where you enable the service. You can have only one detector per account per Region. All data sources are enabled in a new detector by default.

createFilter(params: CreateFilterRequest, opts?: client.RequestOptions): Promise<CreateFilterResponse>

[src]

Creates a filter using the specified finding criteria.

createIPSet(params: CreateIPSetRequest, opts?: client.RequestOptions): Promise<CreateIPSetResponse>

[src]

Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with AWS infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the administrator account can use this operation.

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

[src]

Creates member accounts of the current AWS account by specifying a list of AWS account IDs. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization.

When using Create Members as an organizations delegated administrator this action will enable GuardDuty in the added member accounts, with the exception of the organization delegated administrator account, which must enable GuardDuty prior to being added as a member.

If you are adding accounts by invitation use this action after GuardDuty has been enabled in potential member accounts and before using Invite Members.

createPublishingDestination(params: CreatePublishingDestinationRequest, opts?: client.RequestOptions): Promise<CreatePublishingDestinationResponse>

[src]

Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.

createSampleFindings(params: CreateSampleFindingsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates example findings of all supported finding types.

createThreatIntelSet(params: CreateThreatIntelSetRequest, opts?: client.RequestOptions): Promise<CreateThreatIntelSetResponse>

[src]

Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator account can use this operation.

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

[src]

Declines invitations sent to the current member account by AWS accounts specified by their account IDs.

deleteDetector(params: DeleteDetectorRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an Amazon GuardDuty detector that is specified by the detector ID.

deleteFilter(params: DeleteFilterRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the filter specified by the filter name.

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

[src]

Deletes invitations sent to the current member account by AWS accounts specified by their account IDs.

deleteIPSet(params: DeleteIPSetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface.

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

[src]

Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.

deletePublishingDestination(params: DeletePublishingDestinationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the publishing definition with the specified destinationId.

deleteThreatIntelSet(params: DeleteThreatIntelSetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.

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

[src]

Returns information about the account selected as the delegated administrator for GuardDuty.

describePublishingDestination(params: DescribePublishingDestinationRequest, opts?: client.RequestOptions): Promise<DescribePublishingDestinationResponse>

[src]

Returns information about the publishing destination specified by the provided destinationId.

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

[src]

Disables an AWS account within the Organization as the GuardDuty delegated administrator.

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

[src]

Disassociates the current GuardDuty member account from its administrator account.

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

[src]

Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.

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

[src]

Enables an AWS account within the organization as the GuardDuty delegated administrator.

getDetector(params: GetDetectorRequest, opts?: client.RequestOptions): Promise<GetDetectorResponse>

[src]

Retrieves an Amazon GuardDuty detector specified by the detectorId.

getFilter(params: GetFilterRequest, opts?: client.RequestOptions): Promise<GetFilterResponse>

[src]

Returns the details of the filter specified by the filter name.

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

[src]

Describes Amazon GuardDuty findings specified by finding IDs.

getFindingsStatistics(params: GetFindingsStatisticsRequest, opts?: client.RequestOptions): Promise<GetFindingsStatisticsResponse>

[src]

Lists Amazon GuardDuty findings statistics for the specified detector ID.

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

[src]

Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.

getIPSet(params: GetIPSetRequest, opts?: client.RequestOptions): Promise<GetIPSetResponse>

[src]

Retrieves the IPSet specified by the ipSetId.

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

[src]

Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.

getMemberDetectors(params: GetMemberDetectorsRequest, opts?: client.RequestOptions): Promise<GetMemberDetectorsResponse>

[src]

Describes which data sources are enabled for the member account's detector.

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

[src]

Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.

getThreatIntelSet(params: GetThreatIntelSetRequest, opts?: client.RequestOptions): Promise<GetThreatIntelSetResponse>

[src]

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

getUsageStatistics(params: GetUsageStatisticsRequest, opts?: client.RequestOptions): Promise<GetUsageStatisticsResponse>

[src]

Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources the cost returned will include only the usage so far under 30 days, this may differ from the cost metrics in the console, which projects usage over 30 days to provide a monthly cost estimate. For more information see Understanding How Usage Costs are Calculated.

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

[src]

Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty, and allow the current AWS account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account.

listDetectors(params?: ListDetectorsRequest, opts?: client.RequestOptions): Promise<ListDetectorsResponse>

[src]

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

listFilters(params: ListFiltersRequest, opts?: client.RequestOptions): Promise<ListFiltersResponse>

[src]

Returns a paginated list of the current filters.

listFindings(params: ListFindingsRequest, opts?: client.RequestOptions): Promise<ListFindingsResponse>

[src]

Lists Amazon GuardDuty findings for the specified detector ID.

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

[src]

Lists all GuardDuty membership invitations that were sent to the current AWS account.

listIPSets(params: ListIPSetsRequest, opts?: client.RequestOptions): Promise<ListIPSetsResponse>

[src]

Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets from the associated administrator account.

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

[src]

Lists details about all member accounts for the current GuardDuty administrator account.

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

[src]

Lists the accounts configured as GuardDuty delegated administrators.

listPublishingDestinations(params: ListPublishingDestinationsRequest, opts?: client.RequestOptions): Promise<ListPublishingDestinationsResponse>

[src]

Returns a list of publishing destinations associated with the specified dectectorId.

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

[src]

Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.

listThreatIntelSets(params: ListThreatIntelSetsRequest, opts?: client.RequestOptions): Promise<ListThreatIntelSetsResponse>

[src]

Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets associated with the administrator account are returned.

startMonitoringMembers(params: StartMonitoringMembersRequest, opts?: client.RequestOptions): Promise<StartMonitoringMembersResponse>

[src]

Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.

stopMonitoringMembers(params: StopMonitoringMembersRequest, opts?: client.RequestOptions): Promise<StopMonitoringMembersResponse>

[src]

Stops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts.

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

[src]

Adds tags to a resource.

unarchiveFindings(params: UnarchiveFindingsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Unarchives GuardDuty findings specified by the findingIds.

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

[src]

Removes tags from a resource.

updateDetector(params: UpdateDetectorRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the Amazon GuardDuty detector specified by the detectorId.

updateFilter(params: UpdateFilterRequest, opts?: client.RequestOptions): Promise<UpdateFilterResponse>

[src]

Updates the filter specified by the filter name.

updateFindingsFeedback(params: UpdateFindingsFeedbackRequest, opts?: client.RequestOptions): Promise<void>

[src]

Marks the specified GuardDuty findings as useful or not useful.

updateIPSet(params: UpdateIPSetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the IPSet specified by the IPSet ID.

updateMemberDetectors(params: UpdateMemberDetectorsRequest, opts?: client.RequestOptions): Promise<UpdateMemberDetectorsResponse>

[src]

Contains information on member accounts to be updated.

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

[src]

Updates the delegated administrator account with the values provided.

updatePublishingDestination(params: UpdatePublishingDestinationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates information about the publishing destination specified by the destinationId.

updateThreatIntelSet(params: UpdateThreatIntelSetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the ThreatIntelSet specified by the ThreatIntelSet ID.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]