com.amazonaws.services.detective

Class AbstractAmazonDetective

java.lang.Object

com.amazonaws.services.detective.AbstractAmazonDetective

All Implemented Interfaces:

AmazonDetective

Direct Known Subclasses:

AbstractAmazonDetectiveAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonDetective
extends Object
implements AmazonDetective

Abstract implementation of AmazonDetective. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.detective.AmazonDetective

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonDetective()

Method Summary

Modifier and Type	Method and Description
AcceptInvitationResult	acceptInvitation(AcceptInvitationRequest request) Accepts an invitation for the member account to contribute data to a behavior graph.
CreateGraphResult	createGraph(CreateGraphRequest request) Creates a new behavior graph for the calling account, and sets that account as the master account.
CreateMembersResult	createMembers(CreateMembersRequest request) Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph.
DeleteGraphResult	deleteGraph(DeleteGraphRequest request) Disables the specified behavior graph and queues it to be deleted.
DeleteMembersResult	deleteMembers(DeleteMembersRequest request) Deletes one or more member accounts from the master account behavior graph.
DisassociateMembershipResult	disassociateMembership(DisassociateMembershipRequest request) Removes the member account from the specified behavior graph.
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.
GetMembersResult	getMembers(GetMembersRequest request) Returns the membership details for specified member accounts for a behavior graph.
ListGraphsResult	listGraphs(ListGraphsRequest request) Returns the list of behavior graphs that the calling account is a master of.
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.
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.
StartMonitoringMemberResult	startMonitoringMember(StartMonitoringMemberRequest request) Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAmazonDetective

protected AbstractAmazonDetective()

Method Detail

acceptInvitation

public AcceptInvitationResult acceptInvitation(AcceptInvitationRequest request)

Description copied from interface: AmazonDetective

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.

Specified by:

acceptInvitation in interface AmazonDetective

Returns:

Result of the AcceptInvitation operation returned by the service.

See Also:

AWS API Documentation

createGraph

public CreateGraphResult createGraph(CreateGraphRequest request)

Description copied from interface: AmazonDetective

Creates a new behavior graph for the calling account, and sets that account as the master 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 master account for one behavior graph within a Region. If the same account calls CreateGraph with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph.

Specified by:

createGraph in interface AmazonDetective

Returns:

Result of the CreateGraph operation returned by the service.

See Also:

AWS API Documentation

createMembers

public CreateMembersResult createMembers(CreateMembersRequest request)

Description copied from interface: AmazonDetective

Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the master account for a behavior graph.

CreateMembers verifies the accounts and then sends invitations to the verified accounts.

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

The response separates the requested accounts into two lists:

• The accounts that CreateMembers was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are being sent an invitation, and that have failed verification.

• The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.

Specified by:

createMembers in interface AmazonDetective

Returns:

Result of the CreateMembers operation returned by the service.

See Also:

AWS API Documentation

deleteGraph

public DeleteGraphResult deleteGraph(DeleteGraphRequest request)

Description copied from interface: AmazonDetective

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

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

Specified by:

deleteGraph in interface AmazonDetective

Returns:

Result of the DeleteGraph operation returned by the service.

See Also:

AWS API Documentation

deleteMembers

public DeleteMembersResult deleteMembers(DeleteMembersRequest request)

Description copied from interface: AmazonDetective

Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use DeleteMembers to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the DeleteGraph API method.

Specified by:

deleteMembers in interface AmazonDetective

Returns:

Result of the DeleteMembers operation returned by the service.

See Also:

AWS API Documentation

disassociateMembership

public DisassociateMembershipResult disassociateMembership(DisassociateMembershipRequest request)

Description copied from interface: AmazonDetective

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

Specified by:

disassociateMembership in interface AmazonDetective

Returns:

Result of the DisassociateMembership operation returned by the service.

See Also:

AWS API Documentation

getMembers

public GetMembersResult getMembers(GetMembersRequest request)

Description copied from interface: AmazonDetective

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

Specified by:

getMembers in interface AmazonDetective

Returns:

Result of the GetMembers operation returned by the service.

See Also:

AWS API Documentation

listGraphs

public ListGraphsResult listGraphs(ListGraphsRequest request)

Description copied from interface: AmazonDetective

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

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

Specified by:

listGraphs in interface AmazonDetective

Returns:

Result of the ListGraphs operation returned by the service.

See Also:

AWS API Documentation

listInvitations

public ListInvitationsResult listInvitations(ListInvitationsRequest request)

Description copied from interface: AmazonDetective

Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a 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.

Specified by:

listInvitations in interface AmazonDetective

Returns:

Result of the ListInvitations operation returned by the service.

See Also:

AWS API Documentation

listMembers

public ListMembersResult listMembers(ListMembersRequest request)

Description copied from interface: AmazonDetective

Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.

Specified by:

listMembers in interface AmazonDetective

Returns:

Result of the ListMembers operation returned by the service.

See Also:

AWS API Documentation

rejectInvitation

public RejectInvitationResult rejectInvitation(RejectInvitationRequest request)

Description copied from interface: AmazonDetective

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

Specified by:

rejectInvitation in interface AmazonDetective

Returns:

Result of the RejectInvitation operation returned by the service.

See Also:

AWS API Documentation

startMonitoringMember

public StartMonitoringMemberResult startMonitoringMember(StartMonitoringMemberRequest request)

Description copied from interface: 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.

Specified by:

startMonitoringMember in interface AmazonDetective

Returns:

Result of the StartMonitoringMember operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonDetective

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonDetective

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonDetective

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response 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.

Specified by:

getCachedResponseMetadata in interface AmazonDetective

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.