@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface DetectiveClient extends SdkClient
builder() 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AcceptInvitationResponse |
acceptInvitation(AcceptInvitationRequest acceptInvitationRequest)
Accepts an invitation for the member account to contribute data to a behavior graph.
|
default AcceptInvitationResponse |
acceptInvitation(Consumer<AcceptInvitationRequest.Builder> acceptInvitationRequest)
Accepts an invitation for the member account to contribute data to a behavior graph.
|
default BatchGetGraphMemberDatasourcesResponse |
batchGetGraphMemberDatasources(BatchGetGraphMemberDatasourcesRequest batchGetGraphMemberDatasourcesRequest)
Gets data source package information for the behavior graph.
|
default BatchGetGraphMemberDatasourcesResponse |
batchGetGraphMemberDatasources(Consumer<BatchGetGraphMemberDatasourcesRequest.Builder> batchGetGraphMemberDatasourcesRequest)
Gets data source package information for the behavior graph.
|
default BatchGetMembershipDatasourcesResponse |
batchGetMembershipDatasources(BatchGetMembershipDatasourcesRequest batchGetMembershipDatasourcesRequest)
Gets information on the data source package history for an account.
|
default BatchGetMembershipDatasourcesResponse |
batchGetMembershipDatasources(Consumer<BatchGetMembershipDatasourcesRequest.Builder> batchGetMembershipDatasourcesRequest)
Gets information on the data source package history for an account.
|
static DetectiveClientBuilder |
builder()
Create a builder that can be used to configure and create a
DetectiveClient. |
static DetectiveClient |
create()
Create a
DetectiveClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateGraphResponse |
createGraph(Consumer<CreateGraphRequest.Builder> createGraphRequest)
Creates a new behavior graph for the calling account, and sets that account as the administrator account.
|
default CreateGraphResponse |
createGraph(CreateGraphRequest createGraphRequest)
Creates a new behavior graph for the calling account, and sets that account as the administrator account.
|
default CreateMembersResponse |
createMembers(Consumer<CreateMembersRequest.Builder> createMembersRequest)
CreateMembers is used to send invitations to accounts. |
default CreateMembersResponse |
createMembers(CreateMembersRequest createMembersRequest)
CreateMembers is used to send invitations to accounts. |
default DeleteGraphResponse |
deleteGraph(Consumer<DeleteGraphRequest.Builder> deleteGraphRequest)
Disables the specified behavior graph and queues it to be deleted.
|
default DeleteGraphResponse |
deleteGraph(DeleteGraphRequest deleteGraphRequest)
Disables the specified behavior graph and queues it to be deleted.
|
default DeleteMembersResponse |
deleteMembers(Consumer<DeleteMembersRequest.Builder> deleteMembersRequest)
Removes the specified member accounts from the behavior graph.
|
default DeleteMembersResponse |
deleteMembers(DeleteMembersRequest deleteMembersRequest)
Removes the specified member accounts from the behavior graph.
|
default DescribeOrganizationConfigurationResponse |
describeOrganizationConfiguration(Consumer<DescribeOrganizationConfigurationRequest.Builder> describeOrganizationConfigurationRequest)
Returns information about the configuration for the organization behavior graph.
|
default DescribeOrganizationConfigurationResponse |
describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest)
Returns information about the configuration for the organization behavior graph.
|
default DisableOrganizationAdminAccountResponse |
disableOrganizationAdminAccount(Consumer<DisableOrganizationAdminAccountRequest.Builder> disableOrganizationAdminAccountRequest)
Removes the Detective administrator account in the current Region.
|
default DisableOrganizationAdminAccountResponse |
disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest)
Removes the Detective administrator account in the current Region.
|
default DisassociateMembershipResponse |
disassociateMembership(Consumer<DisassociateMembershipRequest.Builder> disassociateMembershipRequest)
Removes the member account from the specified behavior graph.
|
default DisassociateMembershipResponse |
disassociateMembership(DisassociateMembershipRequest disassociateMembershipRequest)
Removes the member account from the specified behavior graph.
|
default EnableOrganizationAdminAccountResponse |
enableOrganizationAdminAccount(Consumer<EnableOrganizationAdminAccountRequest.Builder> enableOrganizationAdminAccountRequest)
Designates the Detective administrator account for the organization in the current Region.
|
default EnableOrganizationAdminAccountResponse |
enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest)
Designates the Detective administrator account for the organization in the current Region.
|
default GetMembersResponse |
getMembers(Consumer<GetMembersRequest.Builder> getMembersRequest)
Returns the membership details for specified member accounts for a behavior graph.
|
default GetMembersResponse |
getMembers(GetMembersRequest getMembersRequest)
Returns the membership details for specified member accounts for a behavior graph.
|
default ListDatasourcePackagesResponse |
listDatasourcePackages(Consumer<ListDatasourcePackagesRequest.Builder> listDatasourcePackagesRequest)
Lists data source packages in the behavior graph.
|
default ListDatasourcePackagesResponse |
listDatasourcePackages(ListDatasourcePackagesRequest listDatasourcePackagesRequest)
Lists data source packages in the behavior graph.
|
default ListDatasourcePackagesIterable |
listDatasourcePackagesPaginator(Consumer<ListDatasourcePackagesRequest.Builder> listDatasourcePackagesRequest)
Lists data source packages in the behavior graph.
|
default ListDatasourcePackagesIterable |
listDatasourcePackagesPaginator(ListDatasourcePackagesRequest listDatasourcePackagesRequest)
Lists data source packages in the behavior graph.
|
default ListGraphsResponse |
listGraphs(Consumer<ListGraphsRequest.Builder> listGraphsRequest)
Returns the list of behavior graphs that the calling account is an administrator account of.
|
default ListGraphsResponse |
listGraphs(ListGraphsRequest listGraphsRequest)
Returns the list of behavior graphs that the calling account is an administrator account of.
|
default ListGraphsIterable |
listGraphsPaginator(Consumer<ListGraphsRequest.Builder> listGraphsRequest)
Returns the list of behavior graphs that the calling account is an administrator account of.
|
default ListGraphsIterable |
listGraphsPaginator(ListGraphsRequest listGraphsRequest)
Returns the list of behavior graphs that the calling account is an administrator account of.
|
default ListInvitationsResponse |
listInvitations(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest)
Retrieves the list of open and accepted behavior graph invitations for the member account.
|
default ListInvitationsResponse |
listInvitations(ListInvitationsRequest listInvitationsRequest)
Retrieves the list of open and accepted behavior graph invitations for the member account.
|
default ListInvitationsIterable |
listInvitationsPaginator(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest)
Retrieves the list of open and accepted behavior graph invitations for the member account.
|
default ListInvitationsIterable |
listInvitationsPaginator(ListInvitationsRequest listInvitationsRequest)
Retrieves the list of open and accepted behavior graph invitations for the member account.
|
default ListMembersResponse |
listMembers(Consumer<ListMembersRequest.Builder> listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
|
default ListMembersResponse |
listMembers(ListMembersRequest listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
|
default ListMembersIterable |
listMembersPaginator(Consumer<ListMembersRequest.Builder> listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
|
default ListMembersIterable |
listMembersPaginator(ListMembersRequest listMembersRequest)
Retrieves the list of member accounts for a behavior graph.
|
default ListOrganizationAdminAccountsResponse |
listOrganizationAdminAccounts(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest)
Returns information about the Detective administrator account for an organization.
|
default ListOrganizationAdminAccountsResponse |
listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest)
Returns information about the Detective administrator account for an organization.
|
default ListOrganizationAdminAccountsIterable |
listOrganizationAdminAccountsPaginator(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest)
Returns information about the Detective administrator account for an organization.
|
default ListOrganizationAdminAccountsIterable |
listOrganizationAdminAccountsPaginator(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest)
Returns information about the Detective administrator account for an organization.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns the tag values that are assigned to a behavior graph.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns the tag values that are assigned to a behavior graph.
|
default RejectInvitationResponse |
rejectInvitation(Consumer<RejectInvitationRequest.Builder> rejectInvitationRequest)
Rejects an invitation to contribute the account data to a behavior graph.
|
default RejectInvitationResponse |
rejectInvitation(RejectInvitationRequest rejectInvitationRequest)
Rejects an invitation to contribute the account data to a behavior graph.
|
static ServiceMetadata |
serviceMetadata() |
default StartMonitoringMemberResponse |
startMonitoringMember(Consumer<StartMonitoringMemberRequest.Builder> startMonitoringMemberRequest)
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED. |
default StartMonitoringMemberResponse |
startMonitoringMember(StartMonitoringMemberRequest startMonitoringMemberRequest)
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED. |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies tag values to a behavior graph.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Applies tag values to a behavior graph.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a behavior graph.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a behavior graph.
|
default UpdateDatasourcePackagesResponse |
updateDatasourcePackages(Consumer<UpdateDatasourcePackagesRequest.Builder> updateDatasourcePackagesRequest)
Starts a data source packages for the behavior graph.
|
default UpdateDatasourcePackagesResponse |
updateDatasourcePackages(UpdateDatasourcePackagesRequest updateDatasourcePackagesRequest)
Starts a data source packages for the behavior graph.
|
default UpdateOrganizationConfigurationResponse |
updateOrganizationConfiguration(Consumer<UpdateOrganizationConfigurationRequest.Builder> updateOrganizationConfigurationRequest)
Updates the configuration for the Organizations integration in the current Region.
|
default UpdateOrganizationConfigurationResponse |
updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest)
Updates the configuration for the Organizations integration in the current Region.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static DetectiveClient create()
DetectiveClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DetectiveClientBuilder builder()
DetectiveClient.default AcceptInvitationResponse acceptInvitation(AcceptInvitationRequest acceptInvitationRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.
The request provides the ARN of behavior graph.
The member account status in the graph must be INVITED.
acceptInvitationRequest - 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.AwsServiceExceptiondefault AcceptInvitationResponse acceptInvitation(Consumer<AcceptInvitationRequest.Builder> acceptInvitationRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.
The request provides the ARN of behavior graph.
The member account status in the graph must be INVITED.
This is a convenience which creates an instance of the AcceptInvitationRequest.Builder avoiding the need
to create one manually via AcceptInvitationRequest.builder()
acceptInvitationRequest - A Consumer that will call methods on AcceptInvitationRequest.Builder to create a request.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.AwsServiceExceptiondefault BatchGetGraphMemberDatasourcesResponse batchGetGraphMemberDatasources(BatchGetGraphMemberDatasourcesRequest batchGetGraphMemberDatasourcesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Gets data source package information for the behavior graph.
batchGetGraphMemberDatasourcesRequest - 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.AwsServiceExceptiondefault BatchGetGraphMemberDatasourcesResponse batchGetGraphMemberDatasources(Consumer<BatchGetGraphMemberDatasourcesRequest.Builder> batchGetGraphMemberDatasourcesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Gets data source package information for the behavior graph.
This is a convenience which creates an instance of the BatchGetGraphMemberDatasourcesRequest.Builder
avoiding the need to create one manually via BatchGetGraphMemberDatasourcesRequest.builder()
batchGetGraphMemberDatasourcesRequest - A Consumer that will call methods on BatchGetGraphMemberDatasourcesRequest.Builder to
create a request.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.AwsServiceExceptiondefault BatchGetMembershipDatasourcesResponse batchGetMembershipDatasources(BatchGetMembershipDatasourcesRequest batchGetMembershipDatasourcesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Gets information on the data source package history for an account.
batchGetMembershipDatasourcesRequest - 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.AwsServiceExceptiondefault BatchGetMembershipDatasourcesResponse batchGetMembershipDatasources(Consumer<BatchGetMembershipDatasourcesRequest.Builder> batchGetMembershipDatasourcesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Gets information on the data source package history for an account.
This is a convenience which creates an instance of the BatchGetMembershipDatasourcesRequest.Builder
avoiding the need to create one manually via BatchGetMembershipDatasourcesRequest.builder()
batchGetMembershipDatasourcesRequest - A Consumer that will call methods on BatchGetMembershipDatasourcesRequest.Builder to
create a request.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.AwsServiceExceptiondefault CreateGraphResponse createGraph(CreateGraphRequest createGraphRequest) throws ConflictException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, DetectiveException
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.
CreateGraph triggers 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 CreateGraph with the same administrator account, it always returns the same behavior graph
ARN. It does not create a new behavior graph.
createGraphRequest - 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.AwsServiceExceptiondefault CreateGraphResponse createGraph(Consumer<CreateGraphRequest.Builder> createGraphRequest) throws ConflictException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, DetectiveException
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.
CreateGraph triggers 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 CreateGraph with 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.Builder avoiding the need to
create one manually via CreateGraphRequest.builder()
createGraphRequest - A Consumer that will call methods on CreateGraphRequest.Builder to create a request.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.AwsServiceExceptiondefault CreateMembersResponse createMembers(CreateMembersRequest createMembersRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, DetectiveException
CreateMembers is used to send invitations to accounts. For the organization behavior graph, the
Detective administrator account uses CreateMembers to enable organization accounts as member
accounts.
For invited accounts, CreateMembers sends 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.
CreateMembers verifies 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, CreateMembers attempts 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 CreateMembers was 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 CreateMembers was unable to process. This list includes accounts that were already
invited to be member accounts in the behavior graph.
createMembersRequest - 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.AwsServiceExceptiondefault CreateMembersResponse createMembers(Consumer<CreateMembersRequest.Builder> createMembersRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, DetectiveException
CreateMembers is used to send invitations to accounts. For the organization behavior graph, the
Detective administrator account uses CreateMembers to enable organization accounts as member
accounts.
For invited accounts, CreateMembers sends 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.
CreateMembers verifies 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, CreateMembers attempts 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 CreateMembers was 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 CreateMembers was unable to process. This list includes accounts that were already
invited to be member accounts in the behavior graph.
This is a convenience which creates an instance of the CreateMembersRequest.Builder avoiding the need to
create one manually via CreateMembersRequest.builder()
createMembersRequest - A Consumer that will call methods on CreateMembersRequest.Builder to create a request.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.AwsServiceExceptiondefault DeleteGraphResponse deleteGraph(DeleteGraphRequest deleteGraphRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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.
DeleteGraph can only be called by the administrator account for a behavior graph.
deleteGraphRequest - 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.AwsServiceExceptiondefault DeleteGraphResponse deleteGraph(Consumer<DeleteGraphRequest.Builder> deleteGraphRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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.
DeleteGraph can only be called by the administrator account for a behavior graph.
This is a convenience which creates an instance of the DeleteGraphRequest.Builder avoiding the need to
create one manually via DeleteGraphRequest.builder()
deleteGraphRequest - A Consumer that will call methods on DeleteGraphRequest.Builder to create a request.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.AwsServiceExceptiondefault DeleteMembersResponse deleteMembers(DeleteMembersRequest deleteMembersRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 ListMembers results for the organization behavior graph.
An administrator account cannot use DeleteMembers to remove their own account from the behavior
graph. To disable a behavior graph, the administrator account uses the DeleteGraph API method.
deleteMembersRequest - 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.AwsServiceExceptiondefault DeleteMembersResponse deleteMembers(Consumer<DeleteMembersRequest.Builder> deleteMembersRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 ListMembers results for the organization behavior graph.
An administrator account cannot use DeleteMembers to remove their own account from the behavior
graph. To disable a behavior graph, the administrator account uses the DeleteGraph API method.
This is a convenience which creates an instance of the DeleteMembersRequest.Builder avoiding the need to
create one manually via DeleteMembersRequest.builder()
deleteMembersRequest - A Consumer that will call methods on DeleteMembersRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeOrganizationConfigurationResponse describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
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.
describeOrganizationConfigurationRequest - 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.AwsServiceExceptiondefault DescribeOrganizationConfigurationResponse describeOrganizationConfiguration(Consumer<DescribeOrganizationConfigurationRequest.Builder> describeOrganizationConfigurationRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
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.Builder
avoiding the need to create one manually via DescribeOrganizationConfigurationRequest.builder()
describeOrganizationConfigurationRequest - A Consumer that will call methods on DescribeOrganizationConfigurationRequest.Builder to
create a request.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.AwsServiceExceptiondefault DisableOrganizationAdminAccountResponse disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
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.
disableOrganizationAdminAccountRequest - 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.AwsServiceExceptiondefault DisableOrganizationAdminAccountResponse disableOrganizationAdminAccount(Consumer<DisableOrganizationAdminAccountRequest.Builder> disableOrganizationAdminAccountRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
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.Builder
avoiding the need to create one manually via DisableOrganizationAdminAccountRequest.builder()
disableOrganizationAdminAccountRequest - A Consumer that will call methods on DisableOrganizationAdminAccountRequest.Builder to
create a request.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.AwsServiceExceptiondefault DisassociateMembershipResponse disassociateMembership(DisassociateMembershipRequest disassociateMembershipRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Removes the member account from the specified behavior graph. This operation can only be called by an invited
member account that has the ENABLED status.
DisassociateMembership cannot 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.
disassociateMembershipRequest - 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.AwsServiceExceptiondefault DisassociateMembershipResponse disassociateMembership(Consumer<DisassociateMembershipRequest.Builder> disassociateMembershipRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Removes the member account from the specified behavior graph. This operation can only be called by an invited
member account that has the ENABLED status.
DisassociateMembership cannot 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.Builder avoiding the
need to create one manually via DisassociateMembershipRequest.builder()
disassociateMembershipRequest - A Consumer that will call methods on DisassociateMembershipRequest.Builder to create a
request.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.AwsServiceExceptiondefault EnableOrganizationAdminAccountResponse enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
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.
enableOrganizationAdminAccountRequest - 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.AwsServiceExceptiondefault EnableOrganizationAdminAccountResponse enableOrganizationAdminAccount(Consumer<EnableOrganizationAdminAccountRequest.Builder> enableOrganizationAdminAccountRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
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.Builder
avoiding the need to create one manually via EnableOrganizationAdminAccountRequest.builder()
enableOrganizationAdminAccountRequest - A Consumer that will call methods on EnableOrganizationAdminAccountRequest.Builder to
create a request.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.AwsServiceExceptiondefault GetMembersResponse getMembers(GetMembersRequest getMembersRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Returns the membership details for specified member accounts for a behavior graph.
getMembersRequest - 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.AwsServiceExceptiondefault GetMembersResponse getMembers(Consumer<GetMembersRequest.Builder> getMembersRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Returns the membership details for specified member accounts for a behavior graph.
This is a convenience which creates an instance of the GetMembersRequest.Builder avoiding the need to
create one manually via GetMembersRequest.builder()
getMembersRequest - A Consumer that will call methods on GetMembersRequest.Builder to create a request.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.AwsServiceExceptiondefault ListDatasourcePackagesResponse listDatasourcePackages(ListDatasourcePackagesRequest listDatasourcePackagesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Lists data source packages in the behavior graph.
listDatasourcePackagesRequest - 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.AwsServiceExceptiondefault ListDatasourcePackagesResponse listDatasourcePackages(Consumer<ListDatasourcePackagesRequest.Builder> listDatasourcePackagesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Lists data source packages in the behavior graph.
This is a convenience which creates an instance of the ListDatasourcePackagesRequest.Builder avoiding the
need to create one manually via ListDatasourcePackagesRequest.builder()
listDatasourcePackagesRequest - A Consumer that will call methods on ListDatasourcePackagesRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListDatasourcePackagesIterable listDatasourcePackagesPaginator(ListDatasourcePackagesRequest listDatasourcePackagesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Lists data source packages in the behavior graph.
This is a variant of
listDatasourcePackages(software.amazon.awssdk.services.detective.model.ListDatasourcePackagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesIterable responses = client.listDatasourcePackagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesIterable responses = client
.listDatasourcePackagesPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListDatasourcePackagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesIterable responses = client.listDatasourcePackagesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listDatasourcePackagesRequest - 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.AwsServiceExceptiondefault ListDatasourcePackagesIterable listDatasourcePackagesPaginator(Consumer<ListDatasourcePackagesRequest.Builder> listDatasourcePackagesRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Lists data source packages in the behavior graph.
This is a variant of
listDatasourcePackages(software.amazon.awssdk.services.detective.model.ListDatasourcePackagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesIterable responses = client.listDatasourcePackagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesIterable responses = client
.listDatasourcePackagesPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListDatasourcePackagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListDatasourcePackagesIterable responses = client.listDatasourcePackagesPaginator(request);
responses.iterator().forEachRemaining(....);
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.Builder avoiding the
need to create one manually via ListDatasourcePackagesRequest.builder()
listDatasourcePackagesRequest - A Consumer that will call methods on ListDatasourcePackagesRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListGraphsResponse listGraphs(ListGraphsRequest listGraphsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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.
listGraphsRequest - 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.AwsServiceExceptiondefault ListGraphsResponse listGraphs(Consumer<ListGraphsRequest.Builder> listGraphsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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.Builder avoiding the need to
create one manually via ListGraphsRequest.builder()
listGraphsRequest - A Consumer that will call methods on ListGraphsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListGraphsIterable listGraphsPaginator(ListGraphsRequest listGraphsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 variant of listGraphs(software.amazon.awssdk.services.detective.model.ListGraphsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListGraphsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGraphs(software.amazon.awssdk.services.detective.model.ListGraphsRequest) operation.
listGraphsRequest - 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.AwsServiceExceptiondefault ListGraphsIterable listGraphsPaginator(Consumer<ListGraphsRequest.Builder> listGraphsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 variant of listGraphs(software.amazon.awssdk.services.detective.model.ListGraphsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListGraphsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListGraphsIterable responses = client.listGraphsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGraphs(software.amazon.awssdk.services.detective.model.ListGraphsRequest) operation.
This is a convenience which creates an instance of the ListGraphsRequest.Builder avoiding the need to
create one manually via ListGraphsRequest.builder()
listGraphsRequest - A Consumer that will call methods on ListGraphsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListInvitationsResponse listInvitations(ListInvitationsRequest listInvitationsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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.
listInvitationsRequest - 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.AwsServiceExceptiondefault ListInvitationsResponse listInvitations(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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.Builder avoiding the need
to create one manually via ListInvitationsRequest.builder()
listInvitationsRequest - A Consumer that will call methods on ListInvitationsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListInvitationsIterable listInvitationsPaginator(ListInvitationsRequest listInvitationsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 variant of
listInvitations(software.amazon.awssdk.services.detective.model.ListInvitationsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListInvitationsIterable responses = client
.listInvitationsPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListInvitationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInvitations(software.amazon.awssdk.services.detective.model.ListInvitationsRequest) operation.
listInvitationsRequest - 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.AwsServiceExceptiondefault ListInvitationsIterable listInvitationsPaginator(Consumer<ListInvitationsRequest.Builder> listInvitationsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 variant of
listInvitations(software.amazon.awssdk.services.detective.model.ListInvitationsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListInvitationsIterable responses = client
.listInvitationsPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListInvitationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListInvitationsIterable responses = client.listInvitationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInvitations(software.amazon.awssdk.services.detective.model.ListInvitationsRequest) operation.
This is a convenience which creates an instance of the ListInvitationsRequest.Builder avoiding the need
to create one manually via ListInvitationsRequest.builder()
listInvitationsRequest - A Consumer that will call methods on ListInvitationsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListMembersResponse listMembers(ListMembersRequest listMembersRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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.
listMembersRequest - 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.AwsServiceExceptiondefault ListMembersResponse listMembers(Consumer<ListMembersRequest.Builder> listMembersRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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.Builder avoiding the need to
create one manually via ListMembersRequest.builder()
listMembersRequest - A Consumer that will call methods on ListMembersRequest.Builder to create a request.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.AwsServiceExceptiondefault ListMembersIterable listMembersPaginator(ListMembersRequest listMembersRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 variant of listMembers(software.amazon.awssdk.services.detective.model.ListMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListMembersIterable responses = client.listMembersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListMembersIterable responses = client.listMembersPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListMembersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListMembersIterable responses = client.listMembersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMembers(software.amazon.awssdk.services.detective.model.ListMembersRequest) operation.
listMembersRequest - 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.AwsServiceExceptiondefault ListMembersIterable listMembersPaginator(Consumer<ListMembersRequest.Builder> listMembersRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 variant of listMembers(software.amazon.awssdk.services.detective.model.ListMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListMembersIterable responses = client.listMembersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListMembersIterable responses = client.listMembersPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListMembersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListMembersIterable responses = client.listMembersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMembers(software.amazon.awssdk.services.detective.model.ListMembersRequest) operation.
This is a convenience which creates an instance of the ListMembersRequest.Builder avoiding the need to
create one manually via ListMembersRequest.builder()
listMembersRequest - A Consumer that will call methods on ListMembersRequest.Builder to create a request.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.AwsServiceExceptiondefault ListOrganizationAdminAccountsResponse listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.
listOrganizationAdminAccountsRequest - 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.AwsServiceExceptiondefault ListOrganizationAdminAccountsResponse listOrganizationAdminAccounts(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
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.Builder
avoiding the need to create one manually via ListOrganizationAdminAccountsRequest.builder()
listOrganizationAdminAccountsRequest - A Consumer that will call methods on ListOrganizationAdminAccountsRequest.Builder to
create a request.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.AwsServiceExceptiondefault ListOrganizationAdminAccountsIterable listOrganizationAdminAccountsPaginator(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.
This is a variant of
listOrganizationAdminAccounts(software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsIterable responses = client.listOrganizationAdminAccountsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsIterable responses = client
.listOrganizationAdminAccountsPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsIterable responses = client.listOrganizationAdminAccountsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listOrganizationAdminAccountsRequest - 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.AwsServiceExceptiondefault ListOrganizationAdminAccountsIterable listOrganizationAdminAccountsPaginator(Consumer<ListOrganizationAdminAccountsRequest.Builder> listOrganizationAdminAccountsRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.
This is a variant of
listOrganizationAdminAccounts(software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsIterable responses = client.listOrganizationAdminAccountsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsIterable responses = client
.listOrganizationAdminAccountsPaginator(request);
for (software.amazon.awssdk.services.detective.model.ListOrganizationAdminAccountsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.detective.paginators.ListOrganizationAdminAccountsIterable responses = client.listOrganizationAdminAccountsPaginator(request);
responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually via ListOrganizationAdminAccountsRequest.builder()
listOrganizationAdminAccountsRequest - A Consumer that will call methods on ListOrganizationAdminAccountsRequest.Builder to
create a request.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, DetectiveException
Returns the tag values that are assigned to a behavior graph.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, DetectiveException
Returns the tag values that are assigned to a behavior graph.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault RejectInvitationResponse rejectInvitation(RejectInvitationRequest rejectInvitationRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 INVITED status.
RejectInvitation cannot be called by an organization account in the organization behavior graph. In
the organization behavior graph, organization accounts do not receive an invitation.
rejectInvitationRequest - 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.AwsServiceExceptiondefault RejectInvitationResponse rejectInvitation(Consumer<RejectInvitationRequest.Builder> rejectInvitationRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
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 INVITED status.
RejectInvitation cannot 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.Builder avoiding the need
to create one manually via RejectInvitationRequest.builder()
rejectInvitationRequest - A Consumer that will call methods on RejectInvitationRequest.Builder to create a request.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.AwsServiceExceptiondefault StartMonitoringMemberResponse startMonitoringMember(StartMonitoringMemberRequest startMonitoringMemberRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED.
For valid member accounts, the status is updated as follows.
If Detective enabled the member account, then the new status is ENABLED.
If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED.
startMonitoringMemberRequest - 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.AwsServiceExceptiondefault StartMonitoringMemberResponse startMonitoringMember(Consumer<StartMonitoringMemberRequest.Builder> startMonitoringMemberRequest) throws ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED.
For valid member accounts, the status is updated as follows.
If Detective enabled the member account, then the new status is ENABLED.
If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED.
This is a convenience which creates an instance of the StartMonitoringMemberRequest.Builder avoiding the
need to create one manually via StartMonitoringMemberRequest.builder()
startMonitoringMemberRequest - A Consumer that will call methods on StartMonitoringMemberRequest.Builder to create a
request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, DetectiveException
Applies tag values to a behavior graph.
tagResourceRequest - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, DetectiveException
Applies tag values to a behavior graph.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, DetectiveException
Removes tags from a behavior graph.
untagResourceRequest - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, DetectiveException
Removes tags from a behavior graph.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UpdateDatasourcePackagesResponse updateDatasourcePackages(UpdateDatasourcePackagesRequest updateDatasourcePackagesRequest) throws InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Starts a data source packages for the behavior graph.
updateDatasourcePackagesRequest - 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.AwsServiceExceptiondefault UpdateDatasourcePackagesResponse updateDatasourcePackages(Consumer<UpdateDatasourcePackagesRequest.Builder> updateDatasourcePackagesRequest) throws InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, DetectiveException
Starts a data source packages for the behavior graph.
This is a convenience which creates an instance of the UpdateDatasourcePackagesRequest.Builder avoiding
the need to create one manually via UpdateDatasourcePackagesRequest.builder()
updateDatasourcePackagesRequest - A Consumer that will call methods on UpdateDatasourcePackagesRequest.Builder to create a
request.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.AwsServiceExceptiondefault UpdateOrganizationConfigurationResponse updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.
updateOrganizationConfigurationRequest - 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.AwsServiceExceptiondefault UpdateOrganizationConfigurationResponse updateOrganizationConfiguration(Consumer<UpdateOrganizationConfigurationRequest.Builder> updateOrganizationConfigurationRequest) throws InternalServerException, ValidationException, TooManyRequestsException, AwsServiceException, SdkClientException, DetectiveException
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.Builder
avoiding the need to create one manually via UpdateOrganizationConfigurationRequest.builder()
updateOrganizationConfigurationRequest - A Consumer that will call methods on UpdateOrganizationConfigurationRequest.Builder to
create a request.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.