@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonDetective extends Object implements AmazonDetective
AmazonDetective. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AcceptInvitationResult |
acceptInvitation(AcceptInvitationRequest request)
Accepts an invitation for the member account to contribute data to a behavior graph.
|
BatchGetGraphMemberDatasourcesResult |
batchGetGraphMemberDatasources(BatchGetGraphMemberDatasourcesRequest request)
Gets data source package information for the behavior graph.
|
BatchGetMembershipDatasourcesResult |
batchGetMembershipDatasources(BatchGetMembershipDatasourcesRequest request)
Gets information on the data source package history for an account.
|
CreateGraphResult |
createGraph(CreateGraphRequest request)
Creates a new behavior graph for the calling account, and sets that account as the administrator account.
|
CreateMembersResult |
createMembers(CreateMembersRequest request)
CreateMembers is used to send invitations to accounts. |
DeleteGraphResult |
deleteGraph(DeleteGraphRequest request)
Disables the specified behavior graph and queues it to be deleted.
|
DeleteMembersResult |
deleteMembers(DeleteMembersRequest request)
Removes the specified member accounts from the behavior graph.
|
DescribeOrganizationConfigurationResult |
describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest request)
Returns information about the configuration for the organization behavior graph.
|
DisableOrganizationAdminAccountResult |
disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest request)
Removes the Detective administrator account in the current Region.
|
DisassociateMembershipResult |
disassociateMembership(DisassociateMembershipRequest request)
Removes the member account from the specified behavior graph.
|
EnableOrganizationAdminAccountResult |
enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest request)
Designates the Detective administrator account for the organization in the current Region.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetInvestigationResult |
getInvestigation(GetInvestigationRequest request)
Returns the investigation results of an investigation for a behavior graph.
|
GetMembersResult |
getMembers(GetMembersRequest request)
Returns the membership details for specified member accounts for a behavior graph.
|
ListDatasourcePackagesResult |
listDatasourcePackages(ListDatasourcePackagesRequest request)
Lists data source packages in the behavior graph.
|
ListGraphsResult |
listGraphs(ListGraphsRequest request)
Returns the list of behavior graphs that the calling account is an administrator account of.
|
ListIndicatorsResult |
listIndicators(ListIndicatorsRequest request)
Get the indicators from an investigation
|
ListInvestigationsResult |
listInvestigations(ListInvestigationsRequest request)
List all Investigations.
|
ListInvitationsResult |
listInvitations(ListInvitationsRequest request)
Retrieves the list of open and accepted behavior graph invitations for the member account.
|
ListMembersResult |
listMembers(ListMembersRequest request)
Retrieves the list of member accounts for a behavior graph.
|
ListOrganizationAdminAccountsResult |
listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest request)
Returns information about the Detective administrator account for an organization.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns the tag values that are assigned to a behavior graph.
|
RejectInvitationResult |
rejectInvitation(RejectInvitationRequest request)
Rejects an invitation to contribute the account data to a behavior graph.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartInvestigationResult |
startInvestigation(StartInvestigationRequest request)
initiate an investigation on an entity in a graph
|
StartMonitoringMemberResult |
startMonitoringMember(StartMonitoringMemberRequest request)
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED. |
TagResourceResult |
tagResource(TagResourceRequest request)
Applies tag values to a behavior graph.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a behavior graph.
|
UpdateDatasourcePackagesResult |
updateDatasourcePackages(UpdateDatasourcePackagesRequest request)
Starts a data source packages for the behavior graph.
|
UpdateInvestigationStateResult |
updateInvestigationState(UpdateInvestigationStateRequest request)
Update the state of an investigation.
|
UpdateOrganizationConfigurationResult |
updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest request)
Updates the configuration for the Organizations integration in the current Region.
|
public AcceptInvitationResult acceptInvitation(AcceptInvitationRequest request)
AmazonDetectiveAccepts 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.
acceptInvitation in interface AmazonDetectivepublic BatchGetGraphMemberDatasourcesResult batchGetGraphMemberDatasources(BatchGetGraphMemberDatasourcesRequest request)
AmazonDetectiveGets data source package information for the behavior graph.
batchGetGraphMemberDatasources in interface AmazonDetectivepublic BatchGetMembershipDatasourcesResult batchGetMembershipDatasources(BatchGetMembershipDatasourcesRequest request)
AmazonDetectiveGets information on the data source package history for an account.
batchGetMembershipDatasources in interface AmazonDetectivepublic CreateGraphResult createGraph(CreateGraphRequest request)
AmazonDetectiveCreates 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.
createGraph in interface AmazonDetectivepublic CreateMembersResult createMembers(CreateMembersRequest request)
AmazonDetective
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.
createMembers in interface AmazonDetectivepublic DeleteGraphResult deleteGraph(DeleteGraphRequest request)
AmazonDetectiveDisables 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.
deleteGraph in interface AmazonDetectivepublic DeleteMembersResult deleteMembers(DeleteMembersRequest request)
AmazonDetectiveRemoves 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.
deleteMembers in interface AmazonDetectivepublic DescribeOrganizationConfigurationResult describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest request)
AmazonDetectiveReturns 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.
describeOrganizationConfiguration in interface AmazonDetectivepublic DisableOrganizationAdminAccountResult disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest request)
AmazonDetectiveRemoves the Detective administrator account in the current Region. Deletes the organization behavior graph.
Can only be called by the organization management account.
Removing the Detective administrator account does not affect the delegated administrator account for Detective in Organizations.
To remove the delegated administrator account in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective administrator account in all Regions, except for Regions where the Detective administrator account is the organization management account.
disableOrganizationAdminAccount in interface AmazonDetectivepublic DisassociateMembershipResult disassociateMembership(DisassociateMembershipRequest request)
AmazonDetective
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.
disassociateMembership in interface AmazonDetectivepublic EnableOrganizationAdminAccountResult enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest request)
AmazonDetectiveDesignates 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.
If the organization has a delegated administrator account in Organizations, then the Detective administrator account must be either the delegated administrator account or the organization management account.
If the organization does not have a delegated administrator account in Organizations, then you can choose any account in the organization. If you choose an account other than the organization management account, Detective calls Organizations to make that account the delegated administrator account for Detective. The organization management account cannot be the delegated administrator account.
enableOrganizationAdminAccount in interface AmazonDetectivepublic GetInvestigationResult getInvestigation(GetInvestigationRequest request)
AmazonDetectiveReturns the investigation results of an investigation for a behavior graph.
getInvestigation in interface AmazonDetectivepublic GetMembersResult getMembers(GetMembersRequest request)
AmazonDetectiveReturns the membership details for specified member accounts for a behavior graph.
getMembers in interface AmazonDetectivepublic ListDatasourcePackagesResult listDatasourcePackages(ListDatasourcePackagesRequest request)
AmazonDetectiveLists data source packages in the behavior graph.
listDatasourcePackages in interface AmazonDetectivepublic ListGraphsResult listGraphs(ListGraphsRequest request)
AmazonDetectiveReturns 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.
listGraphs in interface AmazonDetectivepublic ListIndicatorsResult listIndicators(ListIndicatorsRequest request)
AmazonDetectiveGet the indicators from an investigation
listIndicators in interface AmazonDetectivepublic ListInvestigationsResult listInvestigations(ListInvestigationsRequest request)
AmazonDetectiveList all Investigations.
listInvestigations in interface AmazonDetectivepublic ListInvitationsResult listInvitations(ListInvitationsRequest request)
AmazonDetectiveRetrieves 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.
listInvitations in interface AmazonDetectivepublic ListMembersResult listMembers(ListMembersRequest request)
AmazonDetectiveRetrieves 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.
listMembers in interface AmazonDetectivepublic ListOrganizationAdminAccountsResult listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest request)
AmazonDetectiveReturns information about the Detective administrator account for an organization. Can only be called by the organization management account.
listOrganizationAdminAccounts in interface AmazonDetectivepublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonDetectiveReturns the tag values that are assigned to a behavior graph.
listTagsForResource in interface AmazonDetectivepublic RejectInvitationResult rejectInvitation(RejectInvitationRequest request)
AmazonDetective
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.
rejectInvitation in interface AmazonDetectivepublic StartInvestigationResult startInvestigation(StartInvestigationRequest request)
AmazonDetectiveinitiate an investigation on an entity in a graph
startInvestigation in interface AmazonDetectivepublic StartMonitoringMemberResult startMonitoringMember(StartMonitoringMemberRequest request)
AmazonDetective
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.
startMonitoringMember in interface AmazonDetectivepublic TagResourceResult tagResource(TagResourceRequest request)
AmazonDetectiveApplies tag values to a behavior graph.
tagResource in interface AmazonDetectivepublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonDetectiveRemoves tags from a behavior graph.
untagResource in interface AmazonDetectivepublic UpdateDatasourcePackagesResult updateDatasourcePackages(UpdateDatasourcePackagesRequest request)
AmazonDetectiveStarts a data source packages for the behavior graph.
updateDatasourcePackages in interface AmazonDetectivepublic UpdateInvestigationStateResult updateInvestigationState(UpdateInvestigationStateRequest request)
AmazonDetectiveUpdate the state of an investigation.
updateInvestigationState in interface AmazonDetectivepublic UpdateOrganizationConfigurationResult updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest request)
AmazonDetectiveUpdates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.
updateOrganizationConfiguration in interface AmazonDetectivepublic void shutdown()
AmazonDetectiveshutdown in interface AmazonDetectivepublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonDetectiveResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonDetectiverequest - The originally executed request.