@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonDetectiveAsyncClient extends AmazonDetectiveClient implements AmazonDetectiveAsync
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
acceptInvitation, builder, createGraph, createMembers, deleteGraph, deleteMembers, disassociateMembership, getCachedResponseMetadata, getMembers, listGraphs, listInvitations, listMembers, rejectInvitation
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
acceptInvitation, createGraph, createMembers, deleteGraph, deleteMembers, disassociateMembership, getCachedResponseMetadata, getMembers, listGraphs, listInvitations, listMembers, rejectInvitation
public static AmazonDetectiveAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AcceptInvitationResult> acceptInvitationAsync(AcceptInvitationRequest request)
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
.
acceptInvitationAsync
in interface AmazonDetectiveAsync
public Future<AcceptInvitationResult> acceptInvitationAsync(AcceptInvitationRequest request, AsyncHandler<AcceptInvitationRequest,AcceptInvitationResult> asyncHandler)
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
.
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.public Future<CreateGraphResult> createGraphAsync(CreateGraphRequest request)
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.
createGraphAsync
in interface AmazonDetectiveAsync
public Future<CreateGraphResult> createGraphAsync(CreateGraphRequest request, AsyncHandler<CreateGraphRequest,CreateGraphResult> asyncHandler)
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.
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.public Future<CreateMembersResult> createMembersAsync(CreateMembersRequest request)
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.
createMembersAsync
in interface AmazonDetectiveAsync
public Future<CreateMembersResult> createMembersAsync(CreateMembersRequest request, AsyncHandler<CreateMembersRequest,CreateMembersResult> asyncHandler)
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.
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.public Future<DeleteGraphResult> deleteGraphAsync(DeleteGraphRequest request)
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.
deleteGraphAsync
in interface AmazonDetectiveAsync
public Future<DeleteGraphResult> deleteGraphAsync(DeleteGraphRequest request, AsyncHandler<DeleteGraphRequest,DeleteGraphResult> asyncHandler)
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.
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.public Future<DeleteMembersResult> deleteMembersAsync(DeleteMembersRequest request)
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.
deleteMembersAsync
in interface AmazonDetectiveAsync
public Future<DeleteMembersResult> deleteMembersAsync(DeleteMembersRequest request, AsyncHandler<DeleteMembersRequest,DeleteMembersResult> asyncHandler)
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.
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.public Future<DisassociateMembershipResult> disassociateMembershipAsync(DisassociateMembershipRequest request)
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.
disassociateMembershipAsync
in interface AmazonDetectiveAsync
public Future<DisassociateMembershipResult> disassociateMembershipAsync(DisassociateMembershipRequest request, AsyncHandler<DisassociateMembershipRequest,DisassociateMembershipResult> asyncHandler)
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.
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.public Future<GetMembersResult> getMembersAsync(GetMembersRequest request)
AmazonDetectiveAsync
Amazon Detective is currently in preview.
Returns the membership details for specified member accounts for a behavior graph.
getMembersAsync
in interface AmazonDetectiveAsync
public Future<GetMembersResult> getMembersAsync(GetMembersRequest request, AsyncHandler<GetMembersRequest,GetMembersResult> asyncHandler)
AmazonDetectiveAsync
Amazon Detective is currently in preview.
Returns the membership details for specified member accounts for a behavior graph.
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.public Future<ListGraphsResult> listGraphsAsync(ListGraphsRequest request)
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.
listGraphsAsync
in interface AmazonDetectiveAsync
public Future<ListGraphsResult> listGraphsAsync(ListGraphsRequest request, AsyncHandler<ListGraphsRequest,ListGraphsResult> asyncHandler)
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.
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.public Future<ListInvitationsResult> listInvitationsAsync(ListInvitationsRequest request)
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.
listInvitationsAsync
in interface AmazonDetectiveAsync
public Future<ListInvitationsResult> listInvitationsAsync(ListInvitationsRequest request, AsyncHandler<ListInvitationsRequest,ListInvitationsResult> asyncHandler)
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.
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.public Future<ListMembersResult> listMembersAsync(ListMembersRequest request)
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.
listMembersAsync
in interface AmazonDetectiveAsync
public Future<ListMembersResult> listMembersAsync(ListMembersRequest request, AsyncHandler<ListMembersRequest,ListMembersResult> asyncHandler)
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.
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.public Future<RejectInvitationResult> rejectInvitationAsync(RejectInvitationRequest request)
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.
rejectInvitationAsync
in interface AmazonDetectiveAsync
public Future<RejectInvitationResult> rejectInvitationAsync(RejectInvitationRequest request, AsyncHandler<RejectInvitationRequest,RejectInvitationResult> asyncHandler)
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.
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonDetective
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.