Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Detective

import { Detective } from "https://aws-api.deno.dev/v0.3/services/detective.ts?docs=full";
class Detective {
constructor(apiFactory: client.ApiFactory);
async acceptInvitation(params: AcceptInvitationRequest, opts?: client.RequestOptions): Promise<void>;
async createGraph(params?: CreateGraphRequest, opts?: client.RequestOptions): Promise<CreateGraphResponse>;
async createMembers(params: CreateMembersRequest, opts?: client.RequestOptions): Promise<CreateMembersResponse>;
async deleteGraph(params: DeleteGraphRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMembers(params: DeleteMembersRequest, opts?: client.RequestOptions): Promise<DeleteMembersResponse>;
async describeOrganizationConfiguration(params: DescribeOrganizationConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeOrganizationConfigurationResponse>;
async disableOrganizationAdminAccount(opts?: client.RequestOptions): Promise<void>;
async disassociateMembership(params: DisassociateMembershipRequest, opts?: client.RequestOptions): Promise<void>;
async enableOrganizationAdminAccount(params: EnableOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>;
async getMembers(params: GetMembersRequest, opts?: client.RequestOptions): Promise<GetMembersResponse>;
async listGraphs(params?: ListGraphsRequest, opts?: client.RequestOptions): Promise<ListGraphsResponse>;
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 rejectInvitation(params: RejectInvitationRequest, opts?: client.RequestOptions): Promise<void>;
async startMonitoringMember(params: StartMonitoringMemberRequest, opts?: client.RequestOptions): Promise<void>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateOrganizationConfiguration(params: UpdateOrganizationConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new Detective(apiFactory: client.ApiFactory)
[src]

§Methods

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

Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.

The request provides the ARN of behavior graph.

The member account status in the graph must be INVITED.

§
createGraph(params?: CreateGraphRequest, opts?: client.RequestOptions): Promise<CreateGraphResponse>
[src]

Creates a new behavior graph for the calling account, and sets that account as the administrator account. This operation is called by the account that is enabling Detective.

Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective.

The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.

CreateGraph triggers a process to create the corresponding data tables for the new behavior graph.

An account can only be the administrator account for one behavior graph within a Region. If the same account calls CreateGraph with the same administrator account, it always returns the same behavior graph ARN. It does not create a new behavior graph.

§

CreateMembers is used to send invitations to accounts. For the organization behavior graph, the Detective administrator account uses CreateMembers to enable organization accounts as member accounts.

For invited accounts, CreateMembers sends a request to invite the specified Amazon Web Services accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph.

CreateMembers verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally.

For organization accounts in the organization behavior graph, CreateMembers attempts to enable the accounts. The organization accounts do not receive invitations.

The request provides the behavior graph ARN and the list of accounts to invite or to enable.

The response separates the requested accounts into two lists:

  • The accounts that CreateMembers was able to process. For invited accounts, includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification. For organization accounts in the organization behavior graph, includes accounts that can be enabled and that cannot be enabled.
  • The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.
§
deleteGraph(params: DeleteGraphRequest, opts?: client.RequestOptions): Promise<void>
[src]

Disables the specified behavior graph and queues it to be deleted. This operation removes the behavior graph from each member account's list of behavior graphs.

DeleteGraph can only be called by the administrator account for a behavior graph.

§

Removes the specified member accounts from the behavior graph. The removed accounts no longer contribute data to the behavior graph. This operation can only be called by the administrator account for the behavior graph.

For invited accounts, the removed accounts are deleted from the list of accounts in the behavior graph. To restore the account, the administrator account must send another invitation.

For organization accounts in the organization behavior graph, the Detective administrator account can always enable the organization account again. Organization accounts that are not enabled as member accounts are not included in the ListMembers results for the organization behavior graph.

An administrator account cannot use DeleteMembers to remove their own account from the behavior graph. To disable a behavior graph, the administrator account uses the DeleteGraph API method.

§

Returns information about the configuration for the organization behavior graph. Currently indicates whether to automatically enable new organization accounts as member accounts.

Can only be called by the Detective administrator account for the organization.

§
disableOrganizationAdminAccount(opts?: client.RequestOptions): Promise<void>
[src]

Removes the Detective administrator account for the organization in the current Region. Deletes the behavior graph for that account.

Can only be called by the organization management account. Before you can select a different Detective administrator account, you must remove the Detective administrator account in all Regions.

§
disassociateMembership(params: DisassociateMembershipRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes the member account from the specified behavior graph. This operation can only be called by an invited member account that has the ENABLED status.

DisassociateMembership cannot be called by an organization account in the organization behavior graph. For the organization behavior graph, the Detective administrator account determines which organization accounts to enable or disable as member accounts.

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

Designates the Detective administrator account for the organization in the current Region.

If the account does not have Detective enabled, then enables Detective for that account and creates a new behavior graph.

Can only be called by the organization management account.

The Detective administrator account for an organization must be the same in all Regions. If you already designated a Detective administrator account in another Region, then you must designate the same account.

§

Returns the membership details for specified member accounts for a behavior graph.

§
listGraphs(params?: ListGraphsRequest, opts?: client.RequestOptions): Promise<ListGraphsResponse>
[src]

Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account.

Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph.

§

Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by an invited member account.

Open invitations are invitations that the member account has not responded to.

The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.

§

Retrieves the list of member accounts for a behavior graph.

For invited accounts, the results do not include member accounts that were removed from the behavior graph.

For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts.

§

Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.

§

Returns the tag values that are assigned to a behavior graph.

§
rejectInvitation(params: RejectInvitationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by an invited member account that has the INVITED status.

RejectInvitation cannot be called by an organization account in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation.

§
startMonitoringMember(params: StartMonitoringMemberRequest, opts?: client.RequestOptions): Promise<void>
[src]

Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED.

For valid member accounts, the status is updated as follows.

  • If Detective enabled the member account, then the new status is ENABLED.
  • If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED.
§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Applies tag values to a behavior graph.

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

Removes tags from a behavior graph.

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

Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.

§Static Properties