com.amazonaws.services.detective

Class AmazonDetectiveAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.detective.AmazonDetectiveClient

com.amazonaws.services.detective.AmazonDetectiveAsyncClient

All Implemented Interfaces:

AmazonDetective, AmazonDetectiveAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonDetectiveAsyncClient
extends AmazonDetectiveClient
implements AmazonDetectiveAsync

Client for accessing Amazon Detective asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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 inherited from class com.amazonaws.services.detective.AmazonDetectiveClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<AcceptInvitationResult>	acceptInvitationAsync(AcceptInvitationRequest request) Amazon Detective is currently in preview.
Future<AcceptInvitationResult>	acceptInvitationAsync(AcceptInvitationRequest request, AsyncHandler<AcceptInvitationRequest,AcceptInvitationResult> asyncHandler) Amazon Detective is currently in preview.
static AmazonDetectiveAsyncClientBuilder	asyncBuilder()
Future<CreateGraphResult>	createGraphAsync(CreateGraphRequest request) Amazon Detective is currently in preview.
Future<CreateGraphResult>	createGraphAsync(CreateGraphRequest request, AsyncHandler<CreateGraphRequest,CreateGraphResult> asyncHandler) Amazon Detective is currently in preview.
Future<CreateMembersResult>	createMembersAsync(CreateMembersRequest request) Amazon Detective is currently in preview.
Future<CreateMembersResult>	createMembersAsync(CreateMembersRequest request, AsyncHandler<CreateMembersRequest,CreateMembersResult> asyncHandler) Amazon Detective is currently in preview.
Future<DeleteGraphResult>	deleteGraphAsync(DeleteGraphRequest request) Amazon Detective is currently in preview.
Future<DeleteGraphResult>	deleteGraphAsync(DeleteGraphRequest request, AsyncHandler<DeleteGraphRequest,DeleteGraphResult> asyncHandler) Amazon Detective is currently in preview.
Future<DeleteMembersResult>	deleteMembersAsync(DeleteMembersRequest request) Amazon Detective is currently in preview.
Future<DeleteMembersResult>	deleteMembersAsync(DeleteMembersRequest request, AsyncHandler<DeleteMembersRequest,DeleteMembersResult> asyncHandler) Amazon Detective is currently in preview.
Future<DisassociateMembershipResult>	disassociateMembershipAsync(DisassociateMembershipRequest request) Amazon Detective is currently in preview.
Future<DisassociateMembershipResult>	disassociateMembershipAsync(DisassociateMembershipRequest request, AsyncHandler<DisassociateMembershipRequest,DisassociateMembershipResult> asyncHandler) Amazon Detective is currently in preview.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetMembersResult>	getMembersAsync(GetMembersRequest request) Amazon Detective is currently in preview.
Future<GetMembersResult>	getMembersAsync(GetMembersRequest request, AsyncHandler<GetMembersRequest,GetMembersResult> asyncHandler) Amazon Detective is currently in preview.
Future<ListGraphsResult>	listGraphsAsync(ListGraphsRequest request) Amazon Detective is currently in preview.
Future<ListGraphsResult>	listGraphsAsync(ListGraphsRequest request, AsyncHandler<ListGraphsRequest,ListGraphsResult> asyncHandler) Amazon Detective is currently in preview.
Future<ListInvitationsResult>	listInvitationsAsync(ListInvitationsRequest request) Amazon Detective is currently in preview.
Future<ListInvitationsResult>	listInvitationsAsync(ListInvitationsRequest request, AsyncHandler<ListInvitationsRequest,ListInvitationsResult> asyncHandler) Amazon Detective is currently in preview.
Future<ListMembersResult>	listMembersAsync(ListMembersRequest request) Amazon Detective is currently in preview.
Future<ListMembersResult>	listMembersAsync(ListMembersRequest request, AsyncHandler<ListMembersRequest,ListMembersResult> asyncHandler) Amazon Detective is currently in preview.
Future<RejectInvitationResult>	rejectInvitationAsync(RejectInvitationRequest request) Amazon Detective is currently in preview.
Future<RejectInvitationResult>	rejectInvitationAsync(RejectInvitationRequest request, AsyncHandler<RejectInvitationRequest,RejectInvitationResult> asyncHandler) Amazon Detective is currently in preview.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.detective.AmazonDetectiveClient

acceptInvitation, builder, createGraph, createMembers, deleteGraph, deleteMembers, disassociateMembership, getCachedResponseMetadata, getMembers, listGraphs, listInvitations, listMembers, rejectInvitation

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

acceptInvitation, createGraph, createMembers, deleteGraph, deleteMembers, disassociateMembership, getCachedResponseMetadata, getMembers, listGraphs, listInvitations, listMembers, rejectInvitation

Method Detail

asyncBuilder

public static AmazonDetectiveAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

acceptInvitationAsync

public Future<AcceptInvitationResult> acceptInvitationAsync(AcceptInvitationRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

acceptInvitationAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the AcceptInvitation operation returned by the service.

See Also:

AWS API Documentation

acceptInvitationAsync

public Future<AcceptInvitationResult> acceptInvitationAsync(AcceptInvitationRequest request,
                                                            AsyncHandler<AcceptInvitationRequest,AcceptInvitationResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

acceptInvitationAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AcceptInvitation operation returned by the service.

See Also:

AWS API Documentation

createGraphAsync

public Future<CreateGraphResult> createGraphAsync(CreateGraphRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

createGraphAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the CreateGraph operation returned by the service.

See Also:

AWS API Documentation

createGraphAsync

public Future<CreateGraphResult> createGraphAsync(CreateGraphRequest request,
                                                  AsyncHandler<CreateGraphRequest,CreateGraphResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

createGraphAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateGraph operation returned by the service.

See Also:

AWS API Documentation

createMembersAsync

public Future<CreateMembersResult> createMembersAsync(CreateMembersRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

createMembersAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the CreateMembers operation returned by the service.

See Also:

AWS API Documentation

createMembersAsync

public Future<CreateMembersResult> createMembersAsync(CreateMembersRequest request,
                                                      AsyncHandler<CreateMembersRequest,CreateMembersResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

createMembersAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateMembers operation returned by the service.

See Also:

AWS API Documentation

deleteGraphAsync

public Future<DeleteGraphResult> deleteGraphAsync(DeleteGraphRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

deleteGraphAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the DeleteGraph operation returned by the service.

See Also:

AWS API Documentation

deleteGraphAsync

public Future<DeleteGraphResult> deleteGraphAsync(DeleteGraphRequest request,
                                                  AsyncHandler<DeleteGraphRequest,DeleteGraphResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

deleteGraphAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteGraph operation returned by the service.

See Also:

AWS API Documentation

deleteMembersAsync

public Future<DeleteMembersResult> deleteMembersAsync(DeleteMembersRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

deleteMembersAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the DeleteMembers operation returned by the service.

See Also:

AWS API Documentation

deleteMembersAsync

public Future<DeleteMembersResult> deleteMembersAsync(DeleteMembersRequest request,
                                                      AsyncHandler<DeleteMembersRequest,DeleteMembersResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

deleteMembersAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteMembers operation returned by the service.

See Also:

AWS API Documentation

disassociateMembershipAsync

public Future<DisassociateMembershipResult> disassociateMembershipAsync(DisassociateMembershipRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

disassociateMembershipAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the DisassociateMembership operation returned by the service.

See Also:

AWS API Documentation

disassociateMembershipAsync

public Future<DisassociateMembershipResult> disassociateMembershipAsync(DisassociateMembershipRequest request,
                                                                        AsyncHandler<DisassociateMembershipRequest,DisassociateMembershipResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

disassociateMembershipAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DisassociateMembership operation returned by the service.

See Also:

AWS API Documentation

getMembersAsync

public Future<GetMembersResult> getMembersAsync(GetMembersRequest request)

Description copied from interface: AmazonDetectiveAsync

Amazon Detective is currently in preview.

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

Specified by:

getMembersAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the GetMembers operation returned by the service.

See Also:

AWS API Documentation

getMembersAsync

public Future<GetMembersResult> getMembersAsync(GetMembersRequest request,
                                                AsyncHandler<GetMembersRequest,GetMembersResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

Amazon Detective is currently in preview.

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

Specified by:

getMembersAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetMembers operation returned by the service.

See Also:

AWS API Documentation

listGraphsAsync

public Future<ListGraphsResult> listGraphsAsync(ListGraphsRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

listGraphsAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the ListGraphs operation returned by the service.

See Also:

AWS API Documentation

listGraphsAsync

public Future<ListGraphsResult> listGraphsAsync(ListGraphsRequest request,
                                                AsyncHandler<ListGraphsRequest,ListGraphsResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

listGraphsAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListGraphs operation returned by the service.

See Also:

AWS API Documentation

listInvitationsAsync

public Future<ListInvitationsResult> listInvitationsAsync(ListInvitationsRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

listInvitationsAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the ListInvitations operation returned by the service.

See Also:

AWS API Documentation

listInvitationsAsync

public Future<ListInvitationsResult> listInvitationsAsync(ListInvitationsRequest request,
                                                          AsyncHandler<ListInvitationsRequest,ListInvitationsResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

listInvitationsAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListInvitations operation returned by the service.

See Also:

AWS API Documentation

listMembersAsync

public Future<ListMembersResult> listMembersAsync(ListMembersRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

listMembersAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the ListMembers operation returned by the service.

See Also:

AWS API Documentation

listMembersAsync

public Future<ListMembersResult> listMembersAsync(ListMembersRequest request,
                                                  AsyncHandler<ListMembersRequest,ListMembersResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

listMembersAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListMembers operation returned by the service.

See Also:

AWS API Documentation

rejectInvitationAsync

public Future<RejectInvitationResult> rejectInvitationAsync(RejectInvitationRequest request)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

rejectInvitationAsync in interface AmazonDetectiveAsync

Returns:

A Java Future containing the result of the RejectInvitation operation returned by the service.

See Also:

AWS API Documentation

rejectInvitationAsync

public Future<RejectInvitationResult> rejectInvitationAsync(RejectInvitationRequest request,
                                                            AsyncHandler<RejectInvitationRequest,RejectInvitationResult> asyncHandler)

Description copied from interface: AmazonDetectiveAsync

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.

Specified by:

rejectInvitationAsync in interface AmazonDetectiveAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the RejectInvitation operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonDetective

Overrides:

shutdown in class AmazonWebServiceClient