Detective
This page documents function available when using the Detective module, created with @service Detective.
Index
Main.Detective.accept_invitationMain.Detective.batch_get_graph_member_datasourcesMain.Detective.batch_get_membership_datasourcesMain.Detective.create_graphMain.Detective.create_membersMain.Detective.delete_graphMain.Detective.delete_membersMain.Detective.describe_organization_configurationMain.Detective.disable_organization_admin_accountMain.Detective.disassociate_membershipMain.Detective.enable_organization_admin_accountMain.Detective.get_membersMain.Detective.list_datasource_packagesMain.Detective.list_graphsMain.Detective.list_invitationsMain.Detective.list_membersMain.Detective.list_organization_admin_accountsMain.Detective.list_tags_for_resourceMain.Detective.reject_invitationMain.Detective.start_monitoring_memberMain.Detective.tag_resourceMain.Detective.untag_resourceMain.Detective.update_datasource_packagesMain.Detective.update_organization_configuration
Documentation
Main.Detective.accept_invitation — Methodaccept_invitation(graph_arn)
accept_invitation(graph_arn, params::Dict{String,<:Any})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.
Arguments
graph_arn: The ARN of the behavior graph that the member account is accepting the invitation for. The member account status in the behavior graph must be INVITED.
Main.Detective.batch_get_graph_member_datasources — Methodbatch_get_graph_member_datasources(account_ids, graph_arn)
batch_get_graph_member_datasources(account_ids, graph_arn, params::Dict{String,<:Any})Gets data source package information for the behavior graph.
Arguments
account_ids: The list of Amazon Web Services accounts to get data source package information on.graph_arn: The ARN of the behavior graph.
Main.Detective.batch_get_membership_datasources — Methodbatch_get_membership_datasources(graph_arns)
batch_get_membership_datasources(graph_arns, params::Dict{String,<:Any})Gets information on the data source package history for an account.
Arguments
graph_arns: The ARN of the behavior graph.
Main.Detective.create_graph — Methodcreate_graph()
create_graph(params::Dict{String,<:Any})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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Tags": The tags to assign to the new behavior graph. You can add up to 50 tags. For each tag, you provide the tag key and the tag value. Each tag key can contain up to 128 characters. Each tag value can contain up to 256 characters.
Main.Detective.create_members — Methodcreate_members(accounts, graph_arn)
create_members(accounts, graph_arn, params::Dict{String,<:Any})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.
Arguments
accounts: The list of Amazon Web Services accounts to invite or to enable. You can invite or enable up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the Amazon Web Services account root user email address. For organization accounts in the organization behavior graph, the email address is not required.graph_arn: The ARN of the behavior graph.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"DisableEmailNotification": if set to true, then the invited accounts do not receive email notifications. By default, this is set to false, and the invited accounts receive email notifications. Organization accounts in the organization behavior graph do not receive email notifications."Message": Customized message text to include in the invitation email message to the invited member accounts.
Main.Detective.delete_graph — Methoddelete_graph(graph_arn)
delete_graph(graph_arn, params::Dict{String,<:Any})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.
Arguments
graph_arn: The ARN of the behavior graph to disable.
Main.Detective.delete_members — Methoddelete_members(account_ids, graph_arn)
delete_members(account_ids, graph_arn, params::Dict{String,<:Any})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.
Arguments
account_ids: The list of Amazon Web Services account identifiers for the member accounts to remove from the behavior graph. You can remove up to 50 member accounts at a time.graph_arn: The ARN of the behavior graph to remove members from.
Main.Detective.describe_organization_configuration — Methoddescribe_organization_configuration(graph_arn)
describe_organization_configuration(graph_arn, params::Dict{String,<:Any})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.
Arguments
graph_arn: The ARN of the organization behavior graph.
Main.Detective.disable_organization_admin_account — Methoddisable_organization_admin_account()
disable_organization_admin_account(params::Dict{String,<:Any})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.
Main.Detective.disassociate_membership — Methoddisassociate_membership(graph_arn)
disassociate_membership(graph_arn, params::Dict{String,<:Any})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.
Arguments
graph_arn: The ARN of the behavior graph to remove the member account from. The member account's member status in the behavior graph must be ENABLED.
Main.Detective.enable_organization_admin_account — Methodenable_organization_admin_account(account_id)
enable_organization_admin_account(account_id, params::Dict{String,<:Any})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.
Arguments
account_id: The Amazon Web Services account identifier of the account to designate as the Detective administrator account for the organization.
Main.Detective.get_members — Methodget_members(account_ids, graph_arn)
get_members(account_ids, graph_arn, params::Dict{String,<:Any})Returns the membership details for specified member accounts for a behavior graph.
Arguments
account_ids: The list of Amazon Web Services account identifiers for the member account for which to return member details. You can request details for up to 50 member accounts at a time. You cannot use GetMembers to retrieve information about member accounts that were removed from the behavior graph.graph_arn: The ARN of the behavior graph for which to request the member details.
Main.Detective.list_datasource_packages — Methodlist_datasource_packages(graph_arn)
list_datasource_packages(graph_arn, params::Dict{String,<:Any})Lists data source packages in the behavior graph.
Arguments
graph_arn: The ARN of the behavior graph.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": The maximum number of results to return."NextToken": For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.
Main.Detective.list_graphs — Methodlist_graphs()
list_graphs(params::Dict{String,<:Any})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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200."NextToken": For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.
Main.Detective.list_invitations — Methodlist_invitations()
list_invitations(params::Dict{String,<:Any})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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200."NextToken": For requests to retrieve the next page of results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.
Main.Detective.list_members — Methodlist_members(graph_arn)
list_members(graph_arn, params::Dict{String,<:Any})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.
Arguments
graph_arn: The ARN of the behavior graph for which to retrieve the list of member accounts.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200."NextToken": For requests to retrieve the next page of member account results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.
Main.Detective.list_organization_admin_accounts — Methodlist_organization_admin_accounts()
list_organization_admin_accounts(params::Dict{String,<:Any})Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": The maximum number of results to return."NextToken": For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.
Main.Detective.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Returns the tag values that are assigned to a behavior graph.
Arguments
resource_arn: The ARN of the behavior graph for which to retrieve the tag values.
Main.Detective.reject_invitation — Methodreject_invitation(graph_arn)
reject_invitation(graph_arn, params::Dict{String,<:Any})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.
Arguments
graph_arn: The ARN of the behavior graph to reject the invitation to. The member account's current member status in the behavior graph must be INVITED.
Main.Detective.start_monitoring_member — Methodstart_monitoring_member(account_id, graph_arn)
start_monitoring_member(account_id, graph_arn, params::Dict{String,<:Any})Sends a request to enable data ingest for a member account that has a status of ACCEPTEDBUTDISABLED. 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 ACCEPTEDBUTDISABLED.
Arguments
account_id: The account ID of the member account to try to enable. The account must be an invited member account with a status of ACCEPTEDBUTDISABLED.graph_arn: The ARN of the behavior graph.
Main.Detective.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Applies tag values to a behavior graph.
Arguments
resource_arn: The ARN of the behavior graph to assign the tags to.tags: The tags to assign to the behavior graph. You can add up to 50 tags. For each tag, you provide the tag key and the tag value. Each tag key can contain up to 128 characters. Each tag value can contain up to 256 characters.
Main.Detective.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes tags from a behavior graph.
Arguments
resource_arn: The ARN of the behavior graph to remove the tags from.tag_keys: The tag keys of the tags to remove from the behavior graph. You can remove up to 50 tags at a time.
Main.Detective.update_datasource_packages — Methodupdate_datasource_packages(datasource_packages, graph_arn)
update_datasource_packages(datasource_packages, graph_arn, params::Dict{String,<:Any})Starts a data source packages for the behavior graph.
Arguments
datasource_packages: The data source package start for the behavior graph.graph_arn: The ARN of the behavior graph.
Main.Detective.update_organization_configuration — Methodupdate_organization_configuration(graph_arn)
update_organization_configuration(graph_arn, params::Dict{String,<:Any})Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.
Arguments
graph_arn: The ARN of the organization behavior graph.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"AutoEnable": Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.