Interface DetectiveAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface DetectiveAsyncClient extends AwsClient
Service client for accessing Amazon Detective asynchronously. This can be created using the staticbuilder()method.Detective uses machine learning and purpose-built visualizations to help you to analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from 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 an administrator account.
To add a member account to the behavior graph, the administrator account sends an invitation to the account. When the account accepts the invitation, it becomes a member account in the behavior graph.
Detective is also integrated with Organizations. The organization management account designates the Detective administrator account for the organization. That account becomes the administrator account for the organization behavior graph. The Detective administrator account is also the delegated administrator account for Detective in Organizations.
The Detective administrator account can enable any organization account as a member account in the organization behavior graph. The organization accounts do not receive invitations. The Detective administrator account can also invite other accounts to the organization behavior graph.
Every behavior graph is specific to a Region. You can only use the API to manage behavior graphs that belong to the Region that is associated with the currently selected endpoint.
The administrator account for a behavior graph 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.
-
Apply tags to a behavior graph.
The organization management account can use the Detective API to select the delegated administrator for Detective.
The Detective administrator account for an organization can use the Detective API to do the following:
-
Perform all of the functions of an administrator account.
-
Determine whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
An invited 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.
We replaced the term "master account" with the term "administrator account." An administrator account is used to centrally manage multiple accounts. In the case of Detective, the administrator account manages the accounts in their behavior graph.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptInvitation
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.- Parameters:
acceptInvitationRequest-- Returns:
- A Java Future containing the result of the AcceptInvitation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
acceptInvitation
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.Builderavoiding the need to create one manually viaAcceptInvitationRequest.builder()- Parameters:
acceptInvitationRequest- AConsumerthat will call methods onAcceptInvitationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AcceptInvitation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchGetGraphMemberDatasources
default CompletableFuture<BatchGetGraphMemberDatasourcesResponse> batchGetGraphMemberDatasources(BatchGetGraphMemberDatasourcesRequest batchGetGraphMemberDatasourcesRequest)
Gets data source package information for the behavior graph.
- Parameters:
batchGetGraphMemberDatasourcesRequest-- Returns:
- A Java Future containing the result of the BatchGetGraphMemberDatasources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchGetGraphMemberDatasources
default CompletableFuture<BatchGetGraphMemberDatasourcesResponse> batchGetGraphMemberDatasources(Consumer<BatchGetGraphMemberDatasourcesRequest.Builder> batchGetGraphMemberDatasourcesRequest)
Gets data source package information for the behavior graph.
This is a convenience which creates an instance of the
BatchGetGraphMemberDatasourcesRequest.Builderavoiding the need to create one manually viaBatchGetGraphMemberDatasourcesRequest.builder()- Parameters:
batchGetGraphMemberDatasourcesRequest- AConsumerthat will call methods onBatchGetGraphMemberDatasourcesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchGetGraphMemberDatasources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchGetMembershipDatasources
default CompletableFuture<BatchGetMembershipDatasourcesResponse> batchGetMembershipDatasources(BatchGetMembershipDatasourcesRequest batchGetMembershipDatasourcesRequest)
Gets information on the data source package history for an account.
- Parameters:
batchGetMembershipDatasourcesRequest-- Returns:
- A Java Future containing the result of the BatchGetMembershipDatasources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchGetMembershipDatasources
default CompletableFuture<BatchGetMembershipDatasourcesResponse> batchGetMembershipDatasources(Consumer<BatchGetMembershipDatasourcesRequest.Builder> batchGetMembershipDatasourcesRequest)
Gets information on the data source package history for an account.
This is a convenience which creates an instance of the
BatchGetMembershipDatasourcesRequest.Builderavoiding the need to create one manually viaBatchGetMembershipDatasourcesRequest.builder()- Parameters:
batchGetMembershipDatasourcesRequest- AConsumerthat will call methods onBatchGetMembershipDatasourcesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchGetMembershipDatasources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createGraph
default CompletableFuture<CreateGraphResponse> createGraph(CreateGraphRequest createGraphRequest)
Creates a new behavior graph for the calling account, and sets that account as the administrator 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.
CreateGraphtriggers a process to create the corresponding data tables for the new behavior graph.An account can only be the administrator account for one behavior graph within a Region. If the same account calls
CreateGraphwith the same administrator account, it always returns the same behavior graph ARN. It does not create a new behavior graph.- Parameters:
createGraphRequest-- Returns:
- A Java Future containing the result of the CreateGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- ConflictException The request attempted an invalid action.
- InternalServerException The request was valid but failed because of a problem with the service.
- ServiceQuotaExceededException This request cannot be completed for one of the following reasons.
-
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 1200 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.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createGraph
default CompletableFuture<CreateGraphResponse> createGraph(Consumer<CreateGraphRequest.Builder> createGraphRequest)
Creates a new behavior graph for the calling account, and sets that account as the administrator 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.
CreateGraphtriggers a process to create the corresponding data tables for the new behavior graph.An account can only be the administrator account for one behavior graph within a Region. If the same account calls
CreateGraphwith the same administrator 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.Builderavoiding the need to create one manually viaCreateGraphRequest.builder()- Parameters:
createGraphRequest- AConsumerthat will call methods onCreateGraphRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- ConflictException The request attempted an invalid action.
- InternalServerException The request was valid but failed because of a problem with the service.
- ServiceQuotaExceededException This request cannot be completed for one of the following reasons.
-
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 1200 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.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createMembers
default CompletableFuture<CreateMembersResponse> createMembers(CreateMembersRequest createMembersRequest)
CreateMembersis used to send invitations to accounts. For the organization behavior graph, the Detective administrator account usesCreateMembersto enable organization accounts as member accounts.For invited accounts,
CreateMemberssends a request to invite the specified Amazon Web Services accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph.CreateMembersverifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally.For organization accounts in the organization behavior graph,
CreateMembersattempts to enable the accounts. The organization accounts do not receive invitations.The request provides the behavior graph ARN and the list of accounts to invite or to enable.
The response separates the requested accounts into two lists:
-
The accounts that
CreateMemberswas able to process. For invited accounts, includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification. For organization accounts in the organization behavior graph, includes accounts that can be enabled and that cannot be enabled. -
The accounts that
CreateMemberswas unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.
- Parameters:
createMembersRequest-- Returns:
- A Java Future containing the result of the CreateMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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 cannot be completed for one of the following reasons.
-
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 1200 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.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
createMembers
default CompletableFuture<CreateMembersResponse> createMembers(Consumer<CreateMembersRequest.Builder> createMembersRequest)
CreateMembersis used to send invitations to accounts. For the organization behavior graph, the Detective administrator account usesCreateMembersto enable organization accounts as member accounts.For invited accounts,
CreateMemberssends a request to invite the specified Amazon Web Services accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph.CreateMembersverifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally.For organization accounts in the organization behavior graph,
CreateMembersattempts to enable the accounts. The organization accounts do not receive invitations.The request provides the behavior graph ARN and the list of accounts to invite or to enable.
The response separates the requested accounts into two lists:
-
The accounts that
CreateMemberswas able to process. For invited accounts, includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification. For organization accounts in the organization behavior graph, includes accounts that can be enabled and that cannot be enabled. -
The accounts that
CreateMemberswas 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.Builderavoiding the need to create one manually viaCreateMembersRequest.builder()- Parameters:
createMembersRequest- AConsumerthat will call methods onCreateMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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 cannot be completed for one of the following reasons.
-
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 1200 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.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
deleteGraph
default CompletableFuture<DeleteGraphResponse> deleteGraph(DeleteGraphRequest deleteGraphRequest)
Disables the specified behavior graph and queues it to be deleted. This operation removes the behavior graph from each member account's list of behavior graphs.
DeleteGraphcan only be called by the administrator account for a behavior graph.- Parameters:
deleteGraphRequest-- Returns:
- A Java Future containing the result of the DeleteGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteGraph
default CompletableFuture<DeleteGraphResponse> deleteGraph(Consumer<DeleteGraphRequest.Builder> deleteGraphRequest)
Disables the specified behavior graph and queues it to be deleted. This operation removes the behavior graph from each member account's list of behavior graphs.
DeleteGraphcan only be called by the administrator account for a behavior graph.
This is a convenience which creates an instance of the
DeleteGraphRequest.Builderavoiding the need to create one manually viaDeleteGraphRequest.builder()- Parameters:
deleteGraphRequest- AConsumerthat will call methods onDeleteGraphRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteMembers
default CompletableFuture<DeleteMembersResponse> deleteMembers(DeleteMembersRequest deleteMembersRequest)
Removes the specified member accounts from the behavior graph. The removed accounts no longer contribute data to the behavior graph. This operation can only be called by the administrator account for the behavior graph.
For invited accounts, the removed accounts are deleted from the list of accounts in the behavior graph. To restore the account, the administrator account must send another invitation.
For organization accounts in the organization behavior graph, the Detective administrator account can always enable the organization account again. Organization accounts that are not enabled as member accounts are not included in the
ListMembersresults for the organization behavior graph.An administrator account cannot use
DeleteMembersto remove their own account from the behavior graph. To disable a behavior graph, the administrator account uses theDeleteGraphAPI method.- Parameters:
deleteMembersRequest-- Returns:
- A Java Future containing the result of the DeleteMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteMembers
default CompletableFuture<DeleteMembersResponse> deleteMembers(Consumer<DeleteMembersRequest.Builder> deleteMembersRequest)
Removes the specified member accounts from the behavior graph. The removed accounts no longer contribute data to the behavior graph. This operation can only be called by the administrator account for the behavior graph.
For invited accounts, the removed accounts are deleted from the list of accounts in the behavior graph. To restore the account, the administrator account must send another invitation.
For organization accounts in the organization behavior graph, the Detective administrator account can always enable the organization account again. Organization accounts that are not enabled as member accounts are not included in the
ListMembersresults for the organization behavior graph.An administrator account cannot use
DeleteMembersto remove their own account from the behavior graph. To disable a behavior graph, the administrator account uses theDeleteGraphAPI method.
This is a convenience which creates an instance of the
DeleteMembersRequest.Builderavoiding the need to create one manually viaDeleteMembersRequest.builder()- Parameters:
deleteMembersRequest- AConsumerthat will call methods onDeleteMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeOrganizationConfiguration
default CompletableFuture<DescribeOrganizationConfigurationResponse> describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest)
Returns information about the configuration for the organization behavior graph. Currently indicates whether to automatically enable new organization accounts as member accounts.
Can only be called by the Detective administrator account for the organization.
- Parameters:
describeOrganizationConfigurationRequest-- Returns:
- A Java Future containing the result of the DescribeOrganizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeOrganizationConfiguration
default CompletableFuture<DescribeOrganizationConfigurationResponse> describeOrganizationConfiguration(Consumer<DescribeOrganizationConfigurationRequest.Builder> describeOrganizationConfigurationRequest)
Returns information about the configuration for the organization behavior graph. Currently indicates whether to automatically enable new organization accounts as member accounts.
Can only be called by the Detective administrator account for the organization.
This is a convenience which creates an instance of the
DescribeOrganizationConfigurationRequest.Builderavoiding the need to create one manually viaDescribeOrganizationConfigurationRequest.builder()- Parameters:
describeOrganizationConfigurationRequest- AConsumerthat will call methods onDescribeOrganizationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeOrganizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
disableOrganizationAdminAccount
default CompletableFuture<DisableOrganizationAdminAccountResponse> disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest)
Removes the Detective administrator account in the current Region. Deletes the organization behavior graph.
Can only be called by the organization management account.
Removing the Detective administrator account does not affect the delegated administrator account for Detective in Organizations.
To remove the delegated administrator account in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective administrator account in all Regions, except for Regions where the Detective administrator account is the organization management account.
- Parameters:
disableOrganizationAdminAccountRequest-- Returns:
- A Java Future containing the result of the DisableOrganizationAdminAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
disableOrganizationAdminAccount
default CompletableFuture<DisableOrganizationAdminAccountResponse> disableOrganizationAdminAccount(Consumer<DisableOrganizationAdminAccountRequest.Builder> disableOrganizationAdminAccountRequest)
Removes the Detective administrator account in the current Region. Deletes the organization behavior graph.
Can only be called by the organization management account.
Removing the Detective administrator account does not affect the delegated administrator account for Detective in Organizations.
To remove the delegated administrator account in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective administrator account in all Regions, except for Regions where the Detective administrator account is the organization management account.
This is a convenience which creates an instance of the
DisableOrganizationAdminAccountRequest.Builderavoiding the need to create one manually viaDisableOrganizationAdminAccountRequest.builder()- Parameters:
disableOrganizationAdminAccountRequest- AConsumerthat will call methods onDisableOrganizationAdminAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisableOrganizationAdminAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
disassociateMembership
default CompletableFuture<DisassociateMembershipResponse> disassociateMembership(DisassociateMembershipRequest disassociateMembershipRequest)
Removes the member account from the specified behavior graph. This operation can only be called by an invited member account that has the
ENABLEDstatus.DisassociateMembershipcannot be called by an organization account in the organization behavior graph. For the organization behavior graph, the Detective administrator account determines which organization accounts to enable or disable as member accounts.- Parameters:
disassociateMembershipRequest-- Returns:
- A Java Future containing the result of the DisassociateMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
disassociateMembership
default CompletableFuture<DisassociateMembershipResponse> disassociateMembership(Consumer<DisassociateMembershipRequest.Builder> disassociateMembershipRequest)
Removes the member account from the specified behavior graph. This operation can only be called by an invited member account that has the
ENABLEDstatus.DisassociateMembershipcannot be called by an organization account in the organization behavior graph. For the organization behavior graph, the Detective administrator account determines which organization accounts to enable or disable as member accounts.
This is a convenience which creates an instance of the
DisassociateMembershipRequest.Builderavoiding the need to create one manually viaDisassociateMembershipRequest.builder()- Parameters:
disassociateMembershipRequest- AConsumerthat will call methods onDisassociateMembershipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
enableOrganizationAdminAccount
default CompletableFuture<EnableOrganizationAdminAccountResponse> enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest)
Designates the Detective administrator account for the organization in the current Region.
If the account does not have Detective enabled, then enables Detective for that account and creates a new behavior graph.
Can only be called by the organization management account.
If the organization has a delegated administrator account in Organizations, then the Detective administrator account must be either the delegated administrator account or the organization management account.
If the organization does not have a delegated administrator account in Organizations, then you can choose any account in the organization. If you choose an account other than the organization management account, Detective calls Organizations to make that account the delegated administrator account for Detective. The organization management account cannot be the delegated administrator account.
- Parameters:
enableOrganizationAdminAccountRequest-- Returns:
- A Java Future containing the result of the EnableOrganizationAdminAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
enableOrganizationAdminAccount
default CompletableFuture<EnableOrganizationAdminAccountResponse> enableOrganizationAdminAccount(Consumer<EnableOrganizationAdminAccountRequest.Builder> enableOrganizationAdminAccountRequest)
Designates the Detective administrator account for the organization in the current Region.
If the account does not have Detective enabled, then enables Detective for that account and creates a new behavior graph.
Can only be called by the organization management account.
If the organization has a delegated administrator account in Organizations, then the Detective administrator account must be either the delegated administrator account or the organization management account.
If the organization does not have a delegated administrator account in Organizations, then you can choose any account in the organization. If you choose an account other than the organization management account, Detective calls Organizations to make that account the delegated administrator account for Detective. The organization management account cannot be the delegated administrator account.
This is a convenience which creates an instance of the
EnableOrganizationAdminAccountRequest.Builderavoiding the need to create one manually viaEnableOrganizationAdminAccountRequest.builder()- Parameters:
enableOrganizationAdminAccountRequest- AConsumerthat will call methods onEnableOrganizationAdminAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the EnableOrganizationAdminAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getInvestigation
default CompletableFuture<GetInvestigationResponse> getInvestigation(GetInvestigationRequest getInvestigationRequest)
Returns the investigation results of an investigation for a behavior graph.
- Parameters:
getInvestigationRequest-- Returns:
- A Java Future containing the result of the GetInvestigation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getInvestigation
default CompletableFuture<GetInvestigationResponse> getInvestigation(Consumer<GetInvestigationRequest.Builder> getInvestigationRequest)
Returns the investigation results of an investigation for a behavior graph.
This is a convenience which creates an instance of the
GetInvestigationRequest.Builderavoiding the need to create one manually viaGetInvestigationRequest.builder()- Parameters:
getInvestigationRequest- AConsumerthat will call methods onGetInvestigationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetInvestigation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getMembers
default CompletableFuture<GetMembersResponse> getMembers(GetMembersRequest getMembersRequest)
Returns the membership details for specified member accounts for a behavior graph.
- Parameters:
getMembersRequest-- Returns:
- A Java Future containing the result of the GetMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getMembers
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.Builderavoiding the need to create one manually viaGetMembersRequest.builder()- Parameters:
getMembersRequest- AConsumerthat will call methods onGetMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDatasourcePackages
default CompletableFuture<ListDatasourcePackagesResponse> listDatasourcePackages(ListDatasourcePackagesRequest listDatasourcePackagesRequest)
Lists data source packages in the behavior graph.
- Parameters:
listDatasourcePackagesRequest-- Returns:
- A Java Future containing the result of the ListDatasourcePackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDatasourcePackages
default CompletableFuture<ListDatasourcePackagesResponse> listDatasourcePackages(Consumer<ListDatasourcePackagesRequest.Builder> listDatasourcePackagesRequest)
Lists data source packages in the behavior graph.
This is a convenience which creates an instance of the
ListDatasourcePackagesRequest.Builderavoiding the need to create one manually viaListDatasourcePackagesRequest.builder()- Parameters:
listDatasourcePackagesRequest- AConsumerthat will call methods onListDatasourcePackagesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDatasourcePackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDatasourcePackagesPaginator
default ListDatasourcePackagesPublisher listDatasourcePackagesPaginator(ListDatasourcePackagesRequest listDatasourcePackagesRequest)
This is a variant of
listDatasourcePackages(software.amazon.awssdk.services.detective.model.ListDatasourcePackagesRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesPublisher publisher = client.listDatasourcePackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesPublisher publisher = client.listDatasourcePackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListDatasourcePackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.detective.model.ListDatasourcePackagesResponse response) { //... }; });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
listDatasourcePackages(software.amazon.awssdk.services.detective.model.ListDatasourcePackagesRequest)operation.- Parameters:
listDatasourcePackagesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDatasourcePackagesPaginator
default ListDatasourcePackagesPublisher listDatasourcePackagesPaginator(Consumer<ListDatasourcePackagesRequest.Builder> listDatasourcePackagesRequest)
This is a variant of
listDatasourcePackages(software.amazon.awssdk.services.detective.model.ListDatasourcePackagesRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesPublisher publisher = client.listDatasourcePackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesPublisher publisher = client.listDatasourcePackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListDatasourcePackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.detective.model.ListDatasourcePackagesResponse response) { //... }; });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
listDatasourcePackages(software.amazon.awssdk.services.detective.model.ListDatasourcePackagesRequest)operation.
This is a convenience which creates an instance of the
ListDatasourcePackagesRequest.Builderavoiding the need to create one manually viaListDatasourcePackagesRequest.builder()- Parameters:
listDatasourcePackagesRequest- AConsumerthat will call methods onListDatasourcePackagesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGraphs
default CompletableFuture<ListGraphsResponse> listGraphs(ListGraphsRequest listGraphsRequest)
Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account.
Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph.
- Parameters:
listGraphsRequest-- Returns:
- A Java Future containing the result of the ListGraphs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGraphs
default CompletableFuture<ListGraphsResponse> listGraphs(Consumer<ListGraphsRequest.Builder> listGraphsRequest)
Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account.
Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph.
This is a convenience which creates an instance of the
ListGraphsRequest.Builderavoiding the need to create one manually viaListGraphsRequest.builder()- Parameters:
listGraphsRequest- AConsumerthat will call methods onListGraphsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListGraphs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGraphsPaginator
default ListGraphsPublisher listGraphsPaginator(ListGraphsRequest listGraphsRequest)
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listGraphsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGraphsPaginator
default ListGraphsPublisher listGraphsPaginator(Consumer<ListGraphsRequest.Builder> listGraphsRequest)
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListGraphsPublisher publisher = client.listGraphsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListGraphsRequest.builder()- Parameters:
listGraphsRequest- AConsumerthat will call methods onListGraphsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIndicators
default CompletableFuture<ListIndicatorsResponse> listIndicators(ListIndicatorsRequest listIndicatorsRequest)
Get the indicators from an investigation
- Parameters:
listIndicatorsRequest-- Returns:
- A Java Future containing the result of the ListIndicators operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIndicators
default CompletableFuture<ListIndicatorsResponse> listIndicators(Consumer<ListIndicatorsRequest.Builder> listIndicatorsRequest)
Get the indicators from an investigation
This is a convenience which creates an instance of the
ListIndicatorsRequest.Builderavoiding the need to create one manually viaListIndicatorsRequest.builder()- Parameters:
listIndicatorsRequest- AConsumerthat will call methods onListIndicatorsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIndicators operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listInvestigations
default CompletableFuture<ListInvestigationsResponse> listInvestigations(ListInvestigationsRequest listInvestigationsRequest)
List all Investigations.
- Parameters:
listInvestigationsRequest-- Returns:
- A Java Future containing the result of the ListInvestigations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listInvestigations
default CompletableFuture<ListInvestigationsResponse> listInvestigations(Consumer<ListInvestigationsRequest.Builder> listInvestigationsRequest)
List all Investigations.
This is a convenience which creates an instance of the
ListInvestigationsRequest.Builderavoiding the need to create one manually viaListInvestigationsRequest.builder()- Parameters:
listInvestigationsRequest- AConsumerthat will call methods onListInvestigationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListInvestigations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listInvitations
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 an invited 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:
- A Java Future containing the result of the ListInvitations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listInvitations
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 an invited 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.Builderavoiding the need to create one manually viaListInvitationsRequest.builder()- Parameters:
listInvitationsRequest- AConsumerthat will call methods onListInvitationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListInvitations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listInvitationsPaginator
default ListInvitationsPublisher listInvitationsPaginator(ListInvitationsRequest listInvitationsRequest)
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listInvitationsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listInvitationsPaginator
default ListInvitationsPublisher listInvitationsPaginator(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest)
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListInvitationsPublisher publisher = client.listInvitationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListInvitationsRequest.builder()- Parameters:
listInvitationsRequest- AConsumerthat will call methods onListInvitationsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listMembers
default CompletableFuture<ListMembersResponse> listMembers(ListMembersRequest listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
For invited accounts, the results do not include member accounts that were removed from the behavior graph.
For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts.
- Parameters:
listMembersRequest-- Returns:
- A Java Future containing the result of the ListMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listMembers
default CompletableFuture<ListMembersResponse> listMembers(Consumer<ListMembersRequest.Builder> listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
For invited accounts, the results do not include member accounts that were removed from the behavior graph.
For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts.
This is a convenience which creates an instance of the
ListMembersRequest.Builderavoiding the need to create one manually viaListMembersRequest.builder()- Parameters:
listMembersRequest- AConsumerthat will call methods onListMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listMembersPaginator
default ListMembersPublisher listMembersPaginator(ListMembersRequest listMembersRequest)
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listMembersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listMembersPaginator
default ListMembersPublisher listMembersPaginator(Consumer<ListMembersRequest.Builder> listMembersRequest)
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListMembersPublisher publisher = client.listMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListMembersRequest.builder()- Parameters:
listMembersRequest- AConsumerthat will call methods onListMembersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listOrganizationAdminAccounts
default CompletableFuture<ListOrganizationAdminAccountsResponse> listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest)
Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.
- Parameters:
listOrganizationAdminAccountsRequest-- Returns:
- A Java Future containing the result of the ListOrganizationAdminAccounts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listOrganizationAdminAccounts
default CompletableFuture<ListOrganizationAdminAccountsResponse> listOrganizationAdminAccounts(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest)
Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.
This is a convenience which creates an instance of the
ListOrganizationAdminAccountsRequest.Builderavoiding the need to create one manually viaListOrganizationAdminAccountsRequest.builder()- Parameters:
listOrganizationAdminAccountsRequest- AConsumerthat will call methods onListOrganizationAdminAccountsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListOrganizationAdminAccounts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listOrganizationAdminAccountsPaginator
default ListOrganizationAdminAccountsPublisher listOrganizationAdminAccountsPaginator(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest)
This is a variant of
listOrganizationAdminAccounts(software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsPublisher publisher = client.listOrganizationAdminAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsPublisher publisher = client.listOrganizationAdminAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsResponse response) { //... }; });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
listOrganizationAdminAccounts(software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsRequest)operation.- Parameters:
listOrganizationAdminAccountsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listOrganizationAdminAccountsPaginator
default ListOrganizationAdminAccountsPublisher listOrganizationAdminAccountsPaginator(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest)
This is a variant of
listOrganizationAdminAccounts(software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsPublisher publisher = client.listOrganizationAdminAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsPublisher publisher = client.listOrganizationAdminAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsResponse response) { //... }; });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
listOrganizationAdminAccounts(software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsRequest)operation.
This is a convenience which creates an instance of the
ListOrganizationAdminAccountsRequest.Builderavoiding the need to create one manually viaListOrganizationAdminAccountsRequest.builder()- Parameters:
listOrganizationAdminAccountsRequest- AConsumerthat will call methods onListOrganizationAdminAccountsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns the tag values that are assigned to a behavior graph.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns the tag values that are assigned to a behavior graph.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
rejectInvitation
default CompletableFuture<RejectInvitationResponse> rejectInvitation(RejectInvitationRequest rejectInvitationRequest)
Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by an invited member account that has the
INVITEDstatus.RejectInvitationcannot be called by an organization account in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation.- Parameters:
rejectInvitationRequest-- Returns:
- A Java Future containing the result of the RejectInvitation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
rejectInvitation
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 an invited member account that has the
INVITEDstatus.RejectInvitationcannot be called by an organization account in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation.
This is a convenience which creates an instance of the
RejectInvitationRequest.Builderavoiding the need to create one manually viaRejectInvitationRequest.builder()- Parameters:
rejectInvitationRequest- AConsumerthat will call methods onRejectInvitationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RejectInvitation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startInvestigation
default CompletableFuture<StartInvestigationResponse> startInvestigation(StartInvestigationRequest startInvestigationRequest)
initiate an investigation on an entity in a graph
- Parameters:
startInvestigationRequest-- Returns:
- A Java Future containing the result of the StartInvestigation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- ResourceNotFoundException The request refers to a nonexistent resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startInvestigation
default CompletableFuture<StartInvestigationResponse> startInvestigation(Consumer<StartInvestigationRequest.Builder> startInvestigationRequest)
initiate an investigation on an entity in a graph
This is a convenience which creates an instance of the
StartInvestigationRequest.Builderavoiding the need to create one manually viaStartInvestigationRequest.builder()- Parameters:
startInvestigationRequest- AConsumerthat will call methods onStartInvestigationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartInvestigation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- ResourceNotFoundException The request refers to a nonexistent resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startMonitoringMember
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.
- Parameters:
startMonitoringMemberRequest-- Returns:
- A Java Future containing the result of the StartMonitoringMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- ServiceQuotaExceededException This request cannot be completed for one of the following reasons.
-
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 1200 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.
-
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
startMonitoringMember
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.Builderavoiding the need to create one manually viaStartMonitoringMemberRequest.builder()- Parameters:
startMonitoringMemberRequest- AConsumerthat will call methods onStartMonitoringMemberRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartMonitoringMember operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- 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.
- ServiceQuotaExceededException This request cannot be completed for one of the following reasons.
-
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 1200 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.
-
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Applies tag values to a behavior graph.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies tag values to a behavior graph.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a behavior graph.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a behavior graph.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDatasourcePackages
default CompletableFuture<UpdateDatasourcePackagesResponse> updateDatasourcePackages(UpdateDatasourcePackagesRequest updateDatasourcePackagesRequest)
Starts a data source packages for the behavior graph.
- Parameters:
updateDatasourcePackagesRequest-- Returns:
- A Java Future containing the result of the UpdateDatasourcePackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ResourceNotFoundException The request refers to a nonexistent resource.
- ServiceQuotaExceededException This request cannot be completed for one of the following reasons.
-
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 1200 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.
-
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDatasourcePackages
default CompletableFuture<UpdateDatasourcePackagesResponse> updateDatasourcePackages(Consumer<UpdateDatasourcePackagesRequest.Builder> updateDatasourcePackagesRequest)
Starts a data source packages for the behavior graph.
This is a convenience which creates an instance of the
UpdateDatasourcePackagesRequest.Builderavoiding the need to create one manually viaUpdateDatasourcePackagesRequest.builder()- Parameters:
updateDatasourcePackagesRequest- AConsumerthat will call methods onUpdateDatasourcePackagesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDatasourcePackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ResourceNotFoundException The request refers to a nonexistent resource.
- ServiceQuotaExceededException This request cannot be completed for one of the following reasons.
-
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 1200 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.
-
- ValidationException The request parameters are invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateInvestigationState
default CompletableFuture<UpdateInvestigationStateResponse> updateInvestigationState(UpdateInvestigationStateRequest updateInvestigationStateRequest)
Update the state of an investigation.
- Parameters:
updateInvestigationStateRequest-- Returns:
- A Java Future containing the result of the UpdateInvestigationState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateInvestigationState
default CompletableFuture<UpdateInvestigationStateResponse> updateInvestigationState(Consumer<UpdateInvestigationStateRequest.Builder> updateInvestigationStateRequest)
Update the state of an investigation.
This is a convenience which creates an instance of the
UpdateInvestigationStateRequest.Builderavoiding the need to create one manually viaUpdateInvestigationStateRequest.builder()- Parameters:
updateInvestigationStateRequest- AConsumerthat will call methods onUpdateInvestigationStateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateInvestigationState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- ResourceNotFoundException The request refers to a nonexistent resource.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateOrganizationConfiguration
default CompletableFuture<UpdateOrganizationConfigurationResponse> updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest)
Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.
- Parameters:
updateOrganizationConfigurationRequest-- Returns:
- A Java Future containing the result of the UpdateOrganizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateOrganizationConfiguration
default CompletableFuture<UpdateOrganizationConfigurationResponse> updateOrganizationConfiguration(Consumer<UpdateOrganizationConfigurationRequest.Builder> updateOrganizationConfigurationRequest)
Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.
This is a convenience which creates an instance of the
UpdateOrganizationConfigurationRequest.Builderavoiding the need to create one manually viaUpdateOrganizationConfigurationRequest.builder()- Parameters:
updateOrganizationConfigurationRequest- AConsumerthat will call methods onUpdateOrganizationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateOrganizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException The request issuer does not have permission to access this resource or perform this operation.
- InternalServerException The request was valid but failed because of a problem with the service.
- ValidationException The request parameters are invalid.
- TooManyRequestsException The request cannot be completed because too many other requests are occurring at the same time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DetectiveException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default DetectiveServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static DetectiveAsyncClient create()
Create aDetectiveAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static DetectiveAsyncClientBuilder builder()
Create a builder that can be used to configure and create aDetectiveAsyncClient.
-
-