AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <DetectiveClient.h>
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.
Definition at line 65 of file DetectiveClient.h.
Definition at line 68 of file DetectiveClient.h.
Definition at line 72 of file DetectiveClient.h.
Definition at line 73 of file DetectiveClient.h.
Aws::Detective::DetectiveClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Detective::DetectiveClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Detective::DetectiveClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
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
.
nullptr
An Async wrapper for AcceptInvitation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 146 of file DetectiveClient.h.
A Callable wrapper for AcceptInvitation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 137 of file DetectiveClient.h.
nullptr
An Async wrapper for BatchGetGraphMemberDatasources that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 172 of file DetectiveClient.h.
A Callable wrapper for BatchGetGraphMemberDatasources that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 163 of file DetectiveClient.h.
nullptr
An Async wrapper for BatchGetMembershipDatasources that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 198 of file DetectiveClient.h.
A Callable wrapper for BatchGetMembershipDatasources that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 189 of file DetectiveClient.h.
{}
)
const
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.
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.
nullptr
,
{}
An Async wrapper for CreateGraph that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 232 of file DetectiveClient.h.
{}
)
const
A Callable wrapper for CreateGraph that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 223 of file DetectiveClient.h.
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.
nullptr
An Async wrapper for CreateMembers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 279 of file DetectiveClient.h.
A Callable wrapper for CreateMembers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 270 of file DetectiveClient.h.
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.
nullptr
An Async wrapper for DeleteGraph that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 307 of file DetectiveClient.h.
A Callable wrapper for DeleteGraph that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 298 of file DetectiveClient.h.
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.
nullptr
An Async wrapper for DeleteMembers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 344 of file DetectiveClient.h.
A Callable wrapper for DeleteMembers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 335 of file DetectiveClient.h.
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.
nullptr
An Async wrapper for DescribeOrganizationConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 372 of file DetectiveClient.h.
A Callable wrapper for DescribeOrganizationConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 363 of file DetectiveClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for DisableOrganizationAdminAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 405 of file DetectiveClient.h.
{}
)
const
A Callable wrapper for DisableOrganizationAdminAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 396 of file DetectiveClient.h.
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.
nullptr
An Async wrapper for DisassociateMembership that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 436 of file DetectiveClient.h.
A Callable wrapper for DisassociateMembership that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 427 of file DetectiveClient.h.
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.
nullptr
An Async wrapper for EnableOrganizationAdminAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 473 of file DetectiveClient.h.
A Callable wrapper for EnableOrganizationAdminAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 464 of file DetectiveClient.h.
Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. GetInvestigation
returns the investigation results of an investigation for a behavior graph.
nullptr
An Async wrapper for GetInvestigation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 503 of file DetectiveClient.h.
A Callable wrapper for GetInvestigation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 494 of file DetectiveClient.h.
Returns the membership details for specified member accounts for a behavior graph.
nullptr
An Async wrapper for GetMembers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 529 of file DetectiveClient.h.
A Callable wrapper for GetMembers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 520 of file DetectiveClient.h.
nullptr
An Async wrapper for ListDatasourcePackages that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 555 of file DetectiveClient.h.
A Callable wrapper for ListDatasourcePackages that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 546 of file DetectiveClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListGraphs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 584 of file DetectiveClient.h.
{}
)
const
A Callable wrapper for ListGraphs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 575 of file DetectiveClient.h.
Gets the indicators from an investigation. You can use the information from the indicators to determine if an IAM user and/or IAM role is involved in an unusual activity that could indicate malicious behavior and its impact.
nullptr
An Async wrapper for ListIndicators that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 612 of file DetectiveClient.h.
A Callable wrapper for ListIndicators that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 603 of file DetectiveClient.h.
Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. ListInvestigations
lists all active Detective investigations.
nullptr
An Async wrapper for ListInvestigations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 642 of file DetectiveClient.h.
A Callable wrapper for ListInvestigations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 633 of file DetectiveClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListInvitations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 673 of file DetectiveClient.h.
{}
)
const
A Callable wrapper for ListInvitations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 664 of file DetectiveClient.h.
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.
nullptr
An Async wrapper for ListMembers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 702 of file DetectiveClient.h.
A Callable wrapper for ListMembers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 693 of file DetectiveClient.h.
{}
)
const
Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.
nullptr
,
{}
An Async wrapper for ListOrganizationAdminAccounts that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 729 of file DetectiveClient.h.
{}
)
const
A Callable wrapper for ListOrganizationAdminAccounts that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 720 of file DetectiveClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 755 of file DetectiveClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 746 of file DetectiveClient.h.
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.
nullptr
An Async wrapper for RejectInvitation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 785 of file DetectiveClient.h.
A Callable wrapper for RejectInvitation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 776 of file DetectiveClient.h.
Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. StartInvestigation
initiates an investigation on an entity in a behavior graph.
nullptr
An Async wrapper for StartInvestigation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 815 of file DetectiveClient.h.
A Callable wrapper for StartInvestigation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 806 of file DetectiveClient.h.
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
.
nullptr
An Async wrapper for StartMonitoringMember that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 845 of file DetectiveClient.h.
A Callable wrapper for StartMonitoringMember that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 836 of file DetectiveClient.h.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 870 of file DetectiveClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 861 of file DetectiveClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 895 of file DetectiveClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 886 of file DetectiveClient.h.
nullptr
An Async wrapper for UpdateDatasourcePackages that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 921 of file DetectiveClient.h.
A Callable wrapper for UpdateDatasourcePackages that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 912 of file DetectiveClient.h.
nullptr
An Async wrapper for UpdateInvestigationState that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 946 of file DetectiveClient.h.
A Callable wrapper for UpdateInvestigationState that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 937 of file DetectiveClient.h.
nullptr
An Async wrapper for UpdateOrganizationConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 973 of file DetectiveClient.h.
A Callable wrapper for UpdateOrganizationConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 964 of file DetectiveClient.h.
Definition at line 980 of file DetectiveClient.h.