com.amazonaws.services.detective

Interface AmazonDetective

All Known Subinterfaces:

AmazonDetectiveAsync

All Known Implementing Classes:

AbstractAmazonDetective, AbstractAmazonDetectiveAsync, AmazonDetectiveAsyncClient, AmazonDetectiveClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDetective

Interface for accessing Amazon Detective.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonDetective instead.

Amazon Detective is currently in preview. The Detective API can only be used by accounts that are admitted into the preview.

Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.

The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by a master account.

Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.

A Detective master account can use the Detective API to do the following:

• Enable and disable Detective. Enabling Detective creates a new behavior graph.

• View the list of member accounts in a behavior graph.

• Add member accounts to a behavior graph.

• Remove member accounts from a behavior graph.

A member account can use the Detective API to do the following:

• View the list of behavior graphs that they are invited to.

• Accept an invitation to contribute to a behavior graph.

• Decline an invitation to contribute to a behavior graph.

• Remove their account from a behavior graph.

All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AcceptInvitationResult	acceptInvitation(AcceptInvitationRequest acceptInvitationRequest) Amazon Detective is currently in preview.
CreateGraphResult	createGraph(CreateGraphRequest createGraphRequest) Amazon Detective is currently in preview.
CreateMembersResult	createMembers(CreateMembersRequest createMembersRequest) Amazon Detective is currently in preview.
DeleteGraphResult	deleteGraph(DeleteGraphRequest deleteGraphRequest) Amazon Detective is currently in preview.
DeleteMembersResult	deleteMembers(DeleteMembersRequest deleteMembersRequest) Amazon Detective is currently in preview.
DisassociateMembershipResult	disassociateMembership(DisassociateMembershipRequest disassociateMembershipRequest) Amazon Detective is currently in preview.
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 getMembersRequest) Amazon Detective is currently in preview.
ListGraphsResult	listGraphs(ListGraphsRequest listGraphsRequest) Amazon Detective is currently in preview.
ListInvitationsResult	listInvitations(ListInvitationsRequest listInvitationsRequest) Amazon Detective is currently in preview.
ListMembersResult	listMembers(ListMembersRequest listMembersRequest) Amazon Detective is currently in preview.
RejectInvitationResult	rejectInvitation(RejectInvitationRequest rejectInvitationRequest) Amazon Detective is currently in preview.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

acceptInvitation

AcceptInvitationResult acceptInvitation(AcceptInvitationRequest acceptInvitationRequest)

Amazon Detective is currently in preview.

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.

Parameters:

acceptInvitationRequest -

Returns:

Result of the AcceptInvitation operation returned by the service.

Throws:

ConflictException - The request attempted an invalid action.

InternalServerException - The request was valid but failed because of a problem with the service.

ResourceNotFoundException - The request refers to a nonexistent resource.

ValidationException - The request parameters are invalid.

See Also:

AWS API Documentation

createGraph

CreateGraphResult createGraph(CreateGraphRequest createGraphRequest)

Amazon Detective is currently in preview.

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.

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.

Parameters:

createGraphRequest -

Returns:

Result of the CreateGraph operation returned by the service.

Throws:

ConflictException - The request attempted an invalid action.

InternalServerException - The request was valid but failed because of a problem with the service.

See Also:

AWS API Documentation

createMembers

CreateMembersResult createMembers(CreateMembersRequest createMembersRequest)

Amazon Detective is currently in preview.

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.

Parameters:

createMembersRequest -

Returns:

Result of the CreateMembers operation returned by the service.

Throws:

InternalServerException - The request was valid but failed because of a problem with the service.

ResourceNotFoundException - The request refers to a nonexistent resource.

ValidationException - The request parameters are invalid.

ServiceQuotaExceededException - This request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1000 member accounts.

See Also:

AWS API Documentation

deleteGraph

DeleteGraphResult deleteGraph(DeleteGraphRequest deleteGraphRequest)

Amazon Detective is currently in preview.

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.

Parameters:

deleteGraphRequest -

Returns:

Result of the DeleteGraph operation returned by the service.

Throws:

InternalServerException - The request was valid but failed because of a problem with the service.

ResourceNotFoundException - The request refers to a nonexistent resource.

ValidationException - The request parameters are invalid.

See Also:

AWS API Documentation

deleteMembers

DeleteMembersResult deleteMembers(DeleteMembersRequest deleteMembersRequest)

Amazon Detective is currently in preview.

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.

Parameters:

deleteMembersRequest -

Returns:

Result of the DeleteMembers operation returned by the service.

Throws:

ConflictException - The request attempted an invalid action.

InternalServerException - The request was valid but failed because of a problem with the service.

ResourceNotFoundException - The request refers to a nonexistent resource.

ValidationException - The request parameters are invalid.

See Also:

AWS API Documentation

disassociateMembership

DisassociateMembershipResult disassociateMembership(DisassociateMembershipRequest disassociateMembershipRequest)

Amazon Detective is currently in preview.

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

Parameters:

disassociateMembershipRequest -

Returns:

Result of the DisassociateMembership operation returned by the service.

Throws:

ConflictException - The request attempted an invalid action.

InternalServerException - The request was valid but failed because of a problem with the service.

ResourceNotFoundException - The request refers to a nonexistent resource.

ValidationException - The request parameters are invalid.

See Also:

AWS API Documentation

getMembers

GetMembersResult getMembers(GetMembersRequest getMembersRequest)

Amazon Detective is currently in preview.

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

Parameters:

getMembersRequest -

Returns:

Result of the GetMembers operation returned by the service.

Throws:

InternalServerException - The request was valid but failed because of a problem with the service.

ResourceNotFoundException - The request refers to a nonexistent resource.

ValidationException - The request parameters are invalid.

See Also:

AWS API Documentation

listGraphs

ListGraphsResult listGraphs(ListGraphsRequest listGraphsRequest)

Amazon Detective is currently in preview.

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.

Parameters:

listGraphsRequest -

Returns:

Result of the ListGraphs operation returned by the service.

Throws:

InternalServerException - The request was valid but failed because of a problem with the service.

ValidationException - The request parameters are invalid.

See Also:

AWS API Documentation

listInvitations

ListInvitationsResult listInvitations(ListInvitationsRequest listInvitationsRequest)

Amazon Detective is currently in preview.

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.

Parameters:

listInvitationsRequest -

Returns:

Result of the ListInvitations operation returned by the service.

Throws:

InternalServerException - The request was valid but failed because of a problem with the service.

ValidationException - The request parameters are invalid.

See Also:

AWS API Documentation

listMembers

ListMembersResult listMembers(ListMembersRequest listMembersRequest)

Amazon Detective is currently in preview.

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

Parameters:

listMembersRequest -

Returns:

Result of the ListMembers operation returned by the service.

Throws:

InternalServerException - The request was valid but failed because of a problem with the service.

ResourceNotFoundException - The request refers to a nonexistent resource.

ValidationException - The request parameters are invalid.

See Also:

AWS API Documentation

rejectInvitation

RejectInvitationResult rejectInvitation(RejectInvitationRequest rejectInvitationRequest)

Amazon Detective is currently in preview.

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.

Parameters:

rejectInvitationRequest -

Returns:

Result of the RejectInvitation operation returned by the service.

Throws:

ConflictException - The request attempted an invalid action.

InternalServerException - The request was valid but failed because of a problem with the service.

ResourceNotFoundException - The request refers to a nonexistent resource.

ValidationException - The request parameters are invalid.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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