Table of Contents
Detective.Client¶A low-level client representing Amazon Detective
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:
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:
An invited member account can use the Detective API to do the following:
All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail .
Note
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.
import boto3
client = boto3.client('detective')
These are the available methods:
accept_invitation()batch_get_graph_member_datasources()batch_get_membership_datasources()can_paginate()close()create_graph()create_members()delete_graph()delete_members()describe_organization_configuration()disable_organization_admin_account()disassociate_membership()enable_organization_admin_account()get_members()get_paginator()get_waiter()list_datasource_packages()list_graphs()list_invitations()list_members()list_organization_admin_accounts()list_tags_for_resource()reject_invitation()start_monitoring_member()tag_resource()untag_resource()update_datasource_packages()update_organization_configuration()accept_invitation(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.accept_invitation(
GraphArn='string'
)
[REQUIRED]
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 .
Exceptions
Detective.Client.exceptions.ConflictExceptionDetective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptionbatch_get_graph_member_datasources(**kwargs)¶Gets data source package information for the behavior graph.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_graph_member_datasources(
GraphArn='string',
AccountIds=[
'string',
]
)
[REQUIRED]
The ARN of the behavior graph.
[REQUIRED]
The list of Amazon Web Services accounts to get data source package information on.
dict
Response Syntax
{
'MemberDatasources': [
{
'AccountId': 'string',
'GraphArn': 'string',
'DatasourcePackageIngestHistory': {
'string': {
'string': {
'Timestamp': datetime(2015, 1, 1)
}
}
}
},
],
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Reason': 'string'
},
]
}
Response Structure
(dict) --
MemberDatasources (list) --
Details on the status of data source packages for members of the behavior graph.
(dict) --
Details on data source packages for members of the behavior graph.
AccountId (string) --
The account identifier of the Amazon Web Services account.
GraphArn (string) --
The ARN of the organization behavior graph.
DatasourcePackageIngestHistory (dict) --
Details on when a data source package was added to a behavior graph.
(string) --
(dict) --
(string) --
(dict) --
Details on when data collection began for a source package.
Timestamp (datetime) --
The data and time when data collection began for a source package. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
UnprocessedAccounts (list) --
Accounts that data source package information could not be retrieved for.
(dict) --
A member account that was included in a request but for which the request could not be processed.
AccountId (string) --
The Amazon Web Services account identifier of the member account that was not processed.
Reason (string) --
The reason that the member account request could not be processed.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptionbatch_get_membership_datasources(**kwargs)¶Gets information on the data source package history for an account.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_membership_datasources(
GraphArns=[
'string',
]
)
[REQUIRED]
The ARN of the behavior graph.
{
'MembershipDatasources': [
{
'AccountId': 'string',
'GraphArn': 'string',
'DatasourcePackageIngestHistory': {
'string': {
'string': {
'Timestamp': datetime(2015, 1, 1)
}
}
}
},
],
'UnprocessedGraphs': [
{
'GraphArn': 'string',
'Reason': 'string'
},
]
}
Response Structure
Details on the data source package history for an member of the behavior graph.
Details on data source packages for members of the behavior graph.
The account identifier of the Amazon Web Services account.
The ARN of the organization behavior graph.
Details on when a data source package was added to a behavior graph.
Details on when data collection began for a source package.
The data and time when data collection began for a source package. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
Graphs that data source package information could not be retrieved for.
Behavior graphs that could not be processed in the request.
The ARN of the organization behavior graph.
The reason data source package information could not be processed for a behavior graph.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_graph(**kwargs)¶Creates a new behavior graph for the calling account, and sets that account as the administrator account. This operation is called by the account that is enabling Detective.
Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective.
The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.
CreateGraphtriggers a process to create the corresponding data tables for the new behavior graph.
An account can only be the administrator account for one behavior graph within a Region. If the same account calls CreateGraph with the same administrator account, it always returns the same behavior graph ARN. It does not create a new behavior graph.
See also: AWS API Documentation
Request Syntax
response = client.create_graph(
Tags={
'string': 'string'
}
)
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.
{
'GraphArn': 'string'
}
Response Structure
The ARN of the new behavior graph.
Exceptions
Detective.Client.exceptions.ConflictExceptionDetective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ServiceQuotaExceededExceptioncreate_members(**kwargs)¶CreateMembersis used to send invitations to accounts. For the organization behavior graph, the Detective administrator account usesCreateMembersto enable organization accounts as member accounts.
For invited accounts, 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.
CreateMembersverifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally.
For organization accounts in the organization behavior graph, 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:
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.CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.See also: AWS API Documentation
Request Syntax
response = client.create_members(
GraphArn='string',
Message='string',
DisableEmailNotification=True|False,
Accounts=[
{
'AccountId': 'string',
'EmailAddress': 'string'
},
]
)
[REQUIRED]
The ARN of the behavior graph.
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.
[REQUIRED]
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.
An Amazon Web Services account that is the administrator account of or a member of a behavior graph.
The account identifier of the Amazon Web Services account.
The Amazon Web Services account root user email address for the Amazon Web Services account.
dict
Response Syntax
{
'Members': [
{
'AccountId': 'string',
'EmailAddress': 'string',
'GraphArn': 'string',
'MasterId': 'string',
'AdministratorId': 'string',
'Status': 'INVITED'|'VERIFICATION_IN_PROGRESS'|'VERIFICATION_FAILED'|'ENABLED'|'ACCEPTED_BUT_DISABLED',
'DisabledReason': 'VOLUME_TOO_HIGH'|'VOLUME_UNKNOWN',
'InvitedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'VolumeUsageInBytes': 123,
'VolumeUsageUpdatedTime': datetime(2015, 1, 1),
'PercentOfGraphUtilization': 123.0,
'PercentOfGraphUtilizationUpdatedTime': datetime(2015, 1, 1),
'InvitationType': 'INVITATION'|'ORGANIZATION',
'VolumeUsageByDatasourcePackage': {
'string': {
'VolumeUsageInBytes': 123,
'VolumeUsageUpdateTime': datetime(2015, 1, 1)
}
},
'DatasourcePackageIngestStates': {
'string': 'STARTED'|'STOPPED'|'DISABLED'
}
},
],
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Reason': 'string'
},
]
}
Response Structure
(dict) --
Members (list) --
The set of member account invitation or enablement requests that Detective was able to process. This includes accounts that are being verified, that failed verification, and that passed verification and are being sent an invitation or are being enabled.
(dict) --
Details about a member account in a behavior graph.
AccountId (string) --
The Amazon Web Services account identifier for the member account.
EmailAddress (string) --
The Amazon Web Services account root user email address for the member account.
GraphArn (string) --
The ARN of the behavior graph.
MasterId (string) --
The Amazon Web Services account identifier of the administrator account for the behavior graph.
AdministratorId (string) --
The Amazon Web Services account identifier of the administrator account for the behavior graph.
Status (string) --
The current membership status of the member account. The status can have one of the following values:
INVITED - For invited accounts only. Indicates that the member was sent an invitation but has not yet responded.VERIFICATION_IN_PROGRESS - For invited accounts only, indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph. For organization accounts in the organization behavior graph, indicates that Detective is verifying that the account belongs to the organization.VERIFICATION_FAILED - For invited accounts only. Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.ENABLED - Indicates that the member account currently contributes data to the behavior graph. For invited accounts, the member account accepted the invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member account.ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by the Detective administrator account, but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.Invited accounts that declined an invitation or that were removed from the behavior graph are not included. In the organization behavior graph, organization accounts that the Detective administrator account did not enable are not included.
DisabledReason (string) --
For member accounts with a status of ACCEPTED_BUT_DISABLED , the reason that the member account is not enabled.
The reason can have one of the following values:
VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.InvitedTime (datetime) --
For invited accounts, the date and time that Detective sent the invitation to the account. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
UpdatedTime (datetime) --
The date and time that the member account was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
VolumeUsageInBytes (integer) --
The data volume in bytes per day for the member account.
VolumeUsageUpdatedTime (datetime) --
The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
PercentOfGraphUtilization (float) --
The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.
Note that this is not the percentage of the behavior graph data volume.
For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.
PercentOfGraphUtilizationUpdatedTime (datetime) --
The date and time when the graph utilization percentage was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
InvitationType (string) --
The type of behavior graph membership.
For an organization account in the organization behavior graph, the type is ORGANIZATION .
For an account that was invited to a behavior graph, the type is INVITATION .
VolumeUsageByDatasourcePackage (dict) --
Details on the volume of usage for each data source package in a behavior graph.
(string) --
(dict) --
Information on the usage of a data source package in the behavior graph.
VolumeUsageInBytes (integer) --
Total volume of data in bytes per day ingested for a given data source package.
VolumeUsageUpdateTime (datetime) --
The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
DatasourcePackageIngestStates (dict) --
The state of a data source package for the behavior graph.
UnprocessedAccounts (list) --
The list of accounts for which Detective was unable to process the invitation or enablement request. For each account, the list provides the reason why the request could not be processed. The list includes accounts that are already member accounts in the behavior graph.
(dict) --
A member account that was included in a request but for which the request could not be processed.
AccountId (string) --
The Amazon Web Services account identifier of the member account that was not processed.
Reason (string) --
The reason that the member account request could not be processed.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptionDetective.Client.exceptions.ServiceQuotaExceededExceptiondelete_graph(**kwargs)¶Disables the specified behavior graph and queues it to be deleted. This operation removes the behavior graph from each member account's list of behavior graphs.
DeleteGraphcan only be called by the administrator account for a behavior graph.
See also: AWS API Documentation
Request Syntax
response = client.delete_graph(
GraphArn='string'
)
[REQUIRED]
The ARN of the behavior graph to disable.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptiondelete_members(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_members(
GraphArn='string',
AccountIds=[
'string',
]
)
[REQUIRED]
The ARN of the behavior graph to remove members from.
[REQUIRED]
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.
dict
Response Syntax
{
'AccountIds': [
'string',
],
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Reason': 'string'
},
]
}
Response Structure
(dict) --
AccountIds (list) --
The list of Amazon Web Services account identifiers for the member accounts that Detective successfully removed from the behavior graph.
UnprocessedAccounts (list) --
The list of member accounts that Detective was not able to remove from the behavior graph. For each member account, provides the reason that the deletion could not be processed.
(dict) --
A member account that was included in a request but for which the request could not be processed.
AccountId (string) --
The Amazon Web Services account identifier of the member account that was not processed.
Reason (string) --
The reason that the member account request could not be processed.
Exceptions
Detective.Client.exceptions.ConflictExceptionDetective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptiondescribe_organization_configuration(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_organization_configuration(
GraphArn='string'
)
[REQUIRED]
The ARN of the organization behavior graph.
{
'AutoEnable': True|False
}
Response Structure
Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionDetective.Client.exceptions.TooManyRequestsExceptiondisable_organization_admin_account()¶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.
See also: AWS API Documentation
Request Syntax
response = client.disable_organization_admin_account()
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionDetective.Client.exceptions.TooManyRequestsExceptiondisassociate_membership(**kwargs)¶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.
DisassociateMembershipcannot be called by an organization account in the organization behavior graph. For the organization behavior graph, the Detective administrator account determines which organization accounts to enable or disable as member accounts.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_membership(
GraphArn='string'
)
[REQUIRED]
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 .
Exceptions
Detective.Client.exceptions.ConflictExceptionDetective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptionenable_organization_admin_account(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.enable_organization_admin_account(
AccountId='string'
)
[REQUIRED]
The Amazon Web Services account identifier of the account to designate as the Detective administrator account for the organization.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionDetective.Client.exceptions.TooManyRequestsExceptionget_members(**kwargs)¶Returns the membership details for specified member accounts for a behavior graph.
See also: AWS API Documentation
Request Syntax
response = client.get_members(
GraphArn='string',
AccountIds=[
'string',
]
)
[REQUIRED]
The ARN of the behavior graph for which to request the member details.
[REQUIRED]
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.
dict
Response Syntax
{
'MemberDetails': [
{
'AccountId': 'string',
'EmailAddress': 'string',
'GraphArn': 'string',
'MasterId': 'string',
'AdministratorId': 'string',
'Status': 'INVITED'|'VERIFICATION_IN_PROGRESS'|'VERIFICATION_FAILED'|'ENABLED'|'ACCEPTED_BUT_DISABLED',
'DisabledReason': 'VOLUME_TOO_HIGH'|'VOLUME_UNKNOWN',
'InvitedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'VolumeUsageInBytes': 123,
'VolumeUsageUpdatedTime': datetime(2015, 1, 1),
'PercentOfGraphUtilization': 123.0,
'PercentOfGraphUtilizationUpdatedTime': datetime(2015, 1, 1),
'InvitationType': 'INVITATION'|'ORGANIZATION',
'VolumeUsageByDatasourcePackage': {
'string': {
'VolumeUsageInBytes': 123,
'VolumeUsageUpdateTime': datetime(2015, 1, 1)
}
},
'DatasourcePackageIngestStates': {
'string': 'STARTED'|'STOPPED'|'DISABLED'
}
},
],
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Reason': 'string'
},
]
}
Response Structure
(dict) --
MemberDetails (list) --
The member account details that Detective is returning in response to the request.
(dict) --
Details about a member account in a behavior graph.
AccountId (string) --
The Amazon Web Services account identifier for the member account.
EmailAddress (string) --
The Amazon Web Services account root user email address for the member account.
GraphArn (string) --
The ARN of the behavior graph.
MasterId (string) --
The Amazon Web Services account identifier of the administrator account for the behavior graph.
AdministratorId (string) --
The Amazon Web Services account identifier of the administrator account for the behavior graph.
Status (string) --
The current membership status of the member account. The status can have one of the following values:
INVITED - For invited accounts only. Indicates that the member was sent an invitation but has not yet responded.VERIFICATION_IN_PROGRESS - For invited accounts only, indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph. For organization accounts in the organization behavior graph, indicates that Detective is verifying that the account belongs to the organization.VERIFICATION_FAILED - For invited accounts only. Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.ENABLED - Indicates that the member account currently contributes data to the behavior graph. For invited accounts, the member account accepted the invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member account.ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by the Detective administrator account, but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.Invited accounts that declined an invitation or that were removed from the behavior graph are not included. In the organization behavior graph, organization accounts that the Detective administrator account did not enable are not included.
DisabledReason (string) --
For member accounts with a status of ACCEPTED_BUT_DISABLED , the reason that the member account is not enabled.
The reason can have one of the following values:
VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.InvitedTime (datetime) --
For invited accounts, the date and time that Detective sent the invitation to the account. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
UpdatedTime (datetime) --
The date and time that the member account was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
VolumeUsageInBytes (integer) --
The data volume in bytes per day for the member account.
VolumeUsageUpdatedTime (datetime) --
The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
PercentOfGraphUtilization (float) --
The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.
Note that this is not the percentage of the behavior graph data volume.
For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.
PercentOfGraphUtilizationUpdatedTime (datetime) --
The date and time when the graph utilization percentage was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
InvitationType (string) --
The type of behavior graph membership.
For an organization account in the organization behavior graph, the type is ORGANIZATION .
For an account that was invited to a behavior graph, the type is INVITATION .
VolumeUsageByDatasourcePackage (dict) --
Details on the volume of usage for each data source package in a behavior graph.
(string) --
(dict) --
Information on the usage of a data source package in the behavior graph.
VolumeUsageInBytes (integer) --
Total volume of data in bytes per day ingested for a given data source package.
VolumeUsageUpdateTime (datetime) --
The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
DatasourcePackageIngestStates (dict) --
The state of a data source package for the behavior graph.
UnprocessedAccounts (list) --
The requested member accounts for which Detective was unable to return member details.
For each account, provides the reason why the request could not be processed.
(dict) --
A member account that was included in a request but for which the request could not be processed.
AccountId (string) --
The Amazon Web Services account identifier of the member account that was not processed.
Reason (string) --
The reason that the member account request could not be processed.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_datasource_packages(**kwargs)¶Lists data source packages in the behavior graph.
See also: AWS API Documentation
Request Syntax
response = client.list_datasource_packages(
GraphArn='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of the behavior graph.
dict
Response Syntax
{
'DatasourcePackages': {
'string': {
'DatasourcePackageIngestState': 'STARTED'|'STOPPED'|'DISABLED',
'LastIngestStateChange': {
'string': {
'Timestamp': datetime(2015, 1, 1)
}
}
}
},
'NextToken': 'string'
}
Response Structure
(dict) --
DatasourcePackages (dict) --
Details on the data source packages active in the behavior graph.
(string) --
(dict) --
Details about the data source packages ingested by your behavior graph.
DatasourcePackageIngestState (string) --
Details on which data source packages are ingested for a member account.
LastIngestStateChange (dict) --
The date a data source package was enabled for this account
(string) --
(dict) --
Details on when data collection began for a source package.
Timestamp (datetime) --
The data and time when data collection began for a source package. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
NextToken (string) --
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.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptionlist_graphs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_graphs(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'GraphList': [
{
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GraphList (list) --
A list of behavior graphs that the account is an administrator account for.
(dict) --
A behavior graph in Detective.
Arn (string) --
The ARN of the behavior graph.
CreatedTime (datetime) --
The date and time that the behavior graph was created. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
NextToken (string) --
If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionlist_invitations(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_invitations(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Invitations': [
{
'AccountId': 'string',
'EmailAddress': 'string',
'GraphArn': 'string',
'MasterId': 'string',
'AdministratorId': 'string',
'Status': 'INVITED'|'VERIFICATION_IN_PROGRESS'|'VERIFICATION_FAILED'|'ENABLED'|'ACCEPTED_BUT_DISABLED',
'DisabledReason': 'VOLUME_TOO_HIGH'|'VOLUME_UNKNOWN',
'InvitedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'VolumeUsageInBytes': 123,
'VolumeUsageUpdatedTime': datetime(2015, 1, 1),
'PercentOfGraphUtilization': 123.0,
'PercentOfGraphUtilizationUpdatedTime': datetime(2015, 1, 1),
'InvitationType': 'INVITATION'|'ORGANIZATION',
'VolumeUsageByDatasourcePackage': {
'string': {
'VolumeUsageInBytes': 123,
'VolumeUsageUpdateTime': datetime(2015, 1, 1)
}
},
'DatasourcePackageIngestStates': {
'string': 'STARTED'|'STOPPED'|'DISABLED'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Invitations (list) --
The list of behavior graphs for which the member account has open or accepted invitations.
(dict) --
Details about a member account in a behavior graph.
AccountId (string) --
The Amazon Web Services account identifier for the member account.
EmailAddress (string) --
The Amazon Web Services account root user email address for the member account.
GraphArn (string) --
The ARN of the behavior graph.
MasterId (string) --
The Amazon Web Services account identifier of the administrator account for the behavior graph.
AdministratorId (string) --
The Amazon Web Services account identifier of the administrator account for the behavior graph.
Status (string) --
The current membership status of the member account. The status can have one of the following values:
INVITED - For invited accounts only. Indicates that the member was sent an invitation but has not yet responded.VERIFICATION_IN_PROGRESS - For invited accounts only, indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph. For organization accounts in the organization behavior graph, indicates that Detective is verifying that the account belongs to the organization.VERIFICATION_FAILED - For invited accounts only. Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.ENABLED - Indicates that the member account currently contributes data to the behavior graph. For invited accounts, the member account accepted the invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member account.ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by the Detective administrator account, but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.Invited accounts that declined an invitation or that were removed from the behavior graph are not included. In the organization behavior graph, organization accounts that the Detective administrator account did not enable are not included.
DisabledReason (string) --
For member accounts with a status of ACCEPTED_BUT_DISABLED , the reason that the member account is not enabled.
The reason can have one of the following values:
VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.InvitedTime (datetime) --
For invited accounts, the date and time that Detective sent the invitation to the account. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
UpdatedTime (datetime) --
The date and time that the member account was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
VolumeUsageInBytes (integer) --
The data volume in bytes per day for the member account.
VolumeUsageUpdatedTime (datetime) --
The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
PercentOfGraphUtilization (float) --
The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.
Note that this is not the percentage of the behavior graph data volume.
For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.
PercentOfGraphUtilizationUpdatedTime (datetime) --
The date and time when the graph utilization percentage was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
InvitationType (string) --
The type of behavior graph membership.
For an organization account in the organization behavior graph, the type is ORGANIZATION .
For an account that was invited to a behavior graph, the type is INVITATION .
VolumeUsageByDatasourcePackage (dict) --
Details on the volume of usage for each data source package in a behavior graph.
(string) --
(dict) --
Information on the usage of a data source package in the behavior graph.
VolumeUsageInBytes (integer) --
Total volume of data in bytes per day ingested for a given data source package.
VolumeUsageUpdateTime (datetime) --
The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
DatasourcePackageIngestStates (dict) --
The state of a data source package for the behavior graph.
NextToken (string) --
If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionlist_members(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_members(
GraphArn='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of the behavior graph for which to retrieve the list of member accounts.
dict
Response Syntax
{
'MemberDetails': [
{
'AccountId': 'string',
'EmailAddress': 'string',
'GraphArn': 'string',
'MasterId': 'string',
'AdministratorId': 'string',
'Status': 'INVITED'|'VERIFICATION_IN_PROGRESS'|'VERIFICATION_FAILED'|'ENABLED'|'ACCEPTED_BUT_DISABLED',
'DisabledReason': 'VOLUME_TOO_HIGH'|'VOLUME_UNKNOWN',
'InvitedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'VolumeUsageInBytes': 123,
'VolumeUsageUpdatedTime': datetime(2015, 1, 1),
'PercentOfGraphUtilization': 123.0,
'PercentOfGraphUtilizationUpdatedTime': datetime(2015, 1, 1),
'InvitationType': 'INVITATION'|'ORGANIZATION',
'VolumeUsageByDatasourcePackage': {
'string': {
'VolumeUsageInBytes': 123,
'VolumeUsageUpdateTime': datetime(2015, 1, 1)
}
},
'DatasourcePackageIngestStates': {
'string': 'STARTED'|'STOPPED'|'DISABLED'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MemberDetails (list) --
The list of member accounts in the behavior graph.
For invited accounts, the results include member accounts that did not pass verification and member accounts that have not yet accepted the invitation to the behavior graph. 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.
(dict) --
Details about a member account in a behavior graph.
AccountId (string) --
The Amazon Web Services account identifier for the member account.
EmailAddress (string) --
The Amazon Web Services account root user email address for the member account.
GraphArn (string) --
The ARN of the behavior graph.
MasterId (string) --
The Amazon Web Services account identifier of the administrator account for the behavior graph.
AdministratorId (string) --
The Amazon Web Services account identifier of the administrator account for the behavior graph.
Status (string) --
The current membership status of the member account. The status can have one of the following values:
INVITED - For invited accounts only. Indicates that the member was sent an invitation but has not yet responded.VERIFICATION_IN_PROGRESS - For invited accounts only, indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph. For organization accounts in the organization behavior graph, indicates that Detective is verifying that the account belongs to the organization.VERIFICATION_FAILED - For invited accounts only. Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.ENABLED - Indicates that the member account currently contributes data to the behavior graph. For invited accounts, the member account accepted the invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member account.ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by the Detective administrator account, but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.Invited accounts that declined an invitation or that were removed from the behavior graph are not included. In the organization behavior graph, organization accounts that the Detective administrator account did not enable are not included.
DisabledReason (string) --
For member accounts with a status of ACCEPTED_BUT_DISABLED , the reason that the member account is not enabled.
The reason can have one of the following values:
VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.InvitedTime (datetime) --
For invited accounts, the date and time that Detective sent the invitation to the account. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
UpdatedTime (datetime) --
The date and time that the member account was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
VolumeUsageInBytes (integer) --
The data volume in bytes per day for the member account.
VolumeUsageUpdatedTime (datetime) --
The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
PercentOfGraphUtilization (float) --
The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.
Note that this is not the percentage of the behavior graph data volume.
For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.
PercentOfGraphUtilizationUpdatedTime (datetime) --
The date and time when the graph utilization percentage was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
InvitationType (string) --
The type of behavior graph membership.
For an organization account in the organization behavior graph, the type is ORGANIZATION .
For an account that was invited to a behavior graph, the type is INVITATION .
VolumeUsageByDatasourcePackage (dict) --
Details on the volume of usage for each data source package in a behavior graph.
(string) --
(dict) --
Information on the usage of a data source package in the behavior graph.
VolumeUsageInBytes (integer) --
Total volume of data in bytes per day ingested for a given data source package.
VolumeUsageUpdateTime (datetime) --
The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
DatasourcePackageIngestStates (dict) --
The state of a data source package for the behavior graph.
NextToken (string) --
If there are more member accounts remaining in the results, then use this pagination token to request the next page of member accounts.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptionlist_organization_admin_accounts(**kwargs)¶Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.
See also: AWS API Documentation
Request Syntax
response = client.list_organization_admin_accounts(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Administrators': [
{
'AccountId': 'string',
'GraphArn': 'string',
'DelegationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Administrators (list) --
The list of Detective administrator accounts.
(dict) --
Information about the Detective administrator account for an organization.
AccountId (string) --
The Amazon Web Services account identifier of the Detective administrator account for the organization.
GraphArn (string) --
The ARN of the organization behavior graph.
DelegationTime (datetime) --
The date and time when the Detective administrator account was enabled. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z .
NextToken (string) --
If there are more accounts remaining in the results, then this is the pagination token to use to request the next page of accounts.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionDetective.Client.exceptions.TooManyRequestsExceptionReturns the tag values that are assigned to a behavior graph.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The ARN of the behavior graph for which to retrieve the tag values.
{
'Tags': {
'string': 'string'
}
}
Response Structure
The tag values that are assigned to the behavior graph. The request returns up to 50 tag values.
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionDetective.Client.exceptions.ResourceNotFoundExceptionreject_invitation(**kwargs)¶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.
RejectInvitationcannot be called by an organization account in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation.
See also: AWS API Documentation
Request Syntax
response = client.reject_invitation(
GraphArn='string'
)
[REQUIRED]
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 .
Exceptions
Detective.Client.exceptions.ConflictExceptionDetective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ValidationExceptionstart_monitoring_member(**kwargs)¶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.
ENABLED .ACCEPTED_BUT_DISABLED .See also: AWS API Documentation
Request Syntax
response = client.start_monitoring_member(
GraphArn='string',
AccountId='string'
)
[REQUIRED]
The ARN of the behavior graph.
[REQUIRED]
The account ID of the member account to try to enable.
The account must be an invited member account with a status of ACCEPTED_BUT_DISABLED .
None
Exceptions
Detective.Client.exceptions.ConflictExceptionDetective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ServiceQuotaExceededExceptionDetective.Client.exceptions.ValidationExceptiontag_resource(**kwargs)¶Applies tag values to a behavior graph.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the behavior graph to assign the tags to.
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionDetective.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Removes tags from a behavior graph.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the behavior graph to remove the tags from.
[REQUIRED]
The tag keys of the tags to remove from the behavior graph. You can remove up to 50 tags at a time.
dict
Response Syntax
{}
Response Structure
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionDetective.Client.exceptions.ResourceNotFoundExceptionupdate_datasource_packages(**kwargs)¶Starts a data source packages for the behavior graph.
See also: AWS API Documentation
Request Syntax
response = client.update_datasource_packages(
GraphArn='string',
DatasourcePackages=[
'DETECTIVE_CORE'|'EKS_AUDIT',
]
)
[REQUIRED]
The ARN of the behavior graph.
[REQUIRED]
The data source package start for the behavior graph.
None
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ResourceNotFoundExceptionDetective.Client.exceptions.ServiceQuotaExceededExceptionDetective.Client.exceptions.ValidationExceptionupdate_organization_configuration(**kwargs)¶Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.
See also: AWS API Documentation
Request Syntax
response = client.update_organization_configuration(
GraphArn='string',
AutoEnable=True|False
)
[REQUIRED]
The ARN of the organization behavior graph.
None
Exceptions
Detective.Client.exceptions.InternalServerExceptionDetective.Client.exceptions.ValidationExceptionDetective.Client.exceptions.TooManyRequestsExceptionThe available paginators are: