2021/02/25 - Amazon Detective - 4 updated api methods
Changes Changed "master account" to "administrator account." A new AdministratorId field replaces the deprecated MasterId field. Added an option to disable email notifications for member account invitations.
{'DisableEmailNotification': 'boolean'}
Response {'Members': {'AdministratorId': 'string'}}
Sends a request to invite the specified AWS 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.
The request provides the behavior graph ARN and the list of accounts to invite.
The response separates the requested accounts into two lists:
The accounts that CreateMembers was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification.
The accounts that 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
client.create_members(
GraphArn='string',
Message='string',
DisableEmailNotification=True|False,
Accounts=[
{
'AccountId': 'string',
'EmailAddress': 'string'
},
]
)
string
[REQUIRED]
The ARN of the behavior graph to invite the member accounts to contribute their data to.
string
Customized message text to include in the invitation email message to the invited member accounts.
boolean
if set to true , then the member accounts do not receive email notifications. By default, this is set to false , and the member accounts receive email notifications.
list
[REQUIRED]
The list of AWS accounts to invite to become member accounts in the behavior graph. For each invited account, the account list contains the account identifier and the AWS account root user email address.
(dict) --
An AWS account that is the administrator account of or a member of a behavior graph.
AccountId (string) -- [REQUIRED]
The account identifier of the AWS account.
EmailAddress (string) -- [REQUIRED]
The AWS account root user email address for the AWS 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),
'PercentOfGraphUtilization': 123.0,
'PercentOfGraphUtilizationUpdatedTime': datetime(2015, 1, 1)
},
],
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Reason': 'string'
},
]
}
Response Structure
(dict) --
Members (list) --
The set of member account invitation 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.
(dict) --
Details about a member account that was invited to contribute to a behavior graph.
AccountId (string) --
The AWS account identifier for the member account.
EmailAddress (string) --
The AWS account root user email address for the member account.
GraphArn (string) --
The ARN of the behavior graph that the member account was invited to.
MasterId (string) --
Deprecated. Instead of MasterId , use AdministratorId .
The AWS account identifier of the administrator account for the behavior graph.
AdministratorId (string) --
The AWS 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 - Indicates that the member was sent an invitation but has not yet responded.
VERIFICATION_IN_PROGRESS - 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.
VERIFICATION_FAILED - 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 accepted the invitation to contribute to the behavior graph.
ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.
Member accounts that declined an invitation or that were removed from the behavior graph 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) --
The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.
UpdatedTime (datetime) --
The date and time that the member account was last updated. The value is in milliseconds since the epoch.
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.
UnprocessedAccounts (list) --
The list of accounts for which Detective was unable to process the invitation 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 AWS account identifier of the member account that was not processed.
Reason (string) --
The reason that the member account request could not be processed.
{'MemberDetails': {'AdministratorId': 'string'}}
Returns the membership details for specified member accounts for a behavior graph.
See also: AWS API Documentation
Request Syntax
client.get_members(
GraphArn='string',
AccountIds=[
'string',
]
)
string
[REQUIRED]
The ARN of the behavior graph for which to request the member details.
list
[REQUIRED]
The list of AWS account identifiers for the member account for which to return member details.
You cannot use GetMembers to retrieve information about member accounts that were removed from the behavior graph.
(string) --
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),
'PercentOfGraphUtilization': 123.0,
'PercentOfGraphUtilizationUpdatedTime': datetime(2015, 1, 1)
},
],
'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 that was invited to contribute to a behavior graph.
AccountId (string) --
The AWS account identifier for the member account.
EmailAddress (string) --
The AWS account root user email address for the member account.
GraphArn (string) --
The ARN of the behavior graph that the member account was invited to.
MasterId (string) --
Deprecated. Instead of MasterId , use AdministratorId .
The AWS account identifier of the administrator account for the behavior graph.
AdministratorId (string) --
The AWS 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 - Indicates that the member was sent an invitation but has not yet responded.
VERIFICATION_IN_PROGRESS - 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.
VERIFICATION_FAILED - 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 accepted the invitation to contribute to the behavior graph.
ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.
Member accounts that declined an invitation or that were removed from the behavior graph 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) --
The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.
UpdatedTime (datetime) --
The date and time that the member account was last updated. The value is in milliseconds since the epoch.
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.
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 AWS account identifier of the member account that was not processed.
Reason (string) --
The reason that the member account request could not be processed.
{'Invitations': {'AdministratorId': 'string'}}
Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a 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
client.list_invitations(
NextToken='string',
MaxResults=123
)
string
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.
integer
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.
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),
'PercentOfGraphUtilization': 123.0,
'PercentOfGraphUtilizationUpdatedTime': datetime(2015, 1, 1)
},
],
'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 that was invited to contribute to a behavior graph.
AccountId (string) --
The AWS account identifier for the member account.
EmailAddress (string) --
The AWS account root user email address for the member account.
GraphArn (string) --
The ARN of the behavior graph that the member account was invited to.
MasterId (string) --
Deprecated. Instead of MasterId , use AdministratorId .
The AWS account identifier of the administrator account for the behavior graph.
AdministratorId (string) --
The AWS 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 - Indicates that the member was sent an invitation but has not yet responded.
VERIFICATION_IN_PROGRESS - 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.
VERIFICATION_FAILED - 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 accepted the invitation to contribute to the behavior graph.
ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.
Member accounts that declined an invitation or that were removed from the behavior graph 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) --
The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.
UpdatedTime (datetime) --
The date and time that the member account was last updated. The value is in milliseconds since the epoch.
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.
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.
{'MemberDetails': {'AdministratorId': 'string'}}
Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
See also: AWS API Documentation
Request Syntax
client.list_members(
GraphArn='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ARN of the behavior graph for which to retrieve the list of member accounts.
string
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.
integer
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.
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),
'PercentOfGraphUtilization': 123.0,
'PercentOfGraphUtilizationUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MemberDetails (list) --
The list of member accounts in the behavior graph.
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.
(dict) --
Details about a member account that was invited to contribute to a behavior graph.
AccountId (string) --
The AWS account identifier for the member account.
EmailAddress (string) --
The AWS account root user email address for the member account.
GraphArn (string) --
The ARN of the behavior graph that the member account was invited to.
MasterId (string) --
Deprecated. Instead of MasterId , use AdministratorId .
The AWS account identifier of the administrator account for the behavior graph.
AdministratorId (string) --
The AWS 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 - Indicates that the member was sent an invitation but has not yet responded.
VERIFICATION_IN_PROGRESS - 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.
VERIFICATION_FAILED - 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 accepted the invitation to contribute to the behavior graph.
ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.
Member accounts that declined an invitation or that were removed from the behavior graph 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) --
The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.
UpdatedTime (datetime) --
The date and time that the member account was last updated. The value is in milliseconds since the epoch.
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.
NextToken (string) --
If there are more member accounts remaining in the results, then this is the pagination token to use to request the next page of member accounts.