5.0.0 • Published 7 years ago

@datafire/amazonaws_guardduty v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_guardduty

Client library for Amazon GuardDuty

Installation and Usage

npm install --save @datafire/amazonaws_guardduty
let amazonaws_guardduty = require('@datafire/amazonaws_guardduty').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_guardduty.ListDetectors({}).then(data => {
  console.log(data);
});

Description

Assess, monitor, manage, and remediate security issues across your AWS infrastructure, applications, and data.

Actions

ListDetectors

amazonaws_guardduty.ListDetectors({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string

Output

CreateDetector

amazonaws_guardduty.CreateDetector({}, context)

Input

Output

DeleteDetector

amazonaws_guardduty.DeleteDetector({
  "detectorId": ""
}, context)

Input

  • input object
    • detectorId required string

Output

GetDetector

amazonaws_guardduty.GetDetector({
  "detectorId": ""
}, context)

Input

  • input object
    • detectorId required string

Output

UpdateDetector

amazonaws_guardduty.UpdateDetector({
  "detectorId": ""
}, context)

Input

  • input object
    • detectorId required string
    • Enable Enable

Output

ListFindings

amazonaws_guardduty.ListFindings({
  "detectorId": ""
}, context)

Input

Output

ArchiveFindings

amazonaws_guardduty.ArchiveFindings({
  "detectorId": ""
}, context)

Input

  • input object

Output

CreateSampleFindings

amazonaws_guardduty.CreateSampleFindings({
  "detectorId": ""
}, context)

Input

  • input object

Output

UpdateFindingsFeedback

amazonaws_guardduty.UpdateFindingsFeedback({
  "detectorId": ""
}, context)

Input

Output

GetFindings

amazonaws_guardduty.GetFindings({
  "detectorId": ""
}, context)

Input

Output

GetFindingsStatistics

amazonaws_guardduty.GetFindingsStatistics({
  "detectorId": ""
}, context)

Input

Output

UnarchiveFindings

amazonaws_guardduty.UnarchiveFindings({
  "detectorId": ""
}, context)

Input

  • input object

Output

ListIPSets

amazonaws_guardduty.ListIPSets({
  "detectorId": ""
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • detectorId required string

Output

CreateIPSet

amazonaws_guardduty.CreateIPSet({
  "detectorId": ""
}, context)

Input

Output

DeleteIPSet

amazonaws_guardduty.DeleteIPSet({
  "detectorId": "",
  "ipSetId": ""
}, context)

Input

  • input object
    • detectorId required string
    • ipSetId required string

Output

GetIPSet

amazonaws_guardduty.GetIPSet({
  "detectorId": "",
  "ipSetId": ""
}, context)

Input

  • input object
    • detectorId required string
    • ipSetId required string

Output

UpdateIPSet

amazonaws_guardduty.UpdateIPSet({
  "detectorId": "",
  "ipSetId": ""
}, context)

Input

  • input object

Output

GetMasterAccount

amazonaws_guardduty.GetMasterAccount({
  "detectorId": ""
}, context)

Input

  • input object
    • detectorId required string

Output

AcceptInvitation

amazonaws_guardduty.AcceptInvitation({
  "detectorId": ""
}, context)

Input

Output

DisassociateFromMasterAccount

amazonaws_guardduty.DisassociateFromMasterAccount({
  "detectorId": ""
}, context)

Input

  • input object
    • detectorId required string

Output

ListMembers

amazonaws_guardduty.ListMembers({
  "detectorId": ""
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • detectorId required string

Output

CreateMembers

amazonaws_guardduty.CreateMembers({
  "detectorId": ""
}, context)

Input

Output

DeleteMembers

amazonaws_guardduty.DeleteMembers({
  "detectorId": ""
}, context)

Input

  • input object

Output

DisassociateMembers

amazonaws_guardduty.DisassociateMembers({
  "detectorId": ""
}, context)

Input

  • input object

Output

GetMembers

amazonaws_guardduty.GetMembers({
  "detectorId": ""
}, context)

Input

  • input object

Output

InviteMembers

amazonaws_guardduty.InviteMembers({
  "detectorId": ""
}, context)

Input

Output

StartMonitoringMembers

amazonaws_guardduty.StartMonitoringMembers({
  "detectorId": ""
}, context)

Input

  • input object

Output

StopMonitoringMembers

amazonaws_guardduty.StopMonitoringMembers({
  "detectorId": ""
}, context)

Input

  • input object

Output

ListThreatIntelSets

amazonaws_guardduty.ListThreatIntelSets({
  "detectorId": ""
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • detectorId required string

Output

CreateThreatIntelSet

amazonaws_guardduty.CreateThreatIntelSet({
  "detectorId": ""
}, context)

Input

Output

DeleteThreatIntelSet

amazonaws_guardduty.DeleteThreatIntelSet({
  "detectorId": "",
  "threatIntelSetId": ""
}, context)

Input

  • input object
    • detectorId required string
    • threatIntelSetId required string

Output

GetThreatIntelSet

amazonaws_guardduty.GetThreatIntelSet({
  "detectorId": "",
  "threatIntelSetId": ""
}, context)

Input

  • input object
    • detectorId required string
    • threatIntelSetId required string

Output

UpdateThreatIntelSet

amazonaws_guardduty.UpdateThreatIntelSet({
  "detectorId": "",
  "threatIntelSetId": ""
}, context)

Input

  • input object
    • detectorId required string
    • threatIntelSetId required string
    • Activate Activate
    • Location Location
    • Name Name

Output

ListInvitations

amazonaws_guardduty.ListInvitations({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string

Output

GetInvitationsCount

amazonaws_guardduty.GetInvitationsCount({}, context)

Input

  • input object

Output

DeclineInvitations

amazonaws_guardduty.DeclineInvitations({}, context)

Input

Output

DeleteInvitations

amazonaws_guardduty.DeleteInvitations({}, context)

Input

Output

Definitions

AcceptInvitationRequest

  • AcceptInvitationRequest object: AcceptInvitation request body.

AcceptInvitationResponse

  • AcceptInvitationResponse object

AccessKeyDetails

  • AccessKeyDetails object: The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding.

AccountDetail

  • AccountDetail object: An object containing the member's accountId and email address.

AccountDetails

  • AccountDetails array: A list of account/email pairs.

AccountId

  • AccountId string: AWS account ID.

AccountIds

  • AccountIds array: A list of account IDs.

Action

Activate

  • Activate boolean: Whether we should start processing the list immediately or not.

ArchiveFindingsRequest

  • ArchiveFindingsRequest object: ArchiveFindings request body.

ArchiveFindingsResponse

  • ArchiveFindingsResponse object

AwsApiCallAction

BadRequestException

City

  • City object: City information of the remote IP address.

Comments

  • Comments string: Additional feedback about the GuardDuty findings.

Condition

CountBySeverityFindingStatistic

  • CountBySeverityFindingStatistic integer: The count of findings for the given severity.

Country

  • Country object: Country information of the remote IP address.

CreateDetectorRequest

  • CreateDetectorRequest object: CreateDetector request body.

CreateDetectorResponse

  • CreateDetectorResponse object

CreateIPSetRequest

CreateIPSetResponse

  • CreateIPSetResponse object

CreateMembersRequest

  • CreateMembersRequest object: CreateMembers request body.

CreateMembersResponse

CreateSampleFindingsRequest

  • CreateSampleFindingsRequest object: CreateSampleFindings request body.

CreateSampleFindingsResponse

  • CreateSampleFindingsResponse object

CreateThreatIntelSetRequest

CreateThreatIntelSetResponse

CreatedAt

  • CreatedAt string: The first time a resource was created. The format will be ISO-8601.

DeclineInvitationsRequest

  • DeclineInvitationsRequest object: DeclineInvitations request body.

DeclineInvitationsResponse

DeleteDetectorRequest

  • DeleteDetectorRequest object

DeleteDetectorResponse

  • DeleteDetectorResponse object

DeleteIPSetRequest

  • DeleteIPSetRequest object

DeleteIPSetResponse

  • DeleteIPSetResponse object

DeleteInvitationsRequest

  • DeleteInvitationsRequest object: DeleteInvitations request body.

DeleteInvitationsResponse

DeleteMembersRequest

  • DeleteMembersRequest object: DeleteMembers request body.

DeleteMembersResponse

DeleteThreatIntelSetRequest

  • DeleteThreatIntelSetRequest object

DeleteThreatIntelSetResponse

  • DeleteThreatIntelSetResponse object

DetectorId

  • DetectorId string: The unique identifier for a detector.

DetectorIds

  • DetectorIds array: A list of detector Ids.

DetectorStatus

  • DetectorStatus string (values: ENABLED, DISABLED): The status of detector.

DisassociateFromMasterAccountRequest

  • DisassociateFromMasterAccountRequest object

DisassociateFromMasterAccountResponse

  • DisassociateFromMasterAccountResponse object

DisassociateMembersRequest

  • DisassociateMembersRequest object: DisassociateMembers request body.

DisassociateMembersResponse

DnsRequestAction

  • DnsRequestAction object: Information about the DNS_REQUEST action described in this finding.

Domain

  • Domain string: A domain name.

DomainDetails

  • DomainDetails object: Domain information for the AWS API call.

Email

  • Email string: Member account's email address.

Enable

  • Enable boolean: A boolean value that specifies whether the detector is to be enabled.

Eq

  • Eq array: Represents the equal condition to be applied to a single field when querying for findings.

ErrorResponse

Feedback

  • Feedback string (values: USEFUL, NOT_USEFUL): Finding Feedback Value

Finding

FindingCriteria

  • FindingCriteria object: Represents the criteria used for querying findings.

FindingId

  • FindingId string: The unique identifier for the Finding

FindingIds

  • FindingIds array: The list of the Findings.

FindingStatisticType

  • FindingStatisticType string (values: COUNT_BY_SEVERITY): The types of finding statistics.

FindingStatisticTypes

FindingStatistics

FindingType

  • FindingType string: The finding type for the finding

FindingTypes

  • FindingTypes array: The list of the finding types.

Findings

  • Findings array: A list of findings.

GeoLocation

  • GeoLocation object: Location information of the remote IP address.

GetDetectorRequest

  • GetDetectorRequest object

GetDetectorResponse

GetFindingsRequest

GetFindingsResponse

  • GetFindingsResponse object

GetFindingsStatisticsRequest

GetFindingsStatisticsResponse

GetIPSetRequest

  • GetIPSetRequest object

GetIPSetResponse

GetInvitationsCountRequest

  • GetInvitationsCountRequest object

GetInvitationsCountResponse

  • GetInvitationsCountResponse object

GetMasterAccountRequest

  • GetMasterAccountRequest object

GetMasterAccountResponse

  • GetMasterAccountResponse object

GetMembersRequest

  • GetMembersRequest object: GetMembers request body.

GetMembersResponse

GetThreatIntelSetRequest

  • GetThreatIntelSetRequest object

GetThreatIntelSetResponse

IamInstanceProfile

  • IamInstanceProfile object: The profile information of the EC2 instance.

InstanceDetails

InternalServerErrorException

  • InternalServerErrorException object: Error response object.

Invitation

InvitationId

  • InvitationId string: This value is used to validate the master account to the member account.

Invitations

  • Invitations array: A list of invitation descriptions.

InviteMembersRequest

  • InviteMembersRequest object: InviteMembers request body.

InviteMembersResponse

InvitedAt

  • InvitedAt string: Timestamp at which a member has been invited. The format will be ISO-8601.

IpSetFormat

  • IpSetFormat string (values: TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE): The format of the ipSet.

IpSetId

  • IpSetId string: The unique identifier for an IP Set

IpSetIds

  • IpSetIds array: A list of the IP set IDs

IpSetStatus

  • IpSetStatus string (values: INACTIVE, ACTIVATING, ACTIVE, DEACTIVATING, ERROR, DELETE_PENDING, DELETED): The status of ipSet file uploaded.

Ipv6Address

  • Ipv6Address string: IpV6 address of the EC2 instance.

Ipv6Addresses

  • Ipv6Addresses array: A list of EC2 instance IPv6 address information.

ListDetectorsRequest

  • ListDetectorsRequest object

ListDetectorsResponse

ListFindingsRequest

ListFindingsResponse

ListIPSetsRequest

  • ListIPSetsRequest object

ListIPSetsResponse

ListInvitationsRequest

  • ListInvitationsRequest object

ListInvitationsResponse

ListMembersRequest

  • ListMembersRequest object

ListMembersResponse

ListOfPortProbeDetail

ListThreatIntelSetsRequest

  • ListThreatIntelSetsRequest object

ListThreatIntelSetsResponse

LocalPortDetails

  • LocalPortDetails object: Local port information of the connection.

Location

MapOfCondition

MapOfCountBySeverityFindingStatistic

Master

MasterId

  • MasterId string: The master account ID.

MaxResults

  • MaxResults integer

Member

Members

  • Members array: A list of member descriptions.

Message

  • Message string: The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

Name

  • Name string: The user-friendly name to identify the list.

Neq

  • Neq array: Represents the not equal condition to be applied to a single field when querying for findings.

NetworkConnectionAction

NetworkInterface

NetworkInterfaces

  • NetworkInterfaces array: The network interface information of the EC2 instance.

NextToken

  • NextToken string: You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

OrderBy

  • OrderBy string (values: ASC, DESC)

Organization

PortProbeAction

PortProbeDetail

PrivateDnsName

  • PrivateDnsName string: Private DNS name of the EC2 instance.

PrivateIpAddress

  • PrivateIpAddress string: Private IP address of the EC2 instance.

PrivateIpAddressDetails

  • PrivateIpAddressDetails object: Other private IP address information of the EC2 instance.

PrivateIpAddresses

ProductCode

  • ProductCode object: The product code of the EC2 instance.

ProductCodes

  • ProductCodes array: The product code of the EC2 instance.

RemoteIpDetails

RemotePortDetails

  • RemotePortDetails object: Remote port information of the connection.

Resource

SecurityGroup

  • SecurityGroup object: Security groups associated with the EC2 instance.

SecurityGroups

  • SecurityGroups array: Security groups associated with the EC2 instance.

Service

ServiceRole

  • ServiceRole string: Customer serviceRole name or ARN for accessing customer resources

SortCriteria

  • SortCriteria object: Represents the criteria used for sorting findings.

StartMonitoringMembersRequest

  • StartMonitoringMembersRequest object: StartMonitoringMembers request body.

StartMonitoringMembersResponse

StopMonitoringMembersRequest

  • StopMonitoringMembersRequest object: StopMonitoringMembers request body.

StopMonitoringMembersResponse

Tag

Tags

  • Tags array: The tags of the EC2 instance.

ThreatIntelSetFormat

  • ThreatIntelSetFormat string (values: TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE): The format of the threatIntelSet.

ThreatIntelSetId

  • ThreatIntelSetId string: The unique identifier for an threat intel set

ThreatIntelSetIds

  • ThreatIntelSetIds array: The list of the threat intel set IDs

ThreatIntelSetStatus

  • ThreatIntelSetStatus string (values: INACTIVE, ACTIVATING, ACTIVE, DEACTIVATING, ERROR, DELETE_PENDING, DELETED): The status of threatIntelSet file uploaded.

UnarchiveFindingsRequest

  • UnarchiveFindingsRequest object: UnarchiveFindings request body.

UnarchiveFindingsResponse

  • UnarchiveFindingsResponse object

UnprocessedAccount

  • UnprocessedAccount object: An object containing the unprocessed account and a result string explaining why it was unprocessed.

UnprocessedAccounts

  • UnprocessedAccounts array: A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.

UpdateDetectorRequest

  • UpdateDetectorRequest object: UpdateDetector request body.

UpdateDetectorResponse

  • UpdateDetectorResponse object

UpdateFindingsFeedbackRequest

UpdateFindingsFeedbackResponse

  • UpdateFindingsFeedbackResponse object

UpdateIPSetRequest

UpdateIPSetResponse

  • UpdateIPSetResponse object

UpdateThreatIntelSetRequest

  • UpdateThreatIntelSetRequest object: UpdateThreatIntelSet request body.

UpdateThreatIntelSetResponse

  • UpdateThreatIntelSetResponse object

UpdatedAt

  • UpdatedAt string: The first time a resource was created. The format will be ISO-8601.

__boolean

  • __boolean boolean

__double

  • __double number

__integer

  • __integer integer

__string

  • __string string

__timestamp

  • __timestamp string