Class: AWS.Detective

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  GraphArn: 'STRING_VALUE' /* required */
};
detective.batchGetGraphMemberDatasources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the behavior graph.

  • AccountIds — (Array<String>)

    The list of Amazon Web Services accounts to get data source package information on.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MemberDatasources — (Array<map>)

      Details on the status of 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 — (map<map<map>>)

        Details on when a data source package was added to a behavior graph.

        • Timestamp — (Date)

          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 — (Array<map>)

      Accounts that data source package information could not be retrieved for.

      • 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
detective.batchGetMembershipDatasources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArns — (Array<String>)

    The ARN of the behavior graph.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MembershipDatasources — (Array<map>)

      Details on the data source package history for an member 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 — (map<map<map>>)

        Details on when a data source package was added to a behavior graph.

        • Timestamp — (Date)

          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.

    • UnprocessedGraphs — (Array<map>)

      Graphs that data source package information could not be retrieved for.

      • GraphArn — (String)

        The ARN of the organization behavior graph.

      • Reason — (String)

        The reason data source package information could not be processed for a behavior graph.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
detective.createGraph(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Tags — (map<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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GraphArn — (String)

      The ARN of the new behavior graph.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Accounts: [ /* required */
    {
      AccountId: 'STRING_VALUE', /* required */
      EmailAddress: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  GraphArn: 'STRING_VALUE', /* required */
  DisableEmailNotification: true || false,
  Message: 'STRING_VALUE'
};
detective.createMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the behavior graph.

  • Message — (String)

    Customized message text to include in the invitation email message to the invited member accounts.

  • DisableEmailNotification — (Boolean)

    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.

  • Accounts — (Array<map>)

    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.

    • AccountId — required — (String)

      The account identifier of the Amazon Web Services account.

    • EmailAddress — required — (String)

      The Amazon Web Services account root user email address for the Amazon Web Services account.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Members — (Array<map>)

      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.

      • 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.

        Possible values include:
        • "INVITED"
        • "VERIFICATION_IN_PROGRESS"
        • "VERIFICATION_FAILED"
        • "ENABLED"
        • "ACCEPTED_BUT_DISABLED"
      • 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.

        Possible values include:
        • "VOLUME_TOO_HIGH"
        • "VOLUME_UNKNOWN"
      • InvitedTime — (Date)

        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 — (Date)

        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 — (Date)

        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 — (Date)

        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.

        Possible values include:
        • "INVITATION"
        • "ORGANIZATION"
      • VolumeUsageByDatasourcePackage — (map<map>)

        Details on the volume of usage for each data source package in a behavior graph.

        • VolumeUsageInBytes — (Integer)

          Total volume of data in bytes per day ingested for a given data source package.

        • VolumeUsageUpdateTime — (Date)

          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 — (map<String>)

        The state of a data source package for the behavior graph.

    • UnprocessedAccounts — (Array<map>)

      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.

      • 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE' /* required */
};
detective.deleteGraph(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the behavior graph to disable.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  GraphArn: 'STRING_VALUE' /* required */
};
detective.deleteMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the behavior graph to remove members from.

  • AccountIds — (Array<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountIds — (Array<String>)

      The list of Amazon Web Services account identifiers for the member accounts that Detective successfully removed from the behavior graph.

    • UnprocessedAccounts — (Array<map>)

      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.

      • 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE' /* required */
};
detective.describeOrganizationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the organization behavior graph.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AutoEnable — (Boolean)

      Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

detective.disableOrganizationAdminAccount(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE' /* required */
};
detective.disassociateMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
detective.enableOrganizationAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The Amazon Web Services account identifier of the account to designate as the Detective administrator account for the organization.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE', /* required */
  InvestigationId: 'STRING_VALUE' /* required */
};
detective.getInvestigation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The Amazon Resource Name (ARN) of the behavior graph.

  • InvestigationId — (String)

    The investigation ID of the investigation report.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GraphArn — (String)

      The Amazon Resource Name (ARN) of the behavior graph.

    • InvestigationId — (String)

      The investigation ID of the investigation report.

    • EntityArn — (String)

      The unique Amazon Resource Name (ARN). Detective supports IAM user ARNs and IAM role ARNs.

    • EntityType — (String)

      Type of entity. For example, Amazon Web Services accounts, such as an IAM user and/or IAM role.

      Possible values include:
      • "IAM_ROLE"
      • "IAM_USER"
    • CreatedTime — (Date)

      The creation time of the investigation report in UTC time stamp format.

    • ScopeStartTime — (Date)

      The start date and time used to set the scope time within which you want to generate the investigation report. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

    • ScopeEndTime — (Date)

      The data and time when the investigation began. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

    • Status — (String)

      The status based on the completion status of the investigation.

      Possible values include:
      • "RUNNING"
      • "FAILED"
      • "SUCCESSFUL"
    • Severity — (String)

      The severity assigned is based on the likelihood and impact of the indicators of compromise discovered in the investigation.

      Possible values include:
      • "INFORMATIONAL"
      • "LOW"
      • "MEDIUM"
      • "HIGH"
      • "CRITICAL"
    • State — (String)

      The current state of the investigation. An archived investigation indicates that you have completed reviewing the investigation.

      Possible values include:
      • "ACTIVE"
      • "ARCHIVED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  GraphArn: 'STRING_VALUE' /* required */
};
detective.getMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the behavior graph for which to request the member details.

  • AccountIds — (Array<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MemberDetails — (Array<map>)

      The member account details that Detective is returning in response to the request.

      • 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.

        Possible values include:
        • "INVITED"
        • "VERIFICATION_IN_PROGRESS"
        • "VERIFICATION_FAILED"
        • "ENABLED"
        • "ACCEPTED_BUT_DISABLED"
      • 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.

        Possible values include:
        • "VOLUME_TOO_HIGH"
        • "VOLUME_UNKNOWN"
      • InvitedTime — (Date)

        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 — (Date)

        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 — (Date)

        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 — (Date)

        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.

        Possible values include:
        • "INVITATION"
        • "ORGANIZATION"
      • VolumeUsageByDatasourcePackage — (map<map>)

        Details on the volume of usage for each data source package in a behavior graph.

        • VolumeUsageInBytes — (Integer)

          Total volume of data in bytes per day ingested for a given data source package.

        • VolumeUsageUpdateTime — (Date)

          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 — (map<String>)

        The state of a data source package for the behavior graph.

    • UnprocessedAccounts — (Array<map>)

      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.

      • 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
detective.listDatasourcePackages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the behavior graph.

  • 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.

  • MaxResults — (Integer)

    The maximum number of results to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DatasourcePackages — (map<map>)

      Details on the data source packages active in the behavior graph.

      • DatasourcePackageIngestState — (String)

        Details on which data source packages are ingested for a member account.

        Possible values include:
        • "STARTED"
        • "STOPPED"
        • "DISABLED"
      • LastIngestStateChange — (map<map>)

        The date a data source package was enabled for this account

        • Timestamp — (Date)

          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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
detective.listGraphs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

  • MaxResults — (Integer)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GraphList — (Array<map>)

      A list of behavior graphs that the account is an administrator account for.

      • Arn — (String)

        The ARN of the behavior graph.

      • CreatedTime — (Date)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE', /* required */
  InvestigationId: 'STRING_VALUE', /* required */
  IndicatorType: TTP_OBSERVED | IMPOSSIBLE_TRAVEL | FLAGGED_IP_ADDRESS | NEW_GEOLOCATION | NEW_ASO | NEW_USER_AGENT | RELATED_FINDING | RELATED_FINDING_GROUP,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
detective.listIndicators(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The Amazon Resource Name (ARN) of the behavior graph.

  • InvestigationId — (String)

    The investigation ID of the investigation report.

  • IndicatorType — (String)

    For the list of indicators of compromise that are generated by Detective investigations, see Detective investigations.

    Possible values include:
    • "TTP_OBSERVED"
    • "IMPOSSIBLE_TRAVEL"
    • "FLAGGED_IP_ADDRESS"
    • "NEW_GEOLOCATION"
    • "NEW_ASO"
    • "NEW_USER_AGENT"
    • "RELATED_FINDING"
    • "RELATED_FINDING_GROUP"
  • NextToken — (String)

    Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

    Each pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.

  • MaxResults — (Integer)

    Lists the maximum number of indicators in a page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GraphArn — (String)

      The Amazon Resource Name (ARN) of the behavior graph.

    • InvestigationId — (String)

      The investigation ID of the investigation report.

    • NextToken — (String)

      Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

      Each pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.

    • Indicators — (Array<map>)

      Lists the indicators of compromise.

      • IndicatorType — (String)

        The type of indicator.

        Possible values include:
        • "TTP_OBSERVED"
        • "IMPOSSIBLE_TRAVEL"
        • "FLAGGED_IP_ADDRESS"
        • "NEW_GEOLOCATION"
        • "NEW_ASO"
        • "NEW_USER_AGENT"
        • "RELATED_FINDING"
        • "RELATED_FINDING_GROUP"
      • IndicatorDetail — (map)

        Details about the indicators of compromise that are used to determine if a resource is involved in a security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident.

        • TTPsObservedDetail — (map)

          Details about the indicator of compromise.

          • Tactic — (String)

            The tactic used, identified by the investigation.

          • Technique — (String)

            The technique used, identified by the investigation.

          • Procedure — (String)

            The procedure used, identified by the investigation.

          • IpAddress — (String)

            The IP address where the tactics, techniques, and procedure (TTP) was observed.

          • APIName — (String)

            The name of the API where the tactics, techniques, and procedure (TTP) was observed.

          • APISuccessCount — (Integer)

            The total number of successful API requests.

          • APIFailureCount — (Integer)

            The total number of failed API requests.

        • ImpossibleTravelDetail — (map)

          Identifies unusual and impossible user activity for an account.

          • StartingIpAddress — (String)

            IP address where the resource was first used in the impossible travel.

          • EndingIpAddress — (String)

            IP address where the resource was last used in the impossible travel.

          • StartingLocation — (String)

            Location where the resource was first used in the impossible travel.

          • EndingLocation — (String)

            Location where the resource was last used in the impossible travel.

          • HourlyTimeDelta — (Integer)

            Returns the time difference between the first and last timestamp the resource was used.

        • FlaggedIpAddressDetail — (map)

          Suspicious IP addresses that are flagged, which indicates critical or severe threats based on threat intelligence by Detective. This indicator is derived from Amazon Web Services threat intelligence.

          • IpAddress — (String)

            IP address of the suspicious entity.

          • Reason — (String)

            Details the reason the IP address was flagged as suspicious.

            Possible values include:
            • "AWS_THREAT_INTELLIGENCE"
        • NewGeolocationDetail — (map)

          Contains details about the new geographic location.

          • Location — (String)

            Location where the resource was accessed.

          • IpAddress — (String)

            IP address using which the resource was accessed.

          • IsNewForEntireAccount — (Boolean)

            Checks if the geolocation is new for the entire account.

        • NewAsoDetail — (map)

          Contains details about the new Autonomous System Organization (ASO).

          • Aso — (String)

            Details about the new Autonomous System Organization (ASO).

          • IsNewForEntireAccount — (Boolean)

            Checks if the Autonomous System Organization (ASO) is new for the entire account.

        • NewUserAgentDetail — (map)

          Contains details about the new user agent.

          • UserAgent — (String)

            New user agent which accessed the resource.

          • IsNewForEntireAccount — (Boolean)

            Checks if the user agent is new for the entire account.

        • RelatedFindingDetail — (map)

          Contains details about related findings.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the related finding.

          • Type — (String)

            The type of finding.

          • IpAddress — (String)

            The IP address of the finding.

        • RelatedFindingGroupDetail — (map)

          Contains details about related finding groups.

          • Id — (String)

            The unique identifier for the finding group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE', /* required */
  FilterCriteria: {
    CreatedTime: {
      EndInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      StartInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
    },
    EntityArn: {
      Value: 'STRING_VALUE' /* required */
    },
    Severity: {
      Value: 'STRING_VALUE' /* required */
    },
    State: {
      Value: 'STRING_VALUE' /* required */
    },
    Status: {
      Value: 'STRING_VALUE' /* required */
    }
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: {
    Field: SEVERITY | STATUS | CREATED_TIME,
    SortOrder: ASC | DESC
  }
};
detective.listInvestigations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The Amazon Resource Name (ARN) of the behavior graph.

  • NextToken — (String)

    Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

    Each pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.

  • MaxResults — (Integer)

    Lists the maximum number of investigations in a page.

  • FilterCriteria — (map)

    Filters the investigation results based on a criteria.

    • Severity — (map)

      Filter the investigation results based on the severity.

      • Value — required — (String)

        The string filter value.

    • Status — (map)

      Filter the investigation results based on the status.

      • Value — required — (String)

        The string filter value.

    • State — (map)

      Filter the investigation results based on the state.

      • Value — required — (String)

        The string filter value.

    • EntityArn — (map)

      Filter the investigation results based on the Amazon Resource Name (ARN) of the entity.

      • Value — required — (String)

        The string filter value.

    • CreatedTime — (map)

      Filter the investigation results based on when the investigation was created.

      • StartInclusive — required — (Date)

        A timestamp representing the start of the time period from when data is filtered, including the start date.

      • EndInclusive — required — (Date)

        A timestamp representing the end date of the time period until when data is filtered, including the end date.

  • SortCriteria — (map)

    Sorts the investigation results based on a criteria.

    • Field — (String)

      Represents the Field attribute to sort investigations.

      Possible values include:
      • "SEVERITY"
      • "STATUS"
      • "CREATED_TIME"
    • SortOrder — (String)

      The order by which the sorted findings are displayed.

      Possible values include:
      • "ASC"
      • "DESC"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InvestigationDetails — (Array<map>)

      Lists the summary of uncommon behavior or malicious activity which indicates a compromise.

      • InvestigationId — (String)

        The investigation ID of the investigation report.

      • Severity — (String)

        Severity based on the likelihood and impact of the indicators of compromise discovered in the investigation.

        Possible values include:
        • "INFORMATIONAL"
        • "LOW"
        • "MEDIUM"
        • "HIGH"
        • "CRITICAL"
      • Status — (String)

        Status based on the completion status of the investigation.

        Possible values include:
        • "RUNNING"
        • "FAILED"
        • "SUCCESSFUL"
      • State — (String)

        The current state of the investigation. An archived investigation indicates you have completed reviewing the investigation.

        Possible values include:
        • "ACTIVE"
        • "ARCHIVED"
      • CreatedTime — (Date)

        The time stamp of the creation time of the investigation report. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

      • EntityArn — (String)

        The unique Amazon Resource Name (ARN) of the IAM user and IAM role.

      • EntityType — (String)

        Type of entity. For example, Amazon Web Services accounts, such as IAM user and role.

        Possible values include:
        • "IAM_ROLE"
        • "IAM_USER"
    • NextToken — (String)

      Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

      Each pagination token expires after 24 hours.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
detective.listInvitations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (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.

  • MaxResults — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Invitations — (Array<map>)

      The list of behavior graphs for which the member account has open or accepted invitations.

      • 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.

        Possible values include:
        • "INVITED"
        • "VERIFICATION_IN_PROGRESS"
        • "VERIFICATION_FAILED"
        • "ENABLED"
        • "ACCEPTED_BUT_DISABLED"
      • 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.

        Possible values include:
        • "VOLUME_TOO_HIGH"
        • "VOLUME_UNKNOWN"
      • InvitedTime — (Date)

        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 — (Date)

        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 — (Date)

        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 — (Date)

        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.

        Possible values include:
        • "INVITATION"
        • "ORGANIZATION"
      • VolumeUsageByDatasourcePackage — (map<map>)

        Details on the volume of usage for each data source package in a behavior graph.

        • VolumeUsageInBytes — (Integer)

          Total volume of data in bytes per day ingested for a given data source package.

        • VolumeUsageUpdateTime — (Date)

          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 — (map<String>)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
detective.listMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the behavior graph for which to retrieve the list of member accounts.

  • NextToken — (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.

  • MaxResults — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MemberDetails — (Array<map>)

      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.

      • 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.

        Possible values include:
        • "INVITED"
        • "VERIFICATION_IN_PROGRESS"
        • "VERIFICATION_FAILED"
        • "ENABLED"
        • "ACCEPTED_BUT_DISABLED"
      • 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.

        Possible values include:
        • "VOLUME_TOO_HIGH"
        • "VOLUME_UNKNOWN"
      • InvitedTime — (Date)

        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 — (Date)

        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 — (Date)

        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 — (Date)

        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.

        Possible values include:
        • "INVITATION"
        • "ORGANIZATION"
      • VolumeUsageByDatasourcePackage — (map<map>)

        Details on the volume of usage for each data source package in a behavior graph.

        • VolumeUsageInBytes — (Integer)

          Total volume of data in bytes per day ingested for a given data source package.

        • VolumeUsageUpdateTime — (Date)

          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 — (map<String>)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
detective.listOrganizationAdminAccounts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

  • MaxResults — (Integer)

    The maximum number of results to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Administrators — (Array<map>)

      The list of Detective administrator accounts.

      • 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 — (Date)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
detective.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The ARN of the behavior graph for which to retrieve the tag values.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (map<String>)

      The tag values that are assigned to the behavior graph. The request returns up to 50 tag values.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE' /* required */
};
detective.rejectInvitation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EntityArn: 'STRING_VALUE', /* required */
  GraphArn: 'STRING_VALUE', /* required */
  ScopeEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  ScopeStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
};
detective.startInvestigation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The Amazon Resource Name (ARN) of the behavior graph.

  • EntityArn — (String)

    The unique Amazon Resource Name (ARN) of the IAM user and IAM role.

  • ScopeStartTime — (Date)

    The data and time when the investigation began. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

  • ScopeEndTime — (Date)

    The data and time when the investigation ended. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InvestigationId — (String)

      The investigation ID of the investigation report.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  GraphArn: 'STRING_VALUE' /* required */
};
detective.startMonitoringMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the behavior graph.

  • AccountId — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
detective.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The ARN of the behavior graph to assign the tags to.

  • Tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
detective.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The ARN of the behavior graph to remove the tags from.

  • TagKeys — (Array<String>)

    The tag keys of the tags to remove from the behavior graph. You can remove up to 50 tags at a time.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DatasourcePackages: [ /* required */
    DETECTIVE_CORE | EKS_AUDIT | ASFF_SECURITYHUB_FINDING,
    /* more items */
  ],
  GraphArn: 'STRING_VALUE' /* required */
};
detective.updateDatasourcePackages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the behavior graph.

  • DatasourcePackages — (Array<String>)

    The data source package start for the behavior graph.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE', /* required */
  InvestigationId: 'STRING_VALUE', /* required */
  State: ACTIVE | ARCHIVED /* required */
};
detective.updateInvestigationState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The Amazon Resource Name (ARN) of the behavior graph.

  • InvestigationId — (String)

    The investigation ID of the investigation report.

  • State — (String)

    The current state of the investigation. An archived investigation indicates you have completed reviewing the investigation.

    Possible values include:
    • "ACTIVE"
    • "ARCHIVED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GraphArn: 'STRING_VALUE', /* required */
  AutoEnable: true || false
};
detective.updateOrganizationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GraphArn — (String)

    The ARN of the organization behavior graph.

  • AutoEnable — (Boolean)

    Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.