@datafire/amazonaws_detective NPM

@datafire/amazonaws_detective

Client library for Amazon Detective

Installation and Usage

npm install --save @datafire/amazonaws_detective

let amazonaws_detective = require('@datafire/amazonaws_detective').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

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

Description

Actions

CreateGraph

amazonaws_detective.CreateGraph({}, context)

Input

input object

Output

output CreateGraphResponse

StartMonitoringMember

amazonaws_detective.StartMonitoringMember({
  "GraphArn": "",
  "AccountId": ""
}, context)

Input

input object
- AccountId required string: The account ID of the member account to try to enable. The account must be an invited member account with a status of ACCEPTED_BUT_DISABLED.
- GraphArn required string: The ARN of the behavior graph.

Output

Output schema unknown

CreateMembers

amazonaws_detective.CreateMembers({
  "GraphArn": "",
  "Accounts": []
}, context)

Input

input object
- Accounts required array: The list of AWS accounts to invite to become member accounts in the behavior graph. For each invited account, the account list contains the account identifier and the AWS account root user email address.
  - items Account
- GraphArn required string: The ARN of the behavior graph to invite the member accounts to contribute their data to.
- Message string: Customized message text to include in the invitation email message to the invited member accounts.

Output

output CreateMembersResponse

GetMembers

amazonaws_detective.GetMembers({
  "GraphArn": "",
  "AccountIds": []
}, context)

Input

input object
- AccountIds required array: The list of AWS account identifiers for the member account for which to return member details. You cannot use GetMembers to retrieve information about member accounts that were removed from the behavior graph.
  - items AccountId
- GraphArn required string: The ARN of the behavior graph for which to request the member details.

Output

output GetMembersResponse

ListMembers

amazonaws_detective.ListMembers({
  "GraphArn": ""
}, context)

Input

input object
- MaxResults string
- NextToken string
- GraphArn required string: The ARN of the behavior graph for which to retrieve the list of member accounts.
- MaxResults integer: The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.
- NextToken string: For requests to retrieve the next page of member account results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.

Output

output ListMembersResponse

DeleteMembers

amazonaws_detective.DeleteMembers({
  "GraphArn": "",
  "AccountIds": []
}, context)

Input

input object
- AccountIds required array: The list of AWS account identifiers for the member accounts to delete from the behavior graph.
  - items AccountId
- GraphArn required string: The ARN of the behavior graph to delete members from.

Output

output DeleteMembersResponse

DeleteGraph

amazonaws_detective.DeleteGraph({
  "GraphArn": ""
}, context)

Input

input object
- GraphArn required string: The ARN of the behavior graph to disable.

Output

Output schema unknown

ListGraphs

amazonaws_detective.ListGraphs({}, context)

Input

input object
- MaxResults string
- NextToken string
- MaxResults integer: The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.
- NextToken string: For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.

Output

output ListGraphsResponse

AcceptInvitation

amazonaws_detective.AcceptInvitation({
  "GraphArn": ""
}, context)

Input

input object
- GraphArn required string: The ARN of the behavior graph that the member account is accepting the invitation for. The member account status in the behavior graph must be INVITED.

Output

Output schema unknown

RejectInvitation

amazonaws_detective.RejectInvitation({
  "GraphArn": ""
}, context)

Input

input object
- GraphArn required string: The ARN of the behavior graph to reject the invitation to. The member account's current member status in the behavior graph must be INVITED.

Output

Output schema unknown

ListInvitations

amazonaws_detective.ListInvitations({}, context)

Input

input object
- MaxResults string
- NextToken string
- MaxResults integer: The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.
- NextToken string: For requests to retrieve the next page of results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.

Output

output ListInvitationsResponse

DisassociateMembership

amazonaws_detective.DisassociateMembership({
  "GraphArn": ""
}, context)

Input

input object
- GraphArn required string: The ARN of the behavior graph to remove the member account from. The member account's member status in the behavior graph must be ENABLED.

Output

Output schema unknown

Definitions

AcceptInvitationRequest

AcceptInvitationRequest object
- GraphArn required

Account

Account object: An AWS account that is the master of or a member of a behavior graph.
- AccountId required
- EmailAddress required

AccountId

AccountId string

AccountIdList

AccountIdList array
- items AccountId

AccountList

AccountList array
- items Account

ConflictException

CreateGraphResponse

CreateGraphResponse object
- GraphArn

CreateMembersRequest

CreateMembersRequest object
- Accounts required
  - items Account
- GraphArn required
- Message

CreateMembersResponse

CreateMembersResponse object
- Members
  - items MemberDetail
- UnprocessedAccounts
  - items UnprocessedAccount

DeleteGraphRequest

DeleteGraphRequest object
- GraphArn required

DeleteMembersRequest

DeleteMembersRequest object
- AccountIds required
  - items AccountId
- GraphArn required

DeleteMembersResponse

DeleteMembersResponse object
- AccountIds
  - items AccountId
- UnprocessedAccounts
  - items UnprocessedAccount

DisassociateMembershipRequest

DisassociateMembershipRequest object
- GraphArn required

EmailAddress

EmailAddress string

EmailMessage

EmailMessage string

GetMembersRequest

GetMembersRequest object
- AccountIds required
  - items AccountId
- GraphArn required

GetMembersResponse

GetMembersResponse object
- MemberDetails
  - items MemberDetail
- UnprocessedAccounts
  - items UnprocessedAccount

Graph

Graph object: A behavior graph in Detective.
- Arn
- CreatedTime

GraphArn

GraphArn string

GraphList

GraphList array
- items Graph

InternalServerException

ListGraphsRequest

ListGraphsRequest object
- MaxResults
- NextToken

ListGraphsResponse

ListGraphsResponse object
- GraphList
  - items Graph
- NextToken

ListInvitationsRequest

ListInvitationsRequest object
- MaxResults
- NextToken

ListInvitationsResponse

ListInvitationsResponse object
- Invitations
  - items MemberDetail
- NextToken

ListMembersRequest

ListMembersRequest object
- GraphArn required
- MaxResults
- NextToken

ListMembersResponse

ListMembersResponse object
- MemberDetails
  - items MemberDetail
- NextToken

MemberDetail

MemberDetail object: Details about a member account that was invited to contribute to a behavior graph.
- AccountId
- DisabledReason
- EmailAddress
- GraphArn
- InvitedTime
- MasterId
- PercentOfGraphUtilization
- PercentOfGraphUtilizationUpdatedTime
- Status
- UpdatedTime

MemberDetailList

MemberDetailList array
- items MemberDetail

MemberDisabledReason

MemberDisabledReason string (values: VOLUME_TOO_HIGH, VOLUME_UNKNOWN)

MemberResultsLimit

MemberResultsLimit integer

MemberStatus

MemberStatus string (values: INVITED, VERIFICATION_IN_PROGRESS, VERIFICATION_FAILED, ENABLED, ACCEPTED_BUT_DISABLED)

PaginationToken

PaginationToken string

Percentage

Percentage number

RejectInvitationRequest

RejectInvitationRequest object
- GraphArn required

ResourceNotFoundException

ServiceQuotaExceededException

StartMonitoringMemberRequest

StartMonitoringMemberRequest object
- AccountId required
- GraphArn required

Timestamp

Timestamp string

UnprocessedAccount

UnprocessedAccount object: A member account that was included in a request but for which the request could not be processed.
- AccountId
- Reason

UnprocessedAccountList

UnprocessedAccountList array
- items UnprocessedAccount

UnprocessedReason

UnprocessedReason string

ValidationException

datafire aws-sdk

@infinitebrahmanuniverse/nolb-_datafire_am @everything-registry/sub-chunk-220

5.0.0

5 years ago