@Generated(value="software.amazon.awssdk:codegen") public interface DetectiveAsyncClient extends SdkClient
builder()
method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AcceptInvitationResponse> |
acceptInvitation(AcceptInvitationRequest acceptInvitationRequest)
Accepts an invitation for the member account to contribute data to a behavior graph.
|
default CompletableFuture<AcceptInvitationResponse> |
acceptInvitation(Consumer<AcceptInvitationRequest.Builder> acceptInvitationRequest)
Accepts an invitation for the member account to contribute data to a behavior graph.
|
static DetectiveAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DetectiveAsyncClient. |
static DetectiveAsyncClient |
create()
Create a
DetectiveAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateGraphResponse> |
createGraph(Consumer<CreateGraphRequest.Builder> createGraphRequest)
Creates a new behavior graph for the calling account, and sets that account as the master account.
|
default CompletableFuture<CreateGraphResponse> |
createGraph(CreateGraphRequest createGraphRequest)
Creates a new behavior graph for the calling account, and sets that account as the master account.
|
default CompletableFuture<CreateMembersResponse> |
createMembers(Consumer<CreateMembersRequest.Builder> createMembersRequest)
Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph.
|
default CompletableFuture<CreateMembersResponse> |
createMembers(CreateMembersRequest createMembersRequest)
Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph.
|
default CompletableFuture<DeleteGraphResponse> |
deleteGraph(Consumer<DeleteGraphRequest.Builder> deleteGraphRequest)
Disables the specified behavior graph and queues it to be deleted.
|
default CompletableFuture<DeleteGraphResponse> |
deleteGraph(DeleteGraphRequest deleteGraphRequest)
Disables the specified behavior graph and queues it to be deleted.
|
default CompletableFuture<DeleteMembersResponse> |
deleteMembers(Consumer<DeleteMembersRequest.Builder> deleteMembersRequest)
Deletes one or more member accounts from the master account behavior graph.
|
default CompletableFuture<DeleteMembersResponse> |
deleteMembers(DeleteMembersRequest deleteMembersRequest)
Deletes one or more member accounts from the master account behavior graph.
|
default CompletableFuture<DisassociateMembershipResponse> |
disassociateMembership(Consumer<DisassociateMembershipRequest.Builder> disassociateMembershipRequest)
Removes the member account from the specified behavior graph.
|
default CompletableFuture<DisassociateMembershipResponse> |
disassociateMembership(DisassociateMembershipRequest disassociateMembershipRequest)
Removes the member account from the specified behavior graph.
|
default CompletableFuture<GetMembersResponse> |
getMembers(Consumer<GetMembersRequest.Builder> getMembersRequest)
Returns the membership details for specified member accounts for a behavior graph.
|
default CompletableFuture<GetMembersResponse> |
getMembers(GetMembersRequest getMembersRequest)
Returns the membership details for specified member accounts for a behavior graph.
|
default CompletableFuture<ListGraphsResponse> |
listGraphs(Consumer<ListGraphsRequest.Builder> listGraphsRequest)
Returns the list of behavior graphs that the calling account is a master of.
|
default CompletableFuture<ListGraphsResponse> |
listGraphs(ListGraphsRequest listGraphsRequest)
Returns the list of behavior graphs that the calling account is a master of.
|
default ListGraphsPublisher |
listGraphsPaginator(Consumer<ListGraphsRequest.Builder> listGraphsRequest)
Returns the list of behavior graphs that the calling account is a master of.
|
default ListGraphsPublisher |
listGraphsPaginator(ListGraphsRequest listGraphsRequest)
Returns the list of behavior graphs that the calling account is a master of.
|
default CompletableFuture<ListInvitationsResponse> |
listInvitations(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest)
Retrieves the list of open and accepted behavior graph invitations for the member account.
|
default CompletableFuture<ListInvitationsResponse> |
listInvitations(ListInvitationsRequest listInvitationsRequest)
Retrieves the list of open and accepted behavior graph invitations for the member account.
|
default ListInvitationsPublisher |
listInvitationsPaginator(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest)
Retrieves the list of open and accepted behavior graph invitations for the member account.
|
default ListInvitationsPublisher |
listInvitationsPaginator(ListInvitationsRequest listInvitationsRequest)
Retrieves the list of open and accepted behavior graph invitations for the member account.
|
default CompletableFuture<ListMembersResponse> |
listMembers(Consumer<ListMembersRequest.Builder> listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
|
default CompletableFuture<ListMembersResponse> |
listMembers(ListMembersRequest listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
|
default ListMembersPublisher |
listMembersPaginator(Consumer<ListMembersRequest.Builder> listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
|
default ListMembersPublisher |
listMembersPaginator(ListMembersRequest listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
|
default CompletableFuture<RejectInvitationResponse> |
rejectInvitation(Consumer<RejectInvitationRequest.Builder> rejectInvitationRequest)
Rejects an invitation to contribute the account data to a behavior graph.
|
default CompletableFuture<RejectInvitationResponse> |
rejectInvitation(RejectInvitationRequest rejectInvitationRequest)
Rejects an invitation to contribute the account data to a behavior graph.
|
default CompletableFuture<StartMonitoringMemberResponse> |
startMonitoringMember(Consumer<StartMonitoringMemberRequest.Builder> startMonitoringMemberRequest)
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED. |
default CompletableFuture<StartMonitoringMemberResponse> |
startMonitoringMember(StartMonitoringMemberRequest startMonitoringMemberRequest)
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED. |
serviceNameclosestatic final String SERVICE_NAME
static DetectiveAsyncClient create()
DetectiveAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DetectiveAsyncClientBuilder builder()
DetectiveAsyncClient.default CompletableFuture<AcceptInvitationResponse> acceptInvitation(AcceptInvitationRequest acceptInvitationRequest)
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.
acceptInvitationRequest - default CompletableFuture<AcceptInvitationResponse> acceptInvitation(Consumer<AcceptInvitationRequest.Builder> acceptInvitationRequest)
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.
This is a convenience which creates an instance of the AcceptInvitationRequest.Builder avoiding the need
to create one manually via AcceptInvitationRequest.builder()
acceptInvitationRequest - A Consumer that will call methods on AcceptInvitationRequest.Builder to create a request.default CompletableFuture<CreateGraphResponse> createGraph(CreateGraphRequest createGraphRequest)
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.
createGraphRequest - The 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.
The request would cause the data rate for the behavior graph to exceed the maximum allowed.
Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
default CompletableFuture<CreateGraphResponse> createGraph(Consumer<CreateGraphRequest.Builder> createGraphRequest)
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.
This is a convenience which creates an instance of the CreateGraphRequest.Builder avoiding the need to
create one manually via CreateGraphRequest.builder()
createGraphRequest - A Consumer that will call methods on CreateGraphRequest.Builder to create a request.The 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.
The request would cause the data rate for the behavior graph to exceed the maximum allowed.
Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
default CompletableFuture<CreateMembersResponse> createMembers(CreateMembersRequest createMembersRequest)
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.
createMembersRequest - The 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.
The request would cause the data rate for the behavior graph to exceed the maximum allowed.
Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
default CompletableFuture<CreateMembersResponse> createMembers(Consumer<CreateMembersRequest.Builder> createMembersRequest)
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.
This is a convenience which creates an instance of the CreateMembersRequest.Builder avoiding the need to
create one manually via CreateMembersRequest.builder()
createMembersRequest - A Consumer that will call methods on CreateMembersRequest.Builder to create a request.The 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.
The request would cause the data rate for the behavior graph to exceed the maximum allowed.
Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
default CompletableFuture<DeleteGraphResponse> deleteGraph(DeleteGraphRequest deleteGraphRequest)
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.
deleteGraphRequest - default CompletableFuture<DeleteGraphResponse> deleteGraph(Consumer<DeleteGraphRequest.Builder> deleteGraphRequest)
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.
This is a convenience which creates an instance of the DeleteGraphRequest.Builder avoiding the need to
create one manually via DeleteGraphRequest.builder()
deleteGraphRequest - A Consumer that will call methods on DeleteGraphRequest.Builder to create a request.default CompletableFuture<DeleteMembersResponse> deleteMembers(DeleteMembersRequest deleteMembersRequest)
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.
deleteMembersRequest - default CompletableFuture<DeleteMembersResponse> deleteMembers(Consumer<DeleteMembersRequest.Builder> deleteMembersRequest)
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.
This is a convenience which creates an instance of the DeleteMembersRequest.Builder avoiding the need to
create one manually via DeleteMembersRequest.builder()
deleteMembersRequest - A Consumer that will call methods on DeleteMembersRequest.Builder to create a request.default CompletableFuture<DisassociateMembershipResponse> disassociateMembership(DisassociateMembershipRequest disassociateMembershipRequest)
Removes the member account from the specified behavior graph. This operation can only be called by a member
account that has the ENABLED status.
disassociateMembershipRequest - default CompletableFuture<DisassociateMembershipResponse> disassociateMembership(Consumer<DisassociateMembershipRequest.Builder> disassociateMembershipRequest)
Removes the member account from the specified behavior graph. This operation can only be called by a member
account that has the ENABLED status.
This is a convenience which creates an instance of the DisassociateMembershipRequest.Builder avoiding the
need to create one manually via DisassociateMembershipRequest.builder()
disassociateMembershipRequest - A Consumer that will call methods on DisassociateMembershipRequest.Builder to create a
request.default CompletableFuture<GetMembersResponse> getMembers(GetMembersRequest getMembersRequest)
Returns the membership details for specified member accounts for a behavior graph.
getMembersRequest - default CompletableFuture<GetMembersResponse> getMembers(Consumer<GetMembersRequest.Builder> getMembersRequest)
Returns the membership details for specified member accounts for a behavior graph.
This is a convenience which creates an instance of the GetMembersRequest.Builder avoiding the need to
create one manually via GetMembersRequest.builder()
getMembersRequest - A Consumer that will call methods on GetMembersRequest.Builder to create a request.default CompletableFuture<ListGraphsResponse> listGraphs(ListGraphsRequest listGraphsRequest)
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.
listGraphsRequest - default CompletableFuture<ListGraphsResponse> listGraphs(Consumer<ListGraphsRequest.Builder> listGraphsRequest)
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.
This is a convenience which creates an instance of the ListGraphsRequest.Builder avoiding the need to
create one manually via ListGraphsRequest.builder()
listGraphsRequest - A Consumer that will call methods on ListGraphsRequest.Builder to create a request.default ListGraphsPublisher listGraphsPaginator(ListGraphsRequest listGraphsRequest)
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.
This is a variant of listGraphs(software.amazon.awssdk.services.detective.model.ListGraphsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.detective.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.detective.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListGraphsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.detective.model.ListGraphsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGraphs(software.amazon.awssdk.services.detective.model.ListGraphsRequest) operation.
listGraphsRequest - default ListGraphsPublisher listGraphsPaginator(Consumer<ListGraphsRequest.Builder> listGraphsRequest)
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.
This is a variant of listGraphs(software.amazon.awssdk.services.detective.model.ListGraphsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.detective.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.detective.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListGraphsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.detective.model.ListGraphsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGraphs(software.amazon.awssdk.services.detective.model.ListGraphsRequest) operation.
This is a convenience which creates an instance of the ListGraphsRequest.Builder avoiding the need to
create one manually via ListGraphsRequest.builder()
listGraphsRequest - A Consumer that will call methods on ListGraphsRequest.Builder to create a request.default CompletableFuture<ListInvitationsResponse> listInvitations(ListInvitationsRequest listInvitationsRequest)
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.
listInvitationsRequest - default CompletableFuture<ListInvitationsResponse> listInvitations(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest)
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.
This is a convenience which creates an instance of the ListInvitationsRequest.Builder avoiding the need
to create one manually via ListInvitationsRequest.builder()
listInvitationsRequest - A Consumer that will call methods on ListInvitationsRequest.Builder to create a request.default ListInvitationsPublisher listInvitationsPaginator(ListInvitationsRequest listInvitationsRequest)
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.
This is a variant of
listInvitations(software.amazon.awssdk.services.detective.model.ListInvitationsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.detective.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.detective.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListInvitationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.detective.model.ListInvitationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInvitations(software.amazon.awssdk.services.detective.model.ListInvitationsRequest) operation.
listInvitationsRequest - default ListInvitationsPublisher listInvitationsPaginator(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest)
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.
This is a variant of
listInvitations(software.amazon.awssdk.services.detective.model.ListInvitationsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.detective.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.detective.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListInvitationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.detective.model.ListInvitationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInvitations(software.amazon.awssdk.services.detective.model.ListInvitationsRequest) operation.
This is a convenience which creates an instance of the ListInvitationsRequest.Builder avoiding the need
to create one manually via ListInvitationsRequest.builder()
listInvitationsRequest - A Consumer that will call methods on ListInvitationsRequest.Builder to create a request.default CompletableFuture<ListMembersResponse> listMembers(ListMembersRequest listMembersRequest)
Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
listMembersRequest - default CompletableFuture<ListMembersResponse> listMembers(Consumer<ListMembersRequest.Builder> listMembersRequest)
Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
This is a convenience which creates an instance of the ListMembersRequest.Builder avoiding the need to
create one manually via ListMembersRequest.builder()
listMembersRequest - A Consumer that will call methods on ListMembersRequest.Builder to create a request.default ListMembersPublisher listMembersPaginator(ListMembersRequest listMembersRequest)
Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
This is a variant of listMembers(software.amazon.awssdk.services.detective.model.ListMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.detective.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.detective.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListMembersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.detective.model.ListMembersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMembers(software.amazon.awssdk.services.detective.model.ListMembersRequest) operation.
listMembersRequest - default ListMembersPublisher listMembersPaginator(Consumer<ListMembersRequest.Builder> listMembersRequest)
Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
This is a variant of listMembers(software.amazon.awssdk.services.detective.model.ListMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.detective.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.detective.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListMembersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.detective.model.ListMembersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMembers(software.amazon.awssdk.services.detective.model.ListMembersRequest) operation.
This is a convenience which creates an instance of the ListMembersRequest.Builder avoiding the need to
create one manually via ListMembersRequest.builder()
listMembersRequest - A Consumer that will call methods on ListMembersRequest.Builder to create a request.default CompletableFuture<RejectInvitationResponse> rejectInvitation(RejectInvitationRequest rejectInvitationRequest)
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.
rejectInvitationRequest - default CompletableFuture<RejectInvitationResponse> rejectInvitation(Consumer<RejectInvitationRequest.Builder> rejectInvitationRequest)
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.
This is a convenience which creates an instance of the RejectInvitationRequest.Builder avoiding the need
to create one manually via RejectInvitationRequest.builder()
rejectInvitationRequest - A Consumer that will call methods on RejectInvitationRequest.Builder to create a request.default CompletableFuture<StartMonitoringMemberResponse> startMonitoringMember(StartMonitoringMemberRequest startMonitoringMemberRequest)
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.
startMonitoringMemberRequest - The 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.
The request would cause the data rate for the behavior graph to exceed the maximum allowed.
Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
default CompletableFuture<StartMonitoringMemberResponse> startMonitoringMember(Consumer<StartMonitoringMemberRequest.Builder> startMonitoringMemberRequest)
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.
This is a convenience which creates an instance of the StartMonitoringMemberRequest.Builder avoiding the
need to create one manually via StartMonitoringMemberRequest.builder()
startMonitoringMemberRequest - A Consumer that will call methods on StartMonitoringMemberRequest.Builder to create a
request.The 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.
The request would cause the data rate for the behavior graph to exceed the maximum allowed.
Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
Copyright © 2020. All rights reserved.